Skip to content

Commit 244baee

Browse files
render all docs as Release-2.3.0
1 parent c87e916 commit 244baee

File tree

8 files changed

+6120
-6104
lines changed

8 files changed

+6120
-6104
lines changed

docs/ADL1.4.html

Lines changed: 2291 additions & 2292 deletions
Large diffs are not rendered by default.

docs/ADL2.html

Lines changed: 3012 additions & 3012 deletions
Large diffs are not rendered by default.

docs/AOM1.4.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="generator" content="Asciidoctor 2.0.17">
7+
<meta name="generator" content="Asciidoctor 2.0.21">
88
<meta name="description" content="openEHR Archetype Object Model 1.4 (AOM1.4)">
99
<meta name="keywords" content="EHR, ADL, AOM, health records, archetypes, constraint language, ISO 13606, openehr">
1010
<title>Archetype Object Model 1.4 (AOM1.4)</title>
@@ -216,7 +216,7 @@ <h1 id="_archetype_object_model_1_4_aom1_4" class="sect0"><a class="anchor" href
216216
</thead>
217217
<tbody>
218218
<tr>
219-
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Release</strong>: AM latest</p></td>
219+
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Release</strong>: AM Release-2.3.0</p></td>
220220
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Status</strong>: STABLE</p></td>
221221
</tr>
222222
<tr>
@@ -240,7 +240,7 @@ <h1 id="_archetype_object_model_1_4_aom1_4" class="sect0"><a class="anchor" href
240240
</colgroup>
241241
<thead>
242242
<tr>
243-
<th class="tableblock halign-center valign-top" colspan="2">&#169; 2004 - 2023 The openEHR Foundation</th>
243+
<th class="tableblock halign-center valign-top" colspan="2">&#169; 2004 - 2024 The openEHR Foundation</th>
244244
</tr>
245245
</thead>
246246
<tbody>
@@ -280,7 +280,7 @@ <h2 id="_amendment_record"><a class="anchor" href="#_amendment_record"></a>Amend
280280
</thead>
281281
<tbody>
282282
<tr>
283-
<th class="tableblock halign-center valign-top" colspan="4"><p class="tableblock"><strong>AM Release 2.3.?</strong></p></th>
283+
<th class="tableblock halign-center valign-top" colspan="4"><p class="tableblock"><strong>AM Release 2.3.0</strong></p></th>
284284
</tr>
285285
<tr>
286286
<td class="tableblock halign-left valign-top"><p class="tableblock"><a id="latest_issue"></a>1.4.6</p></td>
@@ -591,10 +591,10 @@ <h2 id="_preface"><a class="anchor" href="#_preface"></a>1. Preface</h2>
591591
<div class="sect2">
592592
<h3 id="_purpose"><a class="anchor" href="#_purpose"></a>1.1. Purpose</h3>
593593
<div class="paragraph">
594-
<p>This document contains the definitive statement of archetype semantics, in the form of an object model for archetypes. The model presented here can be used as a basis for building software that processes archetypes, independent of their persistent representation; equally, it can be used to develop the output side of parsers that process archetypes in a linguistic format, such as the <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html" target="_blank" rel="noopener">openEHR Archetype Definition Language (ADL)</a>, XML-instance and so on. As a specification, it can be treated as an API for archetypes.</p>
594+
<p>This document contains the definitive statement of archetype semantics, in the form of an object model for archetypes. The model presented here can be used as a basis for building software that processes archetypes, independent of their persistent representation; equally, it can be used to develop the output side of parsers that process archetypes in a linguistic format, such as the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html" target="_blank" rel="noopener">openEHR Archetype Definition Language (ADL)</a>, XML-instance and so on. As a specification, it can be treated as an API for archetypes.</p>
595595
</div>
596596
<div class="paragraph">
597-
<p>It is recommended that the <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html" target="_blank" rel="noopener">openEHR ADL document</a> be read in conjunction with this document, since it contains a detailed explanation of the semantics of archetypes, and many of the examples are more obvious in ADL, regardless of whether ADL is actually used with the object model presented here or not.</p>
597+
<p>It is recommended that the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html" target="_blank" rel="noopener">openEHR ADL document</a> be read in conjunction with this document, since it contains a detailed explanation of the semantics of archetypes, and many of the examples are more obvious in ADL, regardless of whether ADL is actually used with the object model presented here or not.</p>
598598
</div>
599599
</div>
600600
<div class="sect2">
@@ -608,7 +608,7 @@ <h3 id="_related_documents"><a class="anchor" href="#_related_documents"></a>1.2
608608
<p>The <a href="https://specifications.openehr.org/releases/BASE/latest/architecture_overview.html" target="_blank" rel="noopener">openEHR Architecture Overview</a>;</p>
609609
</li>
610610
<li>
611-
<p>The <a href="https://specifications.openehr.org/releases/AM/latest/Overview.html" target="_blank" rel="noopener">openEHR Archetypes Technical Overview</a>.</p>
611+
<p>The <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/Overview.html" target="_blank" rel="noopener">openEHR Archetypes Technical Overview</a>.</p>
612612
</li>
613613
</ul>
614614
</div>
@@ -618,7 +618,7 @@ <h3 id="_related_documents"><a class="anchor" href="#_related_documents"></a>1.2
618618
<div class="ulist">
619619
<ul>
620620
<li>
621-
<p>The <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html" target="_blank" rel="noopener">openEHR Definition Language</a>;</p>
621+
<p>The <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html" target="_blank" rel="noopener">openEHR Definition Language</a>;</p>
622622
</li>
623623
<li>
624624
<p>The <a href="https://specifications.openehr.org/releases/1.0.2/architecture/am/openehr_archetype_profile.pdf" target="_blank" rel="noopener">openEHR Archetype Profile</a>.</p>
@@ -662,7 +662,7 @@ <h3 id="_status"><a class="anchor" href="#_status"></a>1.4. Status</h3>
662662
<div class="title">Note</div>
663663
</td>
664664
<td class="content">
665-
for users requiring the most recent form of ADL and archetype technology in general, the <a href="https://specifications.openehr.org/releases/AM/latest/AOM2.html" target="_blank" rel="noopener">Archetype Definition Language 2 (ADL2) specifications should be used</a>. In particular, the <a href="https://specifications.openehr.org/releases/AM/latest/Overview.html" target="_blank" rel="noopener">Archetype Technology Overview</a> should be referred to for the most current state of Archetype Technology.
665+
for users requiring the most recent form of ADL and archetype technology in general, the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/AOM2.html" target="_blank" rel="noopener">Archetype Definition Language 2 (ADL2) specifications should be used</a>. In particular, the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/Overview.html" target="_blank" rel="noopener">Archetype Technology Overview</a> should be referred to for the most current state of Archetype Technology.
666666
</td>
667667
</tr>
668668
</table>
@@ -691,7 +691,7 @@ <h3 id="_background"><a class="anchor" href="#_background"></a>1.7. Background</
691691
<div class="sect3">
692692
<h4 id="_what_is_an_archetype"><a class="anchor" href="#_what_is_an_archetype"></a>1.7.1. What is an Archetype?</h4>
693693
<div class="paragraph">
694-
<p>Archetypes are constraint-based models of domain entities, or what some might call "structured business rules". Each archetype describes configurations of data instances whose classes are described in a reference model; the instance configurations are considered to be valid exemplars of a particular domain concept. Thus, in medicine, an archetype might be designed to constrain configurations of instances of a simple node/arc information model, that express a "microbiology test result" or a "physical examination". Archetypes can be composed, specialised, and templated for local use. The archetype concept has been described in detail by <a href="#Beale2000">Beale (2000)</a>, <a href="#Beale2002">Beale (2002)</a>. Most of the detailed formal semantics are described in the <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html" target="_blank" rel="noopener">openEHR Archetype Definition Language</a>. The openEHR archetype framework is described in the <a href="https://specifications.openehr.org/releases/AM/latest/Overview.html" target="_blank" rel="noopener">openEHR Archetypes Technical Overview</a>.</p>
694+
<p>Archetypes are constraint-based models of domain entities, or what some might call "structured business rules". Each archetype describes configurations of data instances whose classes are described in a reference model; the instance configurations are considered to be valid exemplars of a particular domain concept. Thus, in medicine, an archetype might be designed to constrain configurations of instances of a simple node/arc information model, that express a "microbiology test result" or a "physical examination". Archetypes can be composed, specialised, and templated for local use. The archetype concept has been described in detail by <span class="citation"><a href="#Beale2000">Beale (2000)</a></span>, <span class="citation"><a href="#Beale2002">Beale (2002)</a></span>. Most of the detailed formal semantics are described in the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html" target="_blank" rel="noopener">openEHR Archetype Definition Language</a>. The openEHR archetype framework is described in the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/Overview.html" target="_blank" rel="noopener">openEHR Archetypes Technical Overview</a>.</p>
695695
</div>
696696
</div>
697697
<div class="sect3">
@@ -832,7 +832,7 @@ <h4 id="_archetypes_as_objects"><a class="anchor" href="#_archetypes_as_objects"
832832
<div class="sect3">
833833
<h4 id="_the_archetype_ontology"><a class="anchor" href="#_the_archetype_ontology"></a>2.3.2. The Archetype Ontology</h4>
834834
<div class="paragraph">
835-
<p>There are no linguistic entities at all in the <code>definition</code> part of an archetype, with the possible exception of constraints on text items which might have been defined in terms of regular expression patterns or fixed strings. All linguistic entities are defined in the <code>ontology</code> part of the archetype, in such a way as to allow them to be translated into other languages in convenient blocks. As described in the openEHR ADL document, there are four major parts in an archetype <code>ontology</code> section: term definitions, constraint definitions, term bindings and constraint bindings. The former two define the meanings of various terms and textual constraints which occur in the archetype; they are indexed with unique identifiers which are used within the archetype definition body. The latter two ontology sections describe the mappings of terms used internally to external terminologies. Due to the well-known problems with terminologies (described in some detail in the <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html" target="_blank" rel="noopener">openEHR ADL 1.4 specification</a>, and also by e.g. <a href="#Rector1999">Rector (2000)</a> and others), mappings may be partial, incomplete, approximate, and occasionally, exact.</p>
835+
<p>There are no linguistic entities at all in the <code>definition</code> part of an archetype, with the possible exception of constraints on text items which might have been defined in terms of regular expression patterns or fixed strings. All linguistic entities are defined in the <code>ontology</code> part of the archetype, in such a way as to allow them to be translated into other languages in convenient blocks. As described in the openEHR ADL document, there are four major parts in an archetype <code>ontology</code> section: term definitions, constraint definitions, term bindings and constraint bindings. The former two define the meanings of various terms and textual constraints which occur in the archetype; they are indexed with unique identifiers which are used within the archetype definition body. The latter two ontology sections describe the mappings of terms used internally to external terminologies. Due to the well-known problems with terminologies (described in some detail in the <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html" target="_blank" rel="noopener">openEHR ADL 1.4 specification</a>, and also by e.g. <span class="citation"><a href="#Rector1999">Rector (2000)</a></span> and others), mappings may be partial, incomplete, approximate, and occasionally, exact.</p>
836836
</div>
837837
</div>
838838
<div class="sect3">
@@ -1247,7 +1247,7 @@ <h5 id="_reference_objects_c_reference_object"><a class="anchor" href="#_referen
12471247
</ul>
12481248
</div>
12491249
<div class="paragraph">
1250-
<p>See <a href="https://specifications.openehr.org/releases/AM/latest/ADL1.4.html#_placeholder_constraints">Placeholder constraints</a> in the ADL specification for a fuller explanation.</p>
1250+
<p>See <a href="https://specifications.openehr.org/releases/AM/Release-2.3.0/ADL1.4.html#_placeholder_constraints">Placeholder constraints</a> in the ADL specification for a fuller explanation.</p>
12511251
</div>
12521252
</div>
12531253
</div>
@@ -2073,7 +2073,7 @@ <h2 id="_the_assertion_package"><a class="anchor" href="#_the_assertion_package"
20732073
<div class="sect2">
20742074
<h3 id="_overview_3"><a class="anchor" href="#_overview_3"></a>5.1. Overview</h3>
20752075
<div class="paragraph">
2076-
<p>Assertions are expressed in archetypes in typed first-order predicate logic (FOL). They are used in two places: to express archetype slot constraints, and to express rules in complex object constraints. In both of these places, their role is to constrain something <em>inside</em> the archetype. Constraints on external resources such as terminologies are expressed in the constraint binding part of the archetype <code>ontology</code>, described in <a href="#terminology_package">[terminology_package]</a>. The <code>assertion</code> package is illustrated below.</p>
2076+
<p>Assertions are expressed in archetypes in typed first-order predicate logic (FOL). They are used in two places: to express archetype slot constraints, and to express rules in complex object constraints. In both of these places, their role is to constrain something <em>inside</em> the archetype. Constraints on external resources such as terminologies are expressed in the constraint binding part of the archetype <code>ontology</code>, described in <a href="#_terminology_package">Section 7</a>. The <code>assertion</code> package is illustrated below.</p>
20772077
</div>
20782078
<div id="assertion_package" class="imageblock text-center text-center">
20792079
<div class="content">
@@ -4021,7 +4021,7 @@ <h2 id="_references"><a class="anchor" href="#_references"></a>References</h2>
40214021
</div>
40224022
<div id="footer">
40234023
<div id="footer-text">
4024-
Last updated 2023-02-14 22:51:34 UTC
4024+
Last updated 2024-03-20 13:51:22 UTC
40254025
</div>
40264026
</div>
40274027
</body>

0 commit comments

Comments
 (0)