OpenEHR Base package
0.1.0 - First Draft
OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions
Page standards status: Informative | Maturity Level: 3 |
XML representation of the HISTORY logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="HISTORY"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition HISTORY</b></p><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY" title="Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of `ITEM_STRUCTURE`, ensuring that each Event in the `_events_` of a given instance is of the same structural type, i.e. `ITEM_TREE`, `ITEM_LIST` etc.
For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the `EVENT._offset_` must be a multiple of period for each Event. Missing events in a period History are however allowed. ">HISTORY</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( Events_valid, Periodic_validity, Period_consistency )">C</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-DATA-STRUCTURE.html">DATA_STRUCTURE</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Root object of a linear history, i.<br/><br/>Elements defined in Ancestors:<a href="StructureDefinition-LOCATABLE.html" title="Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users.
">name</a>, <a href="StructureDefinition-LOCATABLE.html" title="Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.
At an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.
">archetype_node_id</a>, <a href="StructureDefinition-LOCATABLE.html" title="Optional globally unique object identifier for root points of archetyped structures. ">uid</a>, <a href="StructureDefinition-LOCATABLE.html" title="Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions. ">links</a>, <a href="StructureDefinition-LOCATABLE.html" title="Details of archetyping used on this node.">archetype_details</a>, <a href="StructureDefinition-LOCATABLE.html" title="Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node. ">feeder_audit</a><br class="constraint"/><span title="null" class="constraint">Constraints: </span><span style="font-weight:bold" title="Events valid must be present" class="constraint">Events_valid</span><span title="null" class="constraint">, </span><span style="font-weight:bold" title="Periodic validity must satisfy exclusive conditions" class="constraint">Periodic_validity</span><span title="null" class="constraint">, </span><span style="font-weight:bold" title="Period consistency must satisfy conditional constraints" class="constraint">Period_consistency</span><br/></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY.origin" title="Time origin of this event history. The first event is not necessarily at the origin point. ">origin</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY.origin"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-DV-DATE-TIME.html">DV_DATE_TIME</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Time origin of this event history.</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: white; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY.period" title="Period between samples in this segment if periodic.">period</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY.period"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-DV-DURATION.html">DV_DURATION</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Period between samples in this segment if periodic.</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY.duration" title="Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists. ">duration</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY.duration"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-DV-DURATION.html">DV_DURATION</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: white; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY.summary" title="Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data.">summary</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY.summary"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-ITEM-STRUCTURE.html">ITEM_STRUCTURE</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Optional summary data that aggregates, organizes, reduces and transforms the event series.</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-HISTORY-definitions.html#HISTORY.events" title="The events in the series. This attribute is of a generic type whose parameter must be a descendant of `ITEM_SUTRUCTURE`.">events</a><a href="StructureDefinition-ITEM-STRUCTURE.html"><T : ITEM_STRUCTURE></a><a name="HISTORY.events"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-EVENT.html">EVENT</a><http://openehr.org/fhir/StructureDefinition/T></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">The events in the series.<br/></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<contained>
<OperationDefinition>
<id value="is_periodic"/>
<name value="is_periodic"/>
<title value="is_periodic"/>
<status value="active"/>
<kind value="operation"/>
<description value="Indicates whether history is periodic.
"/>
<code value="is_periodic"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
</OperationDefinition>
</contained>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/web-source">
<valueUrl
value="https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_history_class"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter">
<extension url="name">
<valueCode value="T"/>
</extension>
<extension url="type">
<valueUri
value="http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#is_periodic"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fhir"/>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/view-hint">
<valueCode value="element-view-replace-cardinality"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="3">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://openehr.org/fhir/ImplementationGuide/openehr.base"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="informative">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://openehr.org/fhir/ImplementationGuide/openehr.base"/>
</extension>
</valueCode>
</extension>
<url value="http://openehr.org/fhir/StructureDefinition/HISTORY"/>
<version value="0.1.0"/>
<name value="HISTORY"/>
<title value="HISTORY"/>
<status value="active"/>
<experimental value="false"/>
<date value="2025-09-06T15:35:39+10:00"/>
<publisher value="openEHR + HL7"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://www.openehr.org"/>
</telecom>
</contact>
<description
value="Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of `ITEM_STRUCTURE`, ensuring that each Event in the `_events_` of a given instance is of the same structural type, i.e. `ITEM_TREE`, `ITEM_LIST` etc.
For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the `EVENT._offset_` must be a multiple of period for each Event. Missing events in a period History are however allowed. "/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="http://openehr.org/fhir/StructureDefinition/HISTORY"/>
<baseDefinition
value="http://openehr.org/fhir/StructureDefinition/DATA-STRUCTURE"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="0.1.0"/>
</extension>
<element id="HISTORY">
<path value="HISTORY"/>
<short value="Root object of a linear history, i."/>
<definition
value="Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of `ITEM_STRUCTURE`, ensuring that each Event in the `_events_` of a given instance is of the same structural type, i.e. `ITEM_TREE`, `ITEM_LIST` etc.
For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the `EVENT._offset_` must be a multiple of period for each Event. Missing events in a period History are however allowed. "/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<constraint>
<key value="Links_valid"/>
<severity value="error"/>
<human value="Links valid must be present"/>
<expression value="links.exists() implies links.empty().not()"/>
<source
value="http://openehr.org/fhir/StructureDefinition/LOCATABLE"/>
</constraint>
<constraint>
<key value="Archetyped_valid"/>
<severity value="error"/>
<human value="Archetyped valid must satisfy exclusive conditions"/>
<expression
value="is_archetype_root() xor archetype_details .empty()"/>
<source
value="http://openehr.org/fhir/StructureDefinition/LOCATABLE"/>
</constraint>
<constraint>
<key value="Archetype_node_id_valid"/>
<severity value="error"/>
<human value="Archetype node id valid must not be empty"/>
<expression value="archetype_node_id.empty().not()"/>
<source
value="http://openehr.org/fhir/StructureDefinition/LOCATABLE"/>
</constraint>
<constraint>
<key value="Events_valid"/>
<severity value="error"/>
<human value="Events valid must be present"/>
<expression
value="(events.exists() and then events.empty().not()) or summary.exists()"/>
</constraint>
<constraint>
<key value="Periodic_validity"/>
<severity value="error"/>
<human value="Periodic validity must satisfy exclusive conditions"/>
<expression value="is_periodic() xor period .empty()"/>
</constraint>
<constraint>
<key value="Period_consistency"/>
<severity value="error"/>
<human
value="Period consistency must satisfy conditional constraints"/>
<expression
value="is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="HISTORY.name">
<path value="HISTORY.name"/>
<short
value="Runtime name of this fragment, used to build runtime paths."/>
<definition
value="Runtime name of this fragment, used to build runtime paths. This is the term provided via a clinical application or batch process to name this EHR construct: its retention in the EHR faithfully preserves the original label by which this entry was known to end users."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="LOCATABLE.name"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="http://openehr.org/fhir/StructureDefinition/DV-TEXT"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.archetype-node-id">
<path value="HISTORY.archetype_node_id"/>
<short
value="Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths."/>
<definition
value="Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g. `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.
At an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="LOCATABLE.archetype_node_id"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.uid">
<path value="HISTORY.uid"/>
<short
value="Optional globally unique object identifier for root points of archetyped structures."/>
<definition
value="Optional globally unique object identifier for root points of archetyped structures."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="LOCATABLE.uid"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.links">
<path value="HISTORY.links"/>
<short
value="Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on)."/>
<definition
value="Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on). Links may be to structures in other compositions."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="LOCATABLE.links"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="http://openehr.org/fhir/StructureDefinition/LINK"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.archetype-details">
<path value="HISTORY.archetype_details"/>
<short value="Details of archetyping used on this node."/>
<definition value="Details of archetyping used on this node."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="LOCATABLE.archetype_details"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://openehr.org/fhir/StructureDefinition/ARCHETYPED"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.feeder-audit">
<path value="HISTORY.feeder_audit"/>
<short
value="Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node."/>
<definition
value="Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="LOCATABLE.feeder_audit"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.origin">
<path value="HISTORY.origin"/>
<short value="Time origin of this event history."/>
<definition
value="Time origin of this event history. The first event is not necessarily at the origin point."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="HISTORY.origin"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.period">
<path value="HISTORY.period"/>
<short value="Period between samples in this segment if periodic."/>
<definition
value="Period between samples in this segment if periodic."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HISTORY.period"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DURATION"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.duration">
<path value="HISTORY.duration"/>
<short
value="Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists."/>
<definition
value="Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HISTORY.duration"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DURATION"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.summary">
<path value="HISTORY.summary"/>
<short
value="Optional summary data that aggregates, organizes, reduces and transforms the event series."/>
<definition
value="Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="HISTORY.summary"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.events">
<path value="HISTORY.events"/>
<short value="The events in the series."/>
<definition
value="The events in the series. This attribute is of a generic type whose parameter must be a descendant of `ITEM_SUTRUCTURE`."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="HISTORY.events"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter">
<extension url="name">
<valueCode value="T"/>
</extension>
<extension url="type">
<valueUri value="http://openehr.org/fhir/StructureDefinition/T"/>
</extension>
</extension>
<code value="http://openehr.org/fhir/StructureDefinition/EVENT"/>
</type>
<isModifier value="false"/>
</element>
</snapshot>
<differential>
<element id="HISTORY">
<path value="HISTORY"/>
<short value="Root object of a linear history, i."/>
<definition
value="Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of `ITEM_STRUCTURE`, ensuring that each Event in the `_events_` of a given instance is of the same structural type, i.e. `ITEM_TREE`, `ITEM_LIST` etc.
For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the `EVENT._offset_` must be a multiple of period for each Event. Missing events in a period History are however allowed. "/>
<min value="0"/>
<max value="*"/>
<constraint>
<key value="Events_valid"/>
<severity value="error"/>
<human value="Events valid must be present"/>
<expression
value="(events.exists() and then events.empty().not()) or summary.exists()"/>
</constraint>
<constraint>
<key value="Periodic_validity"/>
<severity value="error"/>
<human value="Periodic validity must satisfy exclusive conditions"/>
<expression value="is_periodic() xor period .empty()"/>
</constraint>
<constraint>
<key value="Period_consistency"/>
<severity value="error"/>
<human
value="Period consistency must satisfy conditional constraints"/>
<expression
value="is_periodic() implies events.for_all (e: EVENT | e.offset. to_seconds.mod(period.to_seconds) = 0)"/>
</constraint>
<isModifier value="false"/>
</element>
<element id="HISTORY.origin">
<path value="HISTORY.origin"/>
<short value="Time origin of this event history."/>
<definition
value="Time origin of this event history. The first event is not necessarily at the origin point. "/>
<min value="1"/>
<max value="1"/>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.period">
<path value="HISTORY.period"/>
<short value="Period between samples in this segment if periodic."/>
<definition
value="Period between samples in this segment if periodic."/>
<min value="0"/>
<max value="1"/>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DURATION"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.duration">
<path value="HISTORY.duration"/>
<short
value="Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists."/>
<definition
value="Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists. "/>
<min value="0"/>
<max value="1"/>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/DV-DURATION"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.summary">
<path value="HISTORY.summary"/>
<short
value="Optional summary data that aggregates, organizes, reduces and transforms the event series."/>
<definition
value="Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data."/>
<min value="0"/>
<max value="1"/>
<type>
<code
value="http://openehr.org/fhir/StructureDefinition/ITEM-STRUCTURE"/>
</type>
<isModifier value="false"/>
</element>
<element id="HISTORY.events">
<path value="HISTORY.events"/>
<short value="The events in the series."/>
<definition
value="The events in the series. This attribute is of a generic type whose parameter must be a descendant of `ITEM_SUTRUCTURE`."/>
<min value="0"/>
<max value="*"/>
<type>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-parameter">
<extension url="name">
<valueCode value="T"/>
</extension>
<extension url="type">
<valueUri value="http://openehr.org/fhir/StructureDefinition/T"/>
</extension>
</extension>
<code value="http://openehr.org/fhir/StructureDefinition/EVENT"/>
</type>
<isModifier value="false"/>
</element>
</differential>
</StructureDefinition>