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 PATHABLE logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="PATHABLE"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition PATHABLE</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_bck0.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-PATHABLE-definitions.html#PATHABLE" title="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`. The defining characteristics of `PATHABLE` objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient.">PATHABLE</a><a name="PATHABLE"> </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..*</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-Any.html">Any</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">This is an abstract type. Child types: <a href="StructureDefinition-EVENT-CONTEXT.html">EVENT_CONTEXT</a>, <a href="StructureDefinition-INSTRUCTION-DETAILS.html">INSTRUCTION_DETAILS</a>, <a href="StructureDefinition-ISM-TRANSITION.html">ISM_TRANSITION</a>, <a href="StructureDefinition-LOCATABLE.html">LOCATABLE</a><br/>The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`.<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="parent"/>
<name value="parent"/>
<title value="parent"/>
<status value="active"/>
<kind value="operation"/>
<description
value="Parent of this node in a compositional hierarchy.
"/>
<code value="parent"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="Parameters"/>
</parameter>
</OperationDefinition>
</contained>
<contained>
<OperationDefinition>
<id value="item_at_path"/>
<name value="item_at_path"/>
<title value="item_at_path"/>
<status value="active"/>
<kind value="operation"/>
<description
value="The item at a path (relative to this item); only valid for unique paths, i.e. paths that resolve to a single item. "/>
<code value="item_at_path"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="a_path"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="Base"/>
</parameter>
</OperationDefinition>
</contained>
<contained>
<OperationDefinition>
<id value="items_at_path"/>
<name value="items_at_path"/>
<title value="items_at_path"/>
<status value="active"/>
<kind value="operation"/>
<description value="List of items corresponding to a non-unique path."/>
<code value="items_at_path"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="a_path"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="Base"/>
</parameter>
</OperationDefinition>
</contained>
<contained>
<OperationDefinition>
<id value="path_exists"/>
<name value="path_exists"/>
<title value="path_exists"/>
<status value="active"/>
<kind value="operation"/>
<description
value="True if the path exists in the data with respect to the current item. "/>
<code value="path_exists"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="a_path"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
</OperationDefinition>
</contained>
<contained>
<OperationDefinition>
<id value="path_unique"/>
<name value="path_unique"/>
<title value="path_unique"/>
<status value="active"/>
<kind value="operation"/>
<description
value="True if the path corresponds to a single item in the data. "/>
<code value="path_unique"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="a_path"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
</OperationDefinition>
</contained>
<contained>
<OperationDefinition>
<id value="path_of_item"/>
<name value="path_of_item"/>
<title value="path_of_item"/>
<status value="active"/>
<kind value="operation"/>
<description
value="The path to an item relative to the root of this archetyped structure."/>
<code value="path_of_item"/>
<system value="false"/>
<instance value="true"/>
<parameter>
<name value="a_loc"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<type value="Parameters"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<type value="string"/>
</parameter>
</OperationDefinition>
</contained>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/web-source">
<valueUrl
value="https://specifications.openehr.org/releases/RM/development/common.html#_pathable_class"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#parent"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#item_at_path"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#items_at_path"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#path_exists"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#path_unique"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/type-operation">
<valueCanonical value="#path_of_item"/>
</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/PATHABLE"/>
<version value="0.1.0"/>
<name value="PATHABLE"/>
<title value="PATHABLE"/>
<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="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`. The defining characteristics of `PATHABLE` objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient."/>
<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="true"/>
<type value="http://openehr.org/fhir/StructureDefinition/PATHABLE"/>
<baseDefinition value="http://openehr.org/fhir/StructureDefinition/Any"/>
<derivation value="specialization"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="0.1.0"/>
</extension>
<element id="PATHABLE">
<path value="PATHABLE"/>
<short
value="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`."/>
<definition
value="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`. The defining characteristics of `PATHABLE` objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
</snapshot>
<differential>
<element id="PATHABLE">
<path value="PATHABLE"/>
<short
value="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`."/>
<definition
value="The `PATHABLE` class defines the pathing capabilities used by nearly all classes in the openEHR reference model, mostly via inheritance of `LOCATABLE`. The defining characteristics of `PATHABLE` objects are that they can locate child objects using paths, and they know their parent object in a compositional hierarchy. The parent feature is defined as abstract in the model, and may be implemented in any way convenient."/>
<min value="0"/>
<max value="*"/>
<isModifier value="false"/>
</element>
</differential>
</StructureDefinition>