OpenEHR Base package
0.1.0 - First Draft
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 |
JSON representation of the EHR logical model.
{
"resourceType" : "StructureDefinition",
"id" : "EHR",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition EHR</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-EHR-definitions.html#EHR\" title=\"The EHR object is the root object and access point of an EHR for a subject of care. \">EHR</a><a name=\"EHR\"> </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 ( Contributions_valid, Ehr_access_valid, Ehr_status_valid, Compositions_valid, Directory_valid, Folders_valid, Directory_in_folders )\">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-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\">The EHR object is the root object and access point of an EHR for a subject of care.<br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Contributions valid\" class=\"constraint\">Contributions_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Ehr access valid\" class=\"constraint\">Ehr_access_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Ehr status valid\" class=\"constraint\">Ehr_status_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Compositions valid\" class=\"constraint\">Compositions_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Directory valid must be present\" class=\"constraint\">Directory_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Folders valid must be present\" class=\"constraint\">Folders_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Directory in folders must be present\" class=\"constraint\">Directory_in_folders</span><br/></td></tr>\r\n<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-EHR-definitions.html#EHR.system-id\" title=\"The identifier of the logical EHR management system in which this EHR was created. \n\">system_id</a><a name=\"EHR.system_id\"> </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-HIER-OBJECT-ID.html\">HIER_OBJECT_ID</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\">The identifier of the logical EHR management system in which this EHR was created.</td></tr>\r\n<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-EHR-definitions.html#EHR.ehr-id\" title=\"The unique identifier of this EHR.\n\nNOTE: is is strongly recommended that a UUID always be used for this field.\">ehr_id</a><a name=\"EHR.ehr_id\"> </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\">1..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-HIER-OBJECT-ID.html\">HIER_OBJECT_ID</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\">The unique identifier of this EHR.</td></tr>\r\n<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-EHR-definitions.html#EHR.contributions\" title=\"List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of `VERSION` instances, i.e. items of type `VERSIONED_COMPOSITION` and `VERSIONED_FOLDER`. \">contributions</a><a name=\"EHR.contributions\"> </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-OBJECT-REF.html\">OBJECT_REF</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\">List of contributions causing changes to this EHR.<br/></td></tr>\r\n<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-EHR-definitions.html#EHR.ehr-status\" title=\"Reference to `EHR_STATUS` object for this EHR.\">ehr_status</a><a name=\"EHR.ehr_status\"> </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\">1..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-OBJECT-REF.html\">OBJECT_REF</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\">Reference to `EHR_STATUS` object for this EHR.</td></tr>\r\n<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-EHR-definitions.html#EHR.ehr-access\" title=\"Reference to `EHR_ACCESS` object for this EHR.\">ehr_access</a><a name=\"EHR.ehr_access\"> </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-OBJECT-REF.html\">OBJECT_REF</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\">Reference to `EHR_ACCESS` object for this EHR.</td></tr>\r\n<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-EHR-definitions.html#EHR.compositions\" title=\"Master list of all Versioned Composition references in this EHR.\">compositions</a><a name=\"EHR.compositions\"> </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-OBJECT-REF.html\">OBJECT_REF</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\">Master list of all Versioned Composition references in this EHR.<br/></td></tr>\r\n<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-EHR-definitions.html#EHR.directory\" title=\"Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.\">directory</a><a name=\"EHR.directory\"> </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-OBJECT-REF.html\">OBJECT_REF</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\">Optional directory structure for this EHR.</td></tr>\r\n<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-EHR-definitions.html#EHR.time-created\" title=\"Time of creation of the EHR.\">time_created</a><a name=\"EHR.time_created\"> </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\">1..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-DATE-TIME.html\">DV_DATE_TIME</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\">Time of creation of the EHR.</td></tr>\r\n<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-EHR-definitions.html#EHR.folders\" title=\"Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.\">folders</a><a name=\"EHR.folders\"> </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-OBJECT-REF.html\">OBJECT_REF</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\">Optional additional Folder structures for this EHR.<br/></td></tr>\r\n<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_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: white; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-EHR-definitions.html#EHR.tags\" title=\"Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.\">tags</a><a name=\"EHR.tags\"> </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-OBJECT-REF.html\">OBJECT_REF</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 list of tags associated with this EHR.<br/></td></tr>\r\n<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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl" : "https://specifications.openehr.org/releases/RM/development/ehr.html#_ehr_class"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-replace-cardinality"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url" : "http://openehr.org/fhir/StructureDefinition/EHR",
"version" : "0.1.0",
"name" : "EHR",
"title" : "EHR",
"status" : "active",
"experimental" : false,
"date" : "2025-09-06T15:35:39+10:00",
"publisher" : "openEHR + HL7",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.openehr.org"
}
]
}
],
"description" : "The EHR object is the root object and access point of an EHR for a subject of care. ",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://openehr.org/fhir/StructureDefinition/EHR",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/Any",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0"
}
],
"element" : [
{
"id" : "EHR",
"path" : "EHR",
"short" : "The EHR object is the root object and access point of an EHR for a subject of care.",
"definition" : "The EHR object is the root object and access point of an EHR for a subject of care. ",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "Contributions_valid",
"severity" : "error",
"human" : "Contributions valid",
"expression" : "for_all c in contributions | c.type().is_equal(\\\"CONTRIBUTION\\\")"
},
{
"key" : "Ehr_access_valid",
"severity" : "error",
"human" : "Ehr access valid",
"expression" : "ehr_access.type().is_equal (\\\"VERSIONED_EHR_ACCESS\\\")"
},
{
"key" : "Ehr_status_valid",
"severity" : "error",
"human" : "Ehr status valid",
"expression" : "ehr_status.type().is_equal(\\\"VERSIONED_EHR_STATUS\\\")"
},
{
"key" : "Compositions_valid",
"severity" : "error",
"human" : "Compositions valid",
"expression" : "for_all c in compositions | c.type().is_equal (\\\"VERSIONED_COMPOSITION\\\")"
},
{
"key" : "Directory_valid",
"severity" : "error",
"human" : "Directory valid must be present",
"expression" : "directory.exists() implies directory.type().is_equal (\\\"VERSIONED_FOLDER\\\")"
},
{
"key" : "Folders_valid",
"severity" : "error",
"human" : "Folders valid must be present",
"expression" : "folders.exists() implies for_all f in folders | f.type().is_equal(\\\"VERSIONED_FOLDER\\\")"
},
{
"key" : "Directory_in_folders",
"severity" : "error",
"human" : "Directory in folders must be present",
"expression" : "folders.exists() implies folders.item(1) = directory"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "EHR.system-id",
"path" : "EHR.system_id",
"short" : "The identifier of the logical EHR management system in which this EHR was created.",
"definition" : "The identifier of the logical EHR management system in which this EHR was created.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EHR.system_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-id",
"path" : "EHR.ehr_id",
"short" : "The unique identifier of this EHR.",
"definition" : "The unique identifier of this EHR.\n\nNOTE: is is strongly recommended that a UUID always be used for this field.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EHR.ehr_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier" : false
},
{
"id" : "EHR.contributions",
"path" : "EHR.contributions",
"short" : "List of contributions causing changes to this EHR.",
"definition" : "List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of `VERSION` instances, i.e. items of type `VERSIONED_COMPOSITION` and `VERSIONED_FOLDER`.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EHR.contributions",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-status",
"path" : "EHR.ehr_status",
"short" : "Reference to `EHR_STATUS` object for this EHR.",
"definition" : "Reference to `EHR_STATUS` object for this EHR.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EHR.ehr_status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-access",
"path" : "EHR.ehr_access",
"short" : "Reference to `EHR_ACCESS` object for this EHR.",
"definition" : "Reference to `EHR_ACCESS` object for this EHR.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EHR.ehr_access",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.compositions",
"path" : "EHR.compositions",
"short" : "Master list of all Versioned Composition references in this EHR.",
"definition" : "Master list of all Versioned Composition references in this EHR.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EHR.compositions",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.directory",
"path" : "EHR.directory",
"short" : "Optional directory structure for this EHR.",
"definition" : "Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "EHR.directory",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.time-created",
"path" : "EHR.time_created",
"short" : "Time of creation of the EHR.",
"definition" : "Time of creation of the EHR.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "EHR.time_created",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier" : false
},
{
"id" : "EHR.folders",
"path" : "EHR.folders",
"short" : "Optional additional Folder structures for this EHR.",
"definition" : "Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EHR.folders",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.tags",
"path" : "EHR.tags",
"short" : "Optional list of tags associated with this EHR.",
"definition" : "Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "EHR.tags",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "EHR",
"path" : "EHR",
"short" : "The EHR object is the root object and access point of an EHR for a subject of care.",
"definition" : "The EHR object is the root object and access point of an EHR for a subject of care. ",
"min" : 0,
"max" : "*",
"constraint" : [
{
"key" : "Contributions_valid",
"severity" : "error",
"human" : "Contributions valid",
"expression" : "for_all c in contributions | c.type().is_equal(\\\"CONTRIBUTION\\\")"
},
{
"key" : "Ehr_access_valid",
"severity" : "error",
"human" : "Ehr access valid",
"expression" : "ehr_access.type().is_equal (\\\"VERSIONED_EHR_ACCESS\\\")"
},
{
"key" : "Ehr_status_valid",
"severity" : "error",
"human" : "Ehr status valid",
"expression" : "ehr_status.type().is_equal(\\\"VERSIONED_EHR_STATUS\\\")"
},
{
"key" : "Compositions_valid",
"severity" : "error",
"human" : "Compositions valid",
"expression" : "for_all c in compositions | c.type().is_equal (\\\"VERSIONED_COMPOSITION\\\")"
},
{
"key" : "Directory_valid",
"severity" : "error",
"human" : "Directory valid must be present",
"expression" : "directory.exists() implies directory.type().is_equal (\\\"VERSIONED_FOLDER\\\")"
},
{
"key" : "Folders_valid",
"severity" : "error",
"human" : "Folders valid must be present",
"expression" : "folders.exists() implies for_all f in folders | f.type().is_equal(\\\"VERSIONED_FOLDER\\\")"
},
{
"key" : "Directory_in_folders",
"severity" : "error",
"human" : "Directory in folders must be present",
"expression" : "folders.exists() implies folders.item(1) = directory"
}
],
"isModifier" : false
},
{
"id" : "EHR.system-id",
"path" : "EHR.system_id",
"short" : "The identifier of the logical EHR management system in which this EHR was created.",
"definition" : "The identifier of the logical EHR management system in which this EHR was created. \n",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-id",
"path" : "EHR.ehr_id",
"short" : "The unique identifier of this EHR.",
"definition" : "The unique identifier of this EHR.\n\nNOTE: is is strongly recommended that a UUID always be used for this field.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier" : false
},
{
"id" : "EHR.contributions",
"path" : "EHR.contributions",
"short" : "List of contributions causing changes to this EHR.",
"definition" : "List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of `VERSION` instances, i.e. items of type `VERSIONED_COMPOSITION` and `VERSIONED_FOLDER`. ",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-status",
"path" : "EHR.ehr_status",
"short" : "Reference to `EHR_STATUS` object for this EHR.",
"definition" : "Reference to `EHR_STATUS` object for this EHR.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.ehr-access",
"path" : "EHR.ehr_access",
"short" : "Reference to `EHR_ACCESS` object for this EHR.",
"definition" : "Reference to `EHR_ACCESS` object for this EHR.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.compositions",
"path" : "EHR.compositions",
"short" : "Master list of all Versioned Composition references in this EHR.",
"definition" : "Master list of all Versioned Composition references in this EHR.",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.directory",
"path" : "EHR.directory",
"short" : "Optional directory structure for this EHR.",
"definition" : "Optional directory structure for this EHR. If present, this is a reference to the first member of `_folders_`.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.time-created",
"path" : "EHR.time_created",
"short" : "Time of creation of the EHR.",
"definition" : "Time of creation of the EHR.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier" : false
},
{
"id" : "EHR.folders",
"path" : "EHR.folders",
"short" : "Optional additional Folder structures for this EHR.",
"definition" : "Optional additional Folder structures for this EHR. If set, the `_directory_` attribute refers to the first member.",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "EHR.tags",
"path" : "EHR.tags",
"short" : "Optional list of tags associated with this EHR.",
"definition" : "Optional list of tags associated with this EHR. Tag `_target_` values can only be within the same EHR.",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
}
]
}
}