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 VERSIONED-COMPOSITION logical model.
{
"resourceType" : "StructureDefinition",
"id" : "VERSIONED-COMPOSITION",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition VERSIONED-COMPOSITION</b></p><a name=\"VERSIONED-COMPOSITION\"> </a><a name=\"hcVERSIONED-COMPOSITION\"> </a><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-VERSIONED-COMPOSITION-definitions.html#VERSIONED_COMPOSITION\" title=\"Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`. \">VERSIONED_COMPOSITION</a><a href=\"StructureDefinition-Any.html\"><T : Any></a><a name=\"VERSIONED_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 ( Archetype_node_id_valid, Persistent_validity )\">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-VERSIONED-OBJECT.html\">VERSIONED_OBJECT</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\">Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.<br/><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-VERSIONED-OBJECT.html\" title=\"Unique identifier of this version container in the form of a UID with no extension. This id will be the same in all instances of the same container in a distributed environment, meaning that it can be understood as the uid of the virtual version tree. \">uid</a>, <a href=\"StructureDefinition-VERSIONED-OBJECT.html\" title=\"Reference to object to which this version container belongs, e.g. the id of the containing EHR or other relevant owning entity. \">owner_id</a>, <a href=\"StructureDefinition-VERSIONED-OBJECT.html\" title=\"Time of initial creation of this versioned object. \">time_created</a><br class=\"constraint\"/><span title=\"null\" class=\"constraint\">Constraints: </span><span style=\"font-weight:bold\" title=\"Archetype node id valid\" class=\"constraint\">Archetype_node_id_valid</span><span title=\"null\" class=\"constraint\">, </span><span style=\"font-weight:bold\" title=\"Persistent validity\" class=\"constraint\">Persistent_validity</span><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" : "Indicates whether this composition set is persistent; derived from first version.",
"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#_versioned_composition_class"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#is_persistent"
},
{
"extension" : [
{
"url" : "name",
"valueCode" : "T"
},
{
"url" : "type",
"valueUri" : "http://openehr.org/fhir/StructureDefinition/Any"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-parameter"
},
{
"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/VERSIONED-COMPOSITION",
"version" : "0.1.0",
"name" : "VERSIONED_COMPOSITION",
"title" : "VERSIONED_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" : "Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<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/VERSIONED_COMPOSITION",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0"
}
],
"element" : [
{
"id" : "VERSIONED_COMPOSITION",
"path" : "VERSIONED_COMPOSITION",
"short" : "Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.",
"definition" : "Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`. ",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "Version_count_valid",
"severity" : "error",
"human" : "Version count valid must satisfy range constraints",
"expression" : "version_count() >= 0",
"source" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT"
},
{
"key" : "All_version_ids_valid",
"severity" : "error",
"human" : "All version ids valid",
"expression" : "all_version_ids().count() = version_count()",
"source" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT"
},
{
"key" : "All_versions_valid",
"severity" : "error",
"human" : "All versions valid",
"expression" : "all_versions().count() = version_count()",
"source" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT"
},
{
"key" : "Latest_version_valid",
"severity" : "error",
"human" : "Latest version valid must be present",
"expression" : "version_count() > 0 implies latest_version().exists()",
"source" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT"
},
{
"key" : "Uid_validity",
"severity" : "error",
"human" : "Uid validity must not be empty",
"expression" : "extension.empty()",
"source" : "http://openehr.org/fhir/StructureDefinition/VERSIONED-OBJECT"
},
{
"key" : "Archetype_node_id_valid",
"severity" : "error",
"human" : "Archetype node id valid",
"expression" : "for_all v in all_versions() | v.archetype_node_id.is_equal (all_versions().first().archetype_node_id)"
},
{
"key" : "Persistent_validity",
"severity" : "error",
"human" : "Persistent validity",
"expression" : "for_all v in all_versions() | v.is_persistent() = all_versions().first().data.is_persistent()"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "VERSIONED_COMPOSITION.uid",
"path" : "VERSIONED_COMPOSITION.uid",
"short" : "Unique identifier of this version container in the form of a UID with no extension.",
"definition" : "Unique identifier of this version container in the form of a UID with no extension. This id will be the same in all instances of the same container in a distributed environment, meaning that it can be understood as the uid of the virtual version tree.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VERSIONED_OBJECT.uid",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/HIER-OBJECT-ID"
}
],
"isModifier" : false
},
{
"id" : "VERSIONED_COMPOSITION.owner-id",
"path" : "VERSIONED_COMPOSITION.owner_id",
"short" : "Reference to object to which this version container belongs, e.",
"definition" : "Reference to object to which this version container belongs, e.g. the id of the containing EHR or other relevant owning entity.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VERSIONED_OBJECT.owner_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/OBJECT-REF"
}
],
"isModifier" : false
},
{
"id" : "VERSIONED_COMPOSITION.time-created",
"path" : "VERSIONED_COMPOSITION.time_created",
"short" : "Time of initial creation of this versioned object.",
"definition" : "Time of initial creation of this versioned object.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "VERSIONED_OBJECT.time_created",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/DV-DATE-TIME"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "VERSIONED_COMPOSITION",
"path" : "VERSIONED_COMPOSITION",
"short" : "Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`.",
"definition" : "Version-controlled composition abstraction, defined by inheriting `VERSIONED_OBJECT<COMPOSITION>`. ",
"min" : 0,
"max" : "*",
"constraint" : [
{
"key" : "Archetype_node_id_valid",
"severity" : "error",
"human" : "Archetype node id valid",
"expression" : "for_all v in all_versions() | v.archetype_node_id.is_equal (all_versions().first().archetype_node_id)"
},
{
"key" : "Persistent_validity",
"severity" : "error",
"human" : "Persistent validity",
"expression" : "for_all v in all_versions() | v.is_persistent() = all_versions().first().data.is_persistent()"
}
],
"isModifier" : false
}
]
}
}