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

## Logical Model: EHDSImmunisation - JSON Profile

Draft as of 2026-02-23

JSON representation of the EHDSImmunisation logical model.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "EHDSImmunisation",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition EHDSImmunisation</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 &amp; 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-EHDSImmunisation-definitions.html#EHDSImmunisation\" title=\"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.\">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-EHDSDataSet.html\">EHDSDataSet</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\">Immunisation model<br/><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-EHDSDataSet.html\" title=\"Basic metadata for this information\">header</a></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_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-EHDSImmunisation-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>\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_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-EHDSImmunisation-definitions.html#EHDSImmunisation.header.author[x]\" title=\"The author of the immunisation statement.\">author[x]</a><a name=\"EHDSImmunisation.header.author_x_\"> </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 style=\"opacity: 0.5; opacity: 0.5\" href=\"StructureDefinition-EHDSHealthProfessional.html\">EHDSHealthProfessional</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5; opacity: 0.5\" href=\"StructureDefinition-EHDSOrganisation.html\">EHDSOrganisation</a><span style=\"opacity: 0.5\">, </span><a style=\"opacity: 0.5; opacity: 0.5\" href=\"StructureDefinition-EHDSDevice.html\">EHDSDevice</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 author of the immunisation statement.</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_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-EHDSImmunisation-definitions.html#EHDSImmunisation.header.status\" title=\"Status of the immunisation event (completed, not-done).\">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\"/><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\">Status of the immunisation event (completed, not-done).</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_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-EHDSImmunisation-definitions.html#EHDSImmunisation.diseaseOrAgentTargeted\" title=\"Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).\">diseaseOrAgentTargeted</a><a name=\"EHDSImmunisation.diseaseOrAgentTargeted\"> </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=\"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\">Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).<br class=\"binding\"/><span style=\"font-weight:bold\" title=\"null\" class=\"binding\">Binding Description: </span><span title=\"null\" class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\" class=\"binding\">preferred</a><span title=\"null\" class=\"binding\">)</span><span title=\"null\" class=\"binding\">: </span><span title=\"null\" class=\"binding\">ICD-10, SNOMED CT</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_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-EHDSImmunisation-definitions.html#EHDSImmunisation.vaccine\" title=\"Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.\">vaccine</a><a name=\"EHDSImmunisation.vaccine\"> </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=\"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\">Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.<br class=\"binding\"/><span style=\"font-weight:bold\" title=\"null\" class=\"binding\">Binding Description: </span><span title=\"null\" class=\"binding\"> (</span><a href=\"http://hl7.org/fhir/R5/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\" class=\"binding\">preferred</a><span title=\"null\" class=\"binding\">)</span><span title=\"null\" class=\"binding\">: </span><span title=\"null\" class=\"binding\">SNOMED CT, ATC</span></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-EHDSImmunisation-definitions.html#EHDSImmunisation.administeredProduct\" title=\"Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.\">administeredProduct</a><a name=\"EHDSImmunisation.administeredProduct\"> </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-EHDSMedication.html\">EHDSMedication</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\">Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.</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_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-EHDSImmunisation-definitions.html#EHDSImmunisation.administrationTime\" title=\"The date and optionally the exact time when the vaccination was administered.\">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\"/><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=\"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\">The date and optionally the exact time when the vaccination was administered.</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-EHDSImmunisation-definitions.html#EHDSImmunisation.administeringCentre\" title=\"Administering centre or a health authority responsible for the vaccination event\">administeringCentre</a><a name=\"EHDSImmunisation.administeringCentre\"> </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-EHDSOrganisation.html\">EHDSOrganisation</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\">Administering centre or a health authority responsible for the vaccination event</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-EHDSImmunisation-definitions.html#EHDSImmunisation.administrator\" title=\"Health professional responsible for administering the immunisation product.\">administrator</a><a name=\"EHDSImmunisation.administrator\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-EHDSHealthProfessional.html\">EHDSHealthProfessional</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\">Health professional responsible for administering the immunisation product.</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_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-EHDSImmunisation-definitions.html#EHDSImmunisation.note\" title=\"Any additional free-text information about the immunisation\">note</a><a name=\"EHDSImmunisation.note\"> </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=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</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\">Any additional free-text information about the immunisation</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>"
      },
      "url" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation",
      "version" : "0.4.0",
      "name" : "EHDSImmunisation",
      "title" : "Immunisation model",
      "status" : "draft",
      "date" : "2026-02-23T14:01:37+00:00",
      "publisher" : "Xt-EHR",
      "contact" : [
        {
          "name" : "Xt-EHR",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.xt-ehr.eu/"
            }
          ]
        }
      ],
      "description" : "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.",
      "fhirVersion" : "5.0.0",
      "mapping" : [
        {
          "identity" : "rim",
          "uri" : "http://hl7.org/v3",
          "name" : "RIM Mapping"
        }
      ],
      "kind" : "logical",
      "abstract" : false,
      "type" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation",
      "baseDefinition" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDataSet",
      "derivation" : "specialization",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "0.4.0"
          }
        ],
        "element" : [
          {
            "id" : "EHDSImmunisation",
            "path" : "EHDSImmunisation",
            "short" : "Immunisation model",
            "definition" : "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" : 0,
            "max" : "*",
            "base" : {
              "path" : "Base",
              "min" : 0,
              "max" : "*"
            },
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header",
            "path" : "EHDSImmunisation.header",
            "short" : "Basic metadata for this information",
            "definition" : "Basic metadata for this information",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "Base"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.subject",
            "path" : "EHDSImmunisation.header.subject",
            "short" : "Patient/subject information",
            "definition" : "Patient/subject information",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header.subject",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.identifier",
            "path" : "EHDSImmunisation.header.identifier",
            "short" : "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
            "definition" : "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EHDSDataSet.header.identifier",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "Identifier"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.author[x]",
            "path" : "EHDSImmunisation.header.author[x]",
            "short" : "The author of the immunisation statement.",
            "definition" : "The author of the immunisation statement.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EHDSDataSet.header.author[x]",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
              },
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
              },
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.date",
            "path" : "EHDSImmunisation.header.date",
            "short" : "Date and optionally time of authoring/issuing",
            "definition" : "Date and optionally time of authoring/issuing",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header.date",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "dateTime"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.status",
            "path" : "EHDSImmunisation.header.status",
            "short" : "Status of the immunisation event (completed, not-done).",
            "definition" : "Status of the immunisation event (completed, not-done).",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header.status",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.source",
            "path" : "EHDSImmunisation.header.source",
            "short" : "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" : "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" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header.source",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.header.language",
            "path" : "EHDSImmunisation.header.language",
            "short" : "Language in which the resource is written. Language is expressed by the IETF language tag.",
            "definition" : "Language in which the resource is written. Language is expressed by the IETF language tag.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSDataSet.header.language",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ],
            "binding" : {
              "strength" : "preferred",
              "description" : "BCP 47"
            }
          },
          {
            "id" : "EHDSImmunisation.diseaseOrAgentTargeted",
            "path" : "EHDSImmunisation.diseaseOrAgentTargeted",
            "short" : "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
            "definition" : "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "EHDSImmunisation.diseaseOrAgentTargeted",
              "min" : 0,
              "max" : "*"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ],
            "binding" : {
              "strength" : "preferred",
              "description" : "ICD-10, SNOMED CT"
            }
          },
          {
            "id" : "EHDSImmunisation.vaccine",
            "path" : "EHDSImmunisation.vaccine",
            "short" : "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
            "definition" : "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.vaccine",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ],
            "binding" : {
              "strength" : "preferred",
              "description" : "SNOMED CT, ATC"
            }
          },
          {
            "id" : "EHDSImmunisation.administeredProduct",
            "path" : "EHDSImmunisation.administeredProduct",
            "short" : "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
            "definition" : "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.administeredProduct",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administrationTime",
            "path" : "EHDSImmunisation.administrationTime",
            "short" : "The date and optionally the exact time when the vaccination was administered.",
            "definition" : "The date and optionally the exact time when the vaccination was administered.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.administrationTime",
              "min" : 1,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "dateTime"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administeringCentre",
            "path" : "EHDSImmunisation.administeringCentre",
            "short" : "Administering centre or a health authority responsible for the vaccination event",
            "definition" : "Administering centre or a health authority responsible for the vaccination event",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.administeringCentre",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administrator",
            "path" : "EHDSImmunisation.administrator",
            "short" : "Health professional responsible for administering the immunisation product.",
            "definition" : "Health professional responsible for administering the immunisation product.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.administrator",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.note",
            "path" : "EHDSImmunisation.note",
            "short" : "Any additional free-text information about the immunisation",
            "definition" : "Any additional free-text information about the immunisation",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "EHDSImmunisation.note",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "string"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "EHDSImmunisation",
            "path" : "EHDSImmunisation",
            "short" : "Immunisation model",
            "definition" : "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."
          },
          {
            "id" : "EHDSImmunisation.header.author[x]",
            "path" : "EHDSImmunisation.header.author[x]",
            "short" : "The author of the immunisation statement.",
            "definition" : "The author of the immunisation statement."
          },
          {
            "id" : "EHDSImmunisation.header.status",
            "path" : "EHDSImmunisation.header.status",
            "short" : "Status of the immunisation event (completed, not-done).",
            "definition" : "Status of the immunisation event (completed, not-done)."
          },
          {
            "id" : "EHDSImmunisation.diseaseOrAgentTargeted",
            "path" : "EHDSImmunisation.diseaseOrAgentTargeted",
            "short" : "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
            "definition" : "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
            "min" : 0,
            "max" : "*",
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ],
            "binding" : {
              "strength" : "preferred",
              "description" : "ICD-10, SNOMED CT"
            }
          },
          {
            "id" : "EHDSImmunisation.vaccine",
            "path" : "EHDSImmunisation.vaccine",
            "short" : "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
            "definition" : "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "CodeableConcept"
              }
            ],
            "binding" : {
              "strength" : "preferred",
              "description" : "SNOMED CT, ATC"
            }
          },
          {
            "id" : "EHDSImmunisation.administeredProduct",
            "path" : "EHDSImmunisation.administeredProduct",
            "short" : "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
            "definition" : "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
            "min" : 0,
            "max" : "1",
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administrationTime",
            "path" : "EHDSImmunisation.administrationTime",
            "short" : "The date and optionally the exact time when the vaccination was administered.",
            "definition" : "The date and optionally the exact time when the vaccination was administered.",
            "min" : 1,
            "max" : "1",
            "type" : [
              {
                "code" : "dateTime"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administeringCentre",
            "path" : "EHDSImmunisation.administeringCentre",
            "short" : "Administering centre or a health authority responsible for the vaccination event",
            "definition" : "Administering centre or a health authority responsible for the vaccination event",
            "min" : 0,
            "max" : "1",
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.administrator",
            "path" : "EHDSImmunisation.administrator",
            "short" : "Health professional responsible for administering the immunisation product.",
            "definition" : "Health professional responsible for administering the immunisation product.",
            "min" : 0,
            "max" : "1",
            "type" : [
              {
                "code" : "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
              }
            ]
          },
          {
            "id" : "EHDSImmunisation.note",
            "path" : "EHDSImmunisation.note",
            "short" : "Any additional free-text information about the immunisation",
            "definition" : "Any additional free-text information about the immunisation",
            "min" : 0,
            "max" : "1",
            "type" : [
              {
                "code" : "string"
              }
            ]
          }
        ]
      }
    }