Skip to content

Commit bc4eb76

Browse files
fixing typos and few wrong names (related to SPECITS-33)
1 parent df59c1e commit bc4eb76

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

docs/simplified_data_template.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ <h3 id="_conceptual_approach"><a class="anchor" href="#_conceptual_approach"></a
290290
<p>The model is accordingly rigorous. However, for some developers who only need to instantiate, commit and/or read relatively limited data-sets, the canonical format can be demanding. This is particularly so for situations in which only a few kinds of data are implicated, i.e. a relatively small number of templates, e.g. vitals signs data, lab results etc.</p>
291291
</div>
292292
<div class="paragraph">
293-
<p>The starting point for defining a developer-friendly commit format is therefore to assume that the great majority of applications are typically targetted to one or a few specific data sets, e.g. vital signs, diabetic monitoring, pregnancy plan etc.</p>
293+
<p>The starting point for defining a developer-friendly commit format is therefore to assume that the great majority of applications are typically targeted to one or a few specific data sets, e.g. vital signs, diabetic monitoring, pregnancy plan etc.</p>
294294
</div>
295295
<div class="paragraph">
296296
<p>Template-specificity provides a route for defining and generating a serial format such that <em>each openEHR template</em> can be used to define one or more reasonably simple commit formats. Two such formats are discussed here:</p>
@@ -336,7 +336,7 @@ <h3 id="_conceptual_approach"><a class="anchor" href="#_conceptual_approach"></a
336336
</div>
337337
</div>
338338
<div class="paragraph">
339-
<p>The latter (simSDT) is based on a more radical simplification of the openEHR RM and BASE models, as well as a more programmer-friendly (atural language based) rendering of paths. Under this approach, a lab result data structure could be represented using non-canonical, attribute or tag names such as 'serum_sodium', 'serum_potassium', etc (in English or in any other natural language, including script-based languages), instead of each node appearing under the canonical <code>CLUSTER.<em>items</em></code> attribute and codes like <code>at0001</code>. An example is shown below.</p>
339+
<p>The latter (simSDT) is based on a more radical simplification of the openEHR RM and BASE models, as well as a more programmer-friendly (natural language based) rendering of paths. Under this approach, a lab result data structure could be represented using non-canonical, attribute or tag names such as 'serum_sodium', 'serum_potassium', etc (in English or in any other natural language, including script-based languages), instead of each node appearing under the canonical <code>CLUSTER.<em>items</em></code> attribute and codes like <code>at0001</code>. An example is shown below.</p>
340340
</div>
341341
<div class="listingblock">
342342
<div class="content">
@@ -371,7 +371,7 @@ <h3 id="_conceptual_approach"><a class="anchor" href="#_conceptual_approach"></a
371371
</div>
372372
</div>
373373
<div class="paragraph">
374-
<p><strong>A developer just using the simSDT or ncSDT as illustrated above in a specific example-based use case does not necessarily need to understand the detailed steps of conversions described below.</strong> Platforms based on openEHR can have services that generate example instances based on openeEHR templates to make work easier for such developers. The detailed descriptions below are primarily intended for developers creating and maintaining underlying openEHR platforms or dealing with complex use cases.</p>
374+
<p><strong>A developer just using the simSDT or ncSDT as illustrated above in a specific example-based use case does not necessarily need to understand the detailed steps of conversions described below.</strong> Platforms based on openEHR can have services that generate example instances based on openEHR templates to make work easier for such developers. The detailed descriptions below are primarily intended for developers creating and maintaining underlying openEHR platforms or dealing with complex use cases.</p>
375375
</div>
376376
<div class="paragraph">
377377
<p>To make any form of 'simplified format' work, the following requirements must be met:</p>
@@ -439,7 +439,7 @@ <h3 id="_conceptual_approach"><a class="anchor" href="#_conceptual_approach"></a
439439
<h2 id="_sopt_generation"><a class="anchor" href="#_sopt_generation"></a>3. sOPT Generation</h2>
440440
<div class="sectionbody">
441441
<div class="paragraph">
442-
<p>This section describes how a Simlified OPT may be machine-derived from its corresponding canonical OPT definition and the Simplified Reference Model (SIM).</p>
442+
<p>This section describes how a Simplified OPT may be machine-derived from its corresponding canonical OPT definition and the Simplified Reference Model (SIM).</p>
443443
</div>
444444
<div class="sect2">
445445
<h3 id="_visitor_algorithm"><a class="anchor" href="#_visitor_algorithm"></a>3.1. Visitor algorithm</h3>

docs/simplified_data_template/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ A significant part of the design ideas and content of this specification was ada
6060

6161
* the Marand 'Web Templates' specification, kindly provided by Better by Marand d.o.o. (Slovenia);
6262
* the EtherCIS ECISFLAT format by the EtherCIS community, see https://github.com/ethercis/ethercis/blob/master/doc/flat%20json.md;
63-
* the XSD-based Template Data Schema (TDS) format developed by Ocean Informatics.
63+
* the XSD-based Template Data Schema (TDS) format developed by Ocean Health Systems.
6464

6565
=== Trademarks
6666

docs/simplified_data_template/master00-amendment_record.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
|[[latest_issue]]0.7.0
1010
|{spec_tickets}/SPECITS-33[SPECITS-33^]. Add Simplified Data Template format specification; +
11-
Initial writing, adapted from the Marand Better Platform 'Web Templates' specification, EtherCIS documentation and the Ocean Informatics Template Data Schema.
11+
Initial writing, adapted from the Marand Better Platform 'Web Templates' specification, EtherCIS documentation and the Ocean Health Systems Template Data Schema.
1212
|openEHR SEC
1313
|[[latest_issue_date]]17 Jul 2019
1414

