EHDS openEHR data exchange
0.1.0 - ci-build
EHDS openEHR data exchange
0.1.0 - ci-build
EHDS openEHR data exchange, published by Ian. 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/freshehr/EHDS-openEHR-FHIR-IG/ and changes regularly. See the Directory of published versions
| Draft as of 2026-03-25 |
JSON representation of the Cluster logical model.
{
"resourceType" : "StructureDefinition",
"id" : "Cluster",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition Cluster</b></p><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck0.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-Cluster-definitions.html#Cluster\" title=\"openEHR Cluster\">Cluster</a><a name=\"Cluster\"> </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\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></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=\"https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_cluster_class\">CLUSTER</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\">Cluster<br/><br/>Elements defined in Ancestors:<a href=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" 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=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" 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=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" title=\"Optional globally unique object identifier for root points of archetyped structures. \">uid</a>, <a href=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" 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=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" title=\"Details of archetyping used on this node.\">archetype_details</a>, <a href=\"https://specifications.openehr.org/releases/RM/development/common.html#_locatable_class\" 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>, <a href=\"https://specifications.openehr.org/releases/RM/Release-1.1.0/data_structures.html#_cluster_class\" title=\"Ordered list of items - `CLUSTER` or `ELEMENT` objects - under this `CLUSTER`. \">items</a></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/Release-1.1.0/data_structures.html#_cluster_class"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-ready"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-operation",
"valueCanonical" : "#concept"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-replace-cardinality"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-ready"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint",
"valueCode" : "element-view-replace-cardinality"
}
],
"url" : "https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/Cluster",
"version" : "0.1.0",
"name" : "Cluster",
"status" : "draft",
"date" : "2026-03-25T15:55:34+00:00",
"publisher" : "Ian",
"contact" : [
{
"name" : "Ian",
"telecom" : [
{
"system" : "url",
"value" : "http://example.org/example-publisher"
}
]
}
],
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "https://ianbennett.github.io/ExampleIG_Ian/StructureDefinition/Cluster",
"baseDefinition" : "http://openehr.org/fhir/StructureDefinition/CLUSTER",
"derivation" : "specialization",
"snapshot" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString" : "0.1.0-snapshot"
}
],
"element" : [
{
"id" : "Cluster",
"path" : "Cluster",
"short" : "Cluster",
"definition" : "openEHR Cluster",
"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"
}
],
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Cluster.name",
"path" : "Cluster.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" : "Cluster.archetype-node-id",
"path" : "Cluster.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" : "Cluster.uid",
"path" : "Cluster.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" : "Cluster.links",
"path" : "Cluster.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" : "Cluster.archetype-details",
"path" : "Cluster.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" : "Cluster.feeder-audit",
"path" : "Cluster.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" : "Cluster.items",
"extension" : [
{
"extension" : [
{
"url" : "name",
"valueCode" : "element-view-group"
},
{
"url" : "value",
"valueString" : "Items"
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
},
{
"extension" : [
{
"url" : "name",
"valueCode" : "element-view-order"
},
{
"url" : "value",
"valueInteger" : 8
}
],
"url" : "http://hl7.org/fhir/tools/StructureDefinition/view-hint"
}
],
"path" : "Cluster.items",
"short" : "Ordered list of items - `CLUSTER` or `ELEMENT` objects - under this `CLUSTER`.",
"definition" : "Ordered list of items - `CLUSTER` or `ELEMENT` objects - under this `CLUSTER`.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CLUSTER.items",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/ITEM"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "Cluster",
"path" : "Cluster",
"short" : "Cluster",
"definition" : "openEHR Cluster"
}
]
}
}
IG © 2026+ Ian. Package openehr.ehds.fhir.dataexchange#0.1.0 based on FHIR 4.0.1. Generated 2026-03-25
Links:
Table of Contents |
QA Report
The Xt-EHR action is co-funded by the European Union, EU4Health Program 2021-2027, under Grant Agreement Nr.ยบ 101128085.
