FHIR IG analytics| Package | xtehr.eu.ehds.models |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-EHDSImmunisation.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/Xt-EHR/xt-ehr-common/StructureDefinition-EHDSImmunisation.html |
| URL | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation |
| Version | 0.2.1 |
| Status | draft |
| Date | 2026-02-04T19:00:50+00:00 |
| Name | EHDSImmunisation |
| Title | Immunisation model |
| 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. |
| Type | http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation |
| Kind | logical |
| StructureDefinition | |
| EHDSLaboratoryReport | Laboratory report model |
| EHDSPatientSummary | Patient summary model |
| StructureDefinition | |
| EHDSDataSet | DataSet model |
| EHDSHealthProfessional | Health professional model |
| EHDSMedication | Medication model |
| EHDSOrganisation | Organisation model |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EHDSImmunisation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EHDSImmunisation | 0..* | EHDSDataSet | Immunisation model Elements defined in Ancestors:header Instances of this logical model can be the target of a Reference | |
 header | ||||
 author[x] | 0..* | EHDSHealthProfessional, EHDSOrganisation, EHDSDevice | The author of the immunisation statement. | |
 status | 1..1 | CodeableConcept | Status of the immunisation event (completed, not-done). | |
 diseaseOrAgentTargeted | 0..* | CodeableConcept | Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus). Binding Description: (preferred): ICD-10, SNOMED CT | |
| vaccine | 1..1 | CodeableConcept | Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Binding Description: (preferred): SNOMED CT, ATC | |
 administeredProduct | 0..1 | EHDSMedication | Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. | |
 administrationTime | 1..1 | dateTime | The date and optionally the exact time when the vaccination was administered. | |
| administeringCentre | 0..1 | EHDSOrganisation | Administering centre or a health authority responsible for the vaccination event | |
| administrator | 0..1 | EHDSHealthProfessional | Health professional responsible for administering the immunisation product. | |
| note | 0..1 | string | Any additional free-text information about the immunisation | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "EHDSImmunisation",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
}
],
"url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation",
"version": "0.2.1",
"name": "EHDSImmunisation",
"title": "Immunisation model",
"status": "draft",
"date": "2026-02-04T19:00:50+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.2.1"
}
],
"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"
}
]
}
]
}
}