docs/simplified_data_template/master02-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ The default serialised data representations for openEHR content are canonical XM
99
* all attributes are named as per the RM, and
1010
* all cardinalities respect the RM.
1111

12-
The canonical formats are routinely used by all openEHR implementations implementing the {openehr_ehr_rest_api}[openEHR REST API specification^], and in other ways, e.g. for DB dump/load implementation, ETL and so on. However, creating data instances according to these formats is not always straightforward, particularly for developers with minimal exposure to openEHR, and various alternatives have been used in the past to simplify the job of content creation and committal for application developers. These include TDS/TDD (XSD-based Template Data Schema & Document); and so-called EtherCIS flat JSON and Marand Flat JSON.
12+
The canonical formats are routinely used by all openEHR implementations implementing the {openehr_ehr_rest_api}[openEHR REST API specification^], and in other ways, e.g. for DB dump/load implementation, ETL and so on. However, creating data instances according to these formats is not always straightforward, particularly for developers with minimal exposure to openEHR, and various alternatives have been used in the past to simplify the job of content creation and committal for application developers. These include TDS/TDD (XSD-based Template Data Schema & Document), and so-called EtherCIS flat JSON and Marand Flat JSON.
1313

1414
This specification responds to the requirement for a complete representation of all of these serial formats within a common formal framework that will permit further variants in the future as and when needed.

docs/simplified_data_template/master03-conceptual.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ The openEHR reference model (RM) and supporting models (BASE component) are desi
1111

1212
The model is accordingly rigorous. However, for some developers who only need to instantiate, commit and/or read relatively limited data-sets, the canonical format can be demanding. This is particularly so for situations in which only a few kinds of data are implicated, i.e. a relatively small number of templates, e.g. vitals signs data, lab results etc.
1313

14-
The starting point for defining a developer-friendly commit format is therefore to assume that the great majority of applications are typically targetted to one or a few specific data sets, e.g. vital signs, diabetic monitoring, pregnancy plan etc.
14+
The starting point for defining a developer-friendly commit format is therefore to assume that the great majority of applications are typically targeted to one or a few specific data sets, e.g. vital signs, diabetic monitoring, pregnancy plan etc.
1515

1616
== Historical Formats
1717

1818
Template-specificity provides a route to simplification such that _each openEHR template_ can be used to define one or more reasonably simple commit formats. Three such formats in historical use are:
1919

20-
* _TDS, or Template Data Schema_, an XSD format originally devised by Ocean Informatics;
20+
* _TDS, or Template Data Schema_, an XSD format originally devised by Ocean Health Systems;
2121
* _near-canonical RM Simplified Data Template (ncSDT)_, originally devised for the EtherCIS project, see https://github.com/ethercis/ethercis/blob/master/doc/flat%20json.md
2222
* _simplified IM Simplified Data template (simSDT)_, based on the 'web template' format originally created by Marand for the Better platform, see https://www.ehrscape.com/examples.html
2323

@@ -96,7 +96,7 @@ The first of the two JSON formats (ncSDT) is an extract from an Operational Temp
9696
}
9797
--------
9898

99-
The latter (simSDT) is based on a more radical simplification of the openEHR RM and BASE models, as well as a more programmer-friendly (atural language based) rendering of paths. Under this approach, a lab result data structure could be represented using non-canonical, attribute or tag names such as 'serum_sodium', 'serum_potassium', etc (in English or in any other natural language, including script-based languages), instead of each node appearing under the canonical `CLUSTER._items_` attribute and codes like `at0001`. An example is shown below.
99+
The latter (simSDT) is based on a more radical simplification of the openEHR RM and BASE models, as well as a more programmer-friendly (natural language based) rendering of paths. Under this approach, a lab result data structure could be represented using non-canonical, attribute or tag names such as 'serum_sodium', 'serum_potassium', etc (in English or in any other natural language, including script-based languages), instead of each node appearing under the canonical `CLUSTER._items_` attribute and codes like `at0001`. An example is shown below.
100100

101101
[source, json]
102102
--------
@@ -130,7 +130,7 @@ The latter (simSDT) is based on a more radical simplification of the openEHR RM
130130
}
131131
--------
132132

133-
*A developer just using the simSDT or ncSDT as illustrated above in a specific example-based use case does not need to understand the detailed steps of conversions described below.* Platforms based on openEHR can have services that generate example instances based on openeEHR templates to make work easier for such developers. The detailed descriptions below are primarily intended for developers creating and maintaining underlying openEHR platforms or dealing with complex use cases.
133+
*A developer just using the simSDT or ncSDT as illustrated above in a specific example-based use case does not need to understand the detailed steps of conversions described below.* Platforms based on openEHR can have services that generate example instances based on openEHR templates to make work easier for such developers. The detailed descriptions below are primarily intended for developers creating and maintaining underlying openEHR platforms or dealing with complex use cases.
134134

135135
To make any form of 'simplified format' work, the following requirements must be met:
136136

docs/simplified_data_template/master04-sopt_generation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= sOPT Generation
22

3-
This section describes how a Simlified OPT may be machine-derived from its corresponding canonical OPT definition and the Simplified Reference Model (SIM).
3+
This section describes how a Simplified OPT may be machine-derived from its corresponding canonical OPT definition and the Simplified Reference Model (SIM).
44

55

66
== Visitor algorithm

0 commit comments

Comments
 (0)