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 COMPOSITION logical model.
{
"resourceType" : "StructureDefinition",
"id" : "COMPOSITION",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition COMPOSITION</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-COMPOSITION-definitions.html#COMPOSITION\" title=\"Content of one version in a `VERSIONED_COMPOSITION`. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in Compositions, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the Composition.\">COMPOSITION</a><a name=\"COMPOSITION\"> </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 ( Setting_valid, unnamed2, unnamed3, Category_validity, Is_persistent_validity, Content_valid, Is_archetype_root )\">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-LOCATABLE.html\">LOCATABLE</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\">Content of one version in a `VERSIONED_COMPOSITION`.<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. \n\">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. \n\nAt an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object. \n\">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=\"binding\"/><span style=\"font-weight:bold\" title=\"null\" class=\"binding\">Binding: </span><a href=\"https://specifications.openehr.org/fhir/valueset-languages\" class=\"binding\">https://specifications.openehr.org/fhir/valueset-languages</a><span title=\"null\" class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R5/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\" class=\"binding\">required</a><span title=\"null\" class=\"binding\">)</span><br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Setting valid\" class=\"constraint\">Setting_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"unnamed2\" class=\"constraint\">unnamed2</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"unnamed3\" class=\"constraint\">unnamed3</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Category validity\" class=\"constraint\">Category_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Is persistent validity must satisfy conditional constraints\" class=\"constraint\">Is_persistent_validity</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Content valid must be present\" class=\"constraint\">Content_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Is archetype root\" class=\"constraint\">Is_archetype_root</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-COMPOSITION-definitions.html#COMPOSITION.language\" title=\"Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set `languages`. The language of an Entry if different from the Composition is indicated in `ENTRY._language_`. \">language</a><a name=\"COMPOSITION.language\"> </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-CODE-PHRASE.html\">CODE_PHRASE</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\">Mandatory indicator of the localised language in which this Composition is written.</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-COMPOSITION-definitions.html#COMPOSITION.territory\" title=\"Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.\">territory</a><a name=\"COMPOSITION.territory\"> </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-CODE-PHRASE.html\">CODE_PHRASE</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\">Name of territory in which this Composition was written.</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-COMPOSITION-definitions.html#COMPOSITION.category\" title=\"Temporal category of this Composition, i.e. \n\n* `431|persistent|` - of potential life-time validity;\n* `451|episodic|` - valid over the life of a care episode;\n* `433|event|` - valid at the time of recording (long-term validity requires subsequent clinical assessment).\n\nor any other code defined in the openEHR terminology group 'category'.\n\">category</a><a name=\"COMPOSITION.category\"> </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-CODED-TEXT.html\">DV_CODED_TEXT</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\">Temporal category of this Composition, i.</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-COMPOSITION-definitions.html#COMPOSITION.context\" title=\"The clinical session context of this Composition, i.e. the contextual attributes of the clinical session. \">context</a><a name=\"COMPOSITION.context\"> </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-EVENT-CONTEXT.html\">EVENT_CONTEXT</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 clinical session context of this Composition, i.</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-COMPOSITION-definitions.html#COMPOSITION.composer\" title=\"The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of `PARTY_PROXY` will be used.\">composer</a><a name=\"COMPOSITION.composer\"> </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-PARTY-PROXY.html\">PARTY_PROXY</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 person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).</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-COMPOSITION-definitions.html#COMPOSITION.content\" title=\"The content of this Composition. \">content</a><a name=\"COMPOSITION.content\"> </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-CONTENT-ITEM.html\">CONTENT_ITEM</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 content of this Composition.<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>"
},
"contained" : [
{
"resourceType" : "OperationDefinition",
"id" : "is_persistent",
"name" : "is_persistent",
"title" : "is_persistent",
"status" : "active",
"kind" : "operation",
"description" : "True if category is `431|persistent|`, False otherwise. Useful for finding Compositions in an EHR which are guaranteed to be of interest to most users. ",
"code" : "is_persistent",
"system" : false,
"instance" : true,
"parameter" : [
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "boolean"
}
]
}
],
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl" : "https://specifications.openehr.org/releases/RM/development/ehr.html#_composition_class"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#is_persistent"
},
{
"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/COMPOSITION",
"version" : "0.1.0",
"name" : "COMPOSITION",
"title" : "COMPOSITION",
"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" : "Content of one version in a `VERSIONED_COMPOSITION`. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in Compositions, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the Composition.",
"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/COMPOSITION",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/LOCATABLE",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0"
}
],
"element" : [
{
"id" : "COMPOSITION",
"path" : "COMPOSITION",
"short" : "Content of one version in a `VERSIONED_COMPOSITION`.",
"definition" : "Content of one version in a `VERSIONED_COMPOSITION`. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in Compositions, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the Composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "Links_valid",
"severity" : "error",
"human" : "Links valid must be present",
"expression" : "links.exists() implies links.empty().not()",
"source" : "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key" : "Archetyped_valid",
"severity" : "error",
"human" : "Archetyped valid must satisfy exclusive conditions",
"expression" : "is_archetype_root() xor archetype_details .empty()",
"source" : "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key" : "Archetype_node_id_valid",
"severity" : "error",
"human" : "Archetype node id valid must not be empty",
"expression" : "archetype_node_id.empty().not()",
"source" : "http://openehr.org/fhir/StructureDefinition/LOCATABLE"
},
{
"key" : "Setting_valid",
"severity" : "error",
"human" : "Setting valid",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "unnamed2",
"severity" : "error",
"human" : "unnamed2",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "unnamed3",
"severity" : "error",
"human" : "unnamed3",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Category_validity",
"severity" : "error",
"human" : "Category validity",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Is_persistent_validity",
"severity" : "error",
"human" : "Is persistent validity must satisfy conditional constraints",
"expression" : "is_persistent() implies context .empty()"
},
{
"key" : "Content_valid",
"severity" : "error",
"human" : "Content valid must be present",
"expression" : "content.exists() implies content.empty().not()"
},
{
"key" : "Is_archetype_root",
"severity" : "error",
"human" : "Is archetype root",
"expression" : "is_archetype_root()"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "COMPOSITION.name",
"path" : "COMPOSITION.name",
"short" : "Runtime name of this fragment, used to build runtime paths.",
"definition" : "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" : 1,
"max" : "1",
"base" : {
"path" : "LOCATABLE.name",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-TEXT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.archetype-node-id",
"path" : "COMPOSITION.archetype_node_id",
"short" : "Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths.",
"definition" : "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. \n\nAt 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" : 1,
"max" : "1",
"base" : {
"path" : "LOCATABLE.archetype_node_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.uid",
"path" : "COMPOSITION.uid",
"short" : "Optional globally unique object identifier for root points of archetyped structures.",
"definition" : "Optional globally unique object identifier for root points of archetyped structures.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LOCATABLE.uid",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/UID-BASED-ID"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.links",
"path" : "COMPOSITION.links",
"short" : "Links to other archetyped structures (data whose root object inherits from `ARCHETYPED`, such as `ENTRY`, `SECTION` and so on).",
"definition" : "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" : 0,
"max" : "*",
"base" : {
"path" : "LOCATABLE.links",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/LINK"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.archetype-details",
"path" : "COMPOSITION.archetype_details",
"short" : "Details of archetyping used on this node.",
"definition" : "Details of archetyping used on this node.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "LOCATABLE.archetype_details",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/ARCHETYPED"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.feeder-audit",
"path" : "COMPOSITION.feeder_audit",
"short" : "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" : "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" : 0,
"max" : "1",
"base" : {
"path" : "LOCATABLE.feeder_audit",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/FEEDER-AUDIT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.language",
"path" : "COMPOSITION.language",
"short" : "Mandatory indicator of the localised language in which this Composition is written.",
"definition" : "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set `languages`. The language of an Entry if different from the Composition is indicated in `ENTRY._language_`.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "COMPOSITION.language",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.territory",
"path" : "COMPOSITION.territory",
"short" : "Name of territory in which this Composition was written.",
"definition" : "Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "COMPOSITION.territory",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.category",
"path" : "COMPOSITION.category",
"short" : "Temporal category of this Composition, i.",
"definition" : "Temporal category of this Composition, i.e. \n\n* `431|persistent|` - of potential life-time validity;\n* `451|episodic|` - valid over the life of a care episode;\n* `433|event|` - valid at the time of recording (long-term validity requires subsequent clinical assessment).\n\nor any other code defined in the openEHR terminology group 'category'.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "COMPOSITION.category",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.context",
"path" : "COMPOSITION.context",
"short" : "The clinical session context of this Composition, i.",
"definition" : "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "COMPOSITION.context",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.composer",
"path" : "COMPOSITION.composer",
"short" : "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).",
"definition" : "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of `PARTY_PROXY` will be used.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "COMPOSITION.composer",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.content",
"path" : "COMPOSITION.content",
"short" : "The content of this Composition.",
"definition" : "The content of this Composition.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "COMPOSITION.content",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "COMPOSITION",
"path" : "COMPOSITION",
"short" : "Content of one version in a `VERSIONED_COMPOSITION`.",
"definition" : "Content of one version in a `VERSIONED_COMPOSITION`. A Composition is considered the unit of modification of the record, the unit of transmission in record Extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.\n\nNOTE: It is strongly recommended that the inherited attribute `_uid_` be populated in Compositions, using the UID copied from the `_object_id()_` of the `_uid_` field of the enclosing `VERSION` object. +\nFor example, the `ORIGINAL_VERSION.uid` `87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2` would be copied to the `_uid_` field of the Composition.",
"min" : 0,
"max" : "*",
"constraint" : [
{
"key" : "Setting_valid",
"severity" : "error",
"human" : "Setting valid",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "unnamed2",
"severity" : "error",
"human" : "unnamed2",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "unnamed3",
"severity" : "error",
"human" : "unnamed3",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Category_validity",
"severity" : "error",
"human" : "Category validity",
"expression" : "null # TODO: manual translation needed"
},
{
"key" : "Is_persistent_validity",
"severity" : "error",
"human" : "Is persistent validity must satisfy conditional constraints",
"expression" : "is_persistent() implies context .empty()"
},
{
"key" : "Content_valid",
"severity" : "error",
"human" : "Content valid must be present",
"expression" : "content.exists() implies content.empty().not()"
},
{
"key" : "Is_archetype_root",
"severity" : "error",
"human" : "Is archetype root",
"expression" : "is_archetype_root()"
}
],
"isModifier" : false,
"binding" : {
"strength" : "required",
"valueSet" : "https://specifications.openehr.org/fhir/valueset-languages"
}
},
{
"id" : "COMPOSITION.language",
"path" : "COMPOSITION.language",
"short" : "Mandatory indicator of the localised language in which this Composition is written.",
"definition" : "Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set `languages`. The language of an Entry if different from the Composition is indicated in `ENTRY._language_`. ",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.territory",
"path" : "COMPOSITION.territory",
"short" : "Name of territory in which this Composition was written.",
"definition" : "Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.category",
"path" : "COMPOSITION.category",
"short" : "Temporal category of this Composition, i.",
"definition" : "Temporal category of this Composition, i.e. \n\n* `431|persistent|` - of potential life-time validity;\n* `451|episodic|` - valid over the life of a care episode;\n* `433|event|` - valid at the time of recording (long-term validity requires subsequent clinical assessment).\n\nor any other code defined in the openEHR terminology group 'category'.\n",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.context",
"path" : "COMPOSITION.context",
"short" : "The clinical session context of this Composition, i.",
"definition" : "The clinical session context of this Composition, i.e. the contextual attributes of the clinical session. ",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/EVENT-CONTEXT"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.composer",
"path" : "COMPOSITION.composer",
"short" : "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system).",
"definition" : "The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of `PARTY_PROXY` will be used.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/PARTY-PROXY"
}
],
"isModifier" : false
},
{
"id" : "COMPOSITION.content",
"path" : "COMPOSITION.content",
"short" : "The content of this Composition.",
"definition" : "The content of this Composition. ",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/CONTENT-ITEM"
}
],
"isModifier" : false
}
]
}
}