EHDS Logical Information Models
0.4.0 - draft
EHDS Logical Information Models
0.4.0 - draft
EHDS Logical Information Models, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions
| Draft as of 2026-03-16 |
XML representation of the EHDSImmunisationLaboratoryObligations logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="EHDSImmunisationLaboratoryObligations"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition EHDSImmunisationLaboratoryObligations</b></p><a name="EHDSImmunisationLaboratoryObligations"> </a><a name="hcEHDSImmunisationLaboratoryObligations"> </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_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-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation">EHDSImmunisation</a><a name="EHDSImmunisation"> </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="StructureDefinition-EHDSImmunisation.html">EHDSImmunisation</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"><span style="opacity: 0.5">Immunisation model</span></td></tr>
<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_bck11.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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation.header">header</a><a name="EHDSImmunisation.header"> </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"/><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"/></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_bck110.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.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-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation.header.subject">subject</a><a name="EHDSImmunisation.header.subject"> </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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element has obligations">O</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"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</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 style="opacity: 0.5; opacity: 0.5" href="StructureDefinition-EHDSPatient.html">EHDSPatient</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"><span style="opacity: 0.5">Patient/subject information</span><table class="obligation grid"><tr><td style="font-size: 11px"><b>Obligations</b></td><td style="font-size: 11px"><b>Actor</b></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-able-to-populate" title="Obligation Codes: be able to populate">able-to-populate</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-producer.html">Producer</a></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-display" title="Obligation Codes: display">display</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-consumer.html">Consumer</a></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-process" title="Obligation Codes: process">process</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-consumer.html">Consumer</a></td></tr></table></td></tr>
<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_bck100.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vline.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation.header.status">status</a><a name="EHDSImmunisation.header.status"> </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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element has obligations">O</span></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"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></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 style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#CodeableConcept">CodeableConcept</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"><span style="opacity: 0.5">Status of the immunisation event (completed, not-done).</span><table class="obligation grid"><tr><td style="font-size: 11px"><b>Obligations</b></td><td style="font-size: 11px"><b>Actor</b></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-able-to-populate" title="Obligation Codes: be able to populate">able-to-populate</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-producer.html">Producer</a></td></tr></table></td></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_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_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation.vaccine">vaccine</a><a name="EHDSImmunisation.vaccine"> </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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element has obligations">O</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"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</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 style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#CodeableConcept">CodeableConcept</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"><span style="opacity: 0.5">Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.</span><table class="obligation grid"><tr><td style="font-size: 11px"><b>Obligations</b></td><td style="font-size: 11px"><b>Actor</b></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-able-to-populate" title="Obligation Codes: be able to populate">able-to-populate</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-producer.html">Producer</a></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-display" title="Obligation Codes: display">display</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-consumer.html">Consumer</a></td></tr></table></td></tr>
<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_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_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-EHDSImmunisationLaboratoryObligations-definitions.html#EHDSImmunisation.administrationTime">administrationTime</a><a name="EHDSImmunisation.administrationTime"> </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"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element has obligations">O</span></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"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></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 style="opacity: 0.5; opacity: 0.5" href="http://hl7.org/fhir/R5/datatypes.html#dateTime">dateTime</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"><span style="opacity: 0.5">The date and optionally the exact time when the vaccination was administered.</span><table class="obligation grid"><tr><td style="font-size: 11px"><b>Obligations</b></td><td style="font-size: 11px"><b>Actor</b></td></tr><tr><td style="font-size: 11px"><b>SHALL</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-able-to-populate" title="Obligation Codes: be able to populate">able-to-populate</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-producer.html">Producer</a></td></tr><tr><td style="font-size: 11px"><b>SHOULD</b>:<a href="http://hl7.org/fhir/extensions/5.2.0/CodeSystem-obligation.html#obligation-display" title="Obligation Codes: display">display</a></td><td style="font-size: 11px; opacity: 0.5;"><a href="ActorDefinition-actor-consumer.html">Consumer</a></td></tr></table></td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<url
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations"/>
<version value="0.4.0"/>
<name value="EHDSImmunisationLaboratoryObligations"/>
<title value="Immunisation laboratory specific obligations"/>
<status value="draft"/>
<date value="2026-03-16T18:16:40+00:00"/>
<publisher value="Xt-EHR"/>
<contact>
<name value="Xt-EHR"/>
<telecom>
<system value="url"/>
<value value="http://www.xt-ehr.eu/"/>
</telecom>
</contact>
<description
value="Obligations for the logical model of immunisation in the scope of laboratory use case"/>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation"/>
<baseDefinition
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation"/>
<derivation value="constraint"/>
<snapshot>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
<valueString value="0.4.0"/>
</extension>
<element id="EHDSImmunisation">
<path value="EHDSImmunisation"/>
<short value="Immunisation model"/>
<definition
value="Model describes the administration of immunisation products, including vaccines and immunoglobulins, covering active and passive immunisations. It focuses on immunisation as a clinical procedure rather than the resulting immunity. The model supports routine immunisations at standard doses and may overlap with medication summaries or prescription lists. Natural immunity, immunisation outcomes, refusals, and administration or planning details are out of scope."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="EHDSImmunisation.header">
<path value="EHDSImmunisation.header"/>
<short value="Basic metadata for this information"/>
<definition value="Basic metadata for this information"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="Base"/>
</type>
</element>
<element id="EHDSImmunisation.header.subject">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="EHR systems SHALL provide information about the subject of care (patient)."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:process"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<path value="EHDSImmunisation.header.subject"/>
<short value="Patient/subject information"/>
<definition value="Patient/subject information"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header.subject"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"/>
</type>
</element>
<element id="EHDSImmunisation.header.identifier">
<path value="EHDSImmunisation.header.identifier"/>
<short
value="Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries)."/>
<definition
value="Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EHDSDataSet.header.identifier"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="Identifier"/>
</type>
</element>
<element id="EHDSImmunisation.header.author[x]">
<path value="EHDSImmunisation.header.author[x]"/>
<short value="The author of the immunisation statement."/>
<definition value="The author of the immunisation statement."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EHDSDataSet.header.author[x]"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"/>
</type>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"/>
</type>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice"/>
</type>
</element>
<element id="EHDSImmunisation.header.date">
<path value="EHDSImmunisation.header.date"/>
<short value="Date and optionally time of authoring/issuing"/>
<definition value="Date and optionally time of authoring/issuing"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header.date"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="dateTime"/>
</type>
</element>
<element id="EHDSImmunisation.header.status">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="Immunization status (e.g., “completed", "not-done") SHALL be provided."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<path value="EHDSImmunisation.header.status"/>
<short value="Status of the immunisation event (completed, not-done)."/>
<definition
value="Status of the immunisation event (completed, not-done)."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header.status"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
</element>
<element id="EHDSImmunisation.header.source">
<path value="EHDSImmunisation.header.source"/>
<short
value="Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information."/>
<definition
value="Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header.source"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
</element>
<element id="EHDSImmunisation.header.language">
<path value="EHDSImmunisation.header.language"/>
<short
value="Language in which the resource is written. Language is expressed by the IETF language tag."/>
<definition
value="Language in which the resource is written. Language is expressed by the IETF language tag."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSDataSet.header.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<binding>
<strength value="preferred"/>
<description value="BCP 47"/>
</binding>
</element>
<element id="EHDSImmunisation.diseaseOrAgentTargeted">
<path value="EHDSImmunisation.diseaseOrAgentTargeted"/>
<short
value="Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus)."/>
<definition
value="Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus)."/>
<min value="0"/>
<max value="*"/>
<base>
<path value="EHDSImmunisation.diseaseOrAgentTargeted"/>
<min value="0"/>
<max value="*"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<binding>
<strength value="preferred"/>
<description value="ICD-10, SNOMED CT"/>
</binding>
</element>
<element id="EHDSImmunisation.vaccine">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown value="Type of immunisation SHELL be provided."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<path value="EHDSImmunisation.vaccine"/>
<short
value="Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product."/>
<definition
value="Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.vaccine"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="CodeableConcept"/>
</type>
<binding>
<strength value="preferred"/>
<description value="SNOMED CT, ATC"/>
</binding>
</element>
<element id="EHDSImmunisation.administeredProduct">
<path value="EHDSImmunisation.administeredProduct"/>
<short
value="Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary."/>
<definition
value="Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.administeredProduct"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication"/>
</type>
</element>
<element id="EHDSImmunisation.administrationTime">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown value="Time of immunisation SHELL be provided."/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-source">
<valueCanonical
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|0.4.0"/>
</extension>
</extension>
<path value="EHDSImmunisation.administrationTime"/>
<short
value="The date and optionally the exact time when the vaccination was administered."/>
<definition
value="The date and optionally the exact time when the vaccination was administered."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.administrationTime"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="dateTime"/>
</type>
</element>
<element id="EHDSImmunisation.administeringCentre">
<path value="EHDSImmunisation.administeringCentre"/>
<short
value="Administering centre or a health authority responsible for the vaccination event"/>
<definition
value="Administering centre or a health authority responsible for the vaccination event"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.administeringCentre"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"/>
</type>
</element>
<element id="EHDSImmunisation.administrator">
<path value="EHDSImmunisation.administrator"/>
<short
value="Health professional responsible for administering the immunisation product."/>
<definition
value="Health professional responsible for administering the immunisation product."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.administrator"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code
value="http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"/>
</type>
</element>
<element id="EHDSImmunisation.note">
<path value="EHDSImmunisation.note"/>
<short
value="Any additional free-text information about the immunisation"/>
<definition
value="Any additional free-text information about the immunisation"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="EHDSImmunisation.note"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
</snapshot>
<differential>
<element id="EHDSImmunisation">
<path value="EHDSImmunisation"/>
</element>
<element id="EHDSImmunisation.header.subject">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="EHR systems SHALL provide information about the subject of care (patient)."/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved."/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:process"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused."/>
</extension>
</extension>
<path value="EHDSImmunisation.header.subject"/>
</element>
<element id="EHDSImmunisation.header.status">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown
value="Immunization status (e.g., “completed", "not-done") SHALL be provided."/>
</extension>
</extension>
<path value="EHDSImmunisation.header.status"/>
</element>
<element id="EHDSImmunisation.vaccine">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown value="Type of immunisation SHELL be provided."/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
</extension>
<path value="EHDSImmunisation.vaccine"/>
</element>
<element id="EHDSImmunisation.administrationTime">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:able-to-populate"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-producer"/>
</extension>
<extension url="documentation">
<valueMarkdown value="Time of immunisation SHELL be provided."/>
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHOULD:display"/>
</extension>
<extension url="actor">
<valueCanonical
value="https://www.xt-ehr.eu/specifications/fhir/actor-consumer"/>
</extension>
</extension>
<path value="EHDSImmunisation.administrationTime"/>
</element>
</differential>
</StructureDefinition>
IG © 2022+ Xt-EHR. Package xtehr.eu.ehds.models#0.4.0 based on FHIR 5.0.0. Generated 2026-03-16
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.
