| Package | hl7.fhir.eu.imaging-r5 |
| Type | StructureDefinition |
| Id | EHDSImmunization |
| FHIR Version | R5 |
| Source | http://hl7.eu/fhir/imaging-r5/https://build.fhir.org/ig/hl7-eu/imaging/StructureDefinition-EHDSImmunization.html |
| URL | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunization |
| Version | 0.1.0 |
| Status | draft |
| Date | 2025-03-21T08:17:12+00:00 |
| Name | EHDSImmunization |
| Title | Immunization model |
| Realm | eu |
| Authority | hl7 |
| Description | C.24 - EHDS refined base model for Immunization |
| Copyright | Used by permission of HL7 Europe, all rights reserved Creative Commons License |
| Type | https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunization |
| Kind | logical |
| StructureDefinition | |
| EHDSLaboratoryOrderBody | Laboratory order body model |
| EHDSLaboratoryReportBody | Laboratory report body model |
| EHDSPatientSummaryBody | Patient summary body model |
| EHDSLaboratoryOrderBody | Laboratory order body model |
| EHDSLaboratoryReportBody | Laboratory report body model |
| EHDSPatientSummaryBody | Patient summary body model |
| StructureDefinition | |
| EHDSHealthProfessional | Health professional model |
| EHDSMedication | Medicinal product model |
| EHDSOrganization | Organization model |
| EHDSPatient | Patient model |
| EHDSHealthProfessional | Health professional model |
| EHDSMedication | Medicinal product model |
| EHDSOrganization | Organization model |
| EHDSPatient | Patient model |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EHDSImmunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EHDSImmunization | 0..* | Base | Immunization model Instances of this logical model can be the target of a Reference | |
  identifier | 0..* | Identifier | C.24.1 - Identifier | |
| status | 1..1 | CodeableConcept | C.24.2 - Status | |
| diseaseOrAgentTargeted | 0..* | CodeableConcept | C.24.3 - Disease or agent targeted Binding Description: (preferred): ICD-10*, SNOMED CT | |
| vaccine | 1..1 | CodeableConcept | C.24.4 - Vaccine Binding Description: (preferred): SNOMED CT, ATC (IDMP/ EMA SPOR SMS) | |
 administeredProduct | 0..1 | EHDSMedication | C.24.5 - Administered product | |
 doseNumber | 0..1 | integer64 | C.24.7 - Number in a series of vaccinations / doses | |
| batchNumber | 0..* | string | C.24.8 - Batch number | |
| dateOfVaccination | 1..1 | date | C.24.9 - Date of vaccination | |
| administeringCentre | 0..* | EHDSOrganization | C.24.10 - Administering centre | |
| healthProfessionalIdentification | 0..* | EHDSHealthProfessional | C.24.11 - Health Professional identification | |
| countryOfVaccination | 0..1 | CodeableConcept | C.24.12 - Country of vaccination Binding Description: (preferred): ISO 3166 | |
| nextVaccinationDate | 0..1 | date | C.24.13 - Next vaccination date | |
  subject | 1..1 | Reference(Patient model) | C.24.14 - Subject | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "EHDSImmunization",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
}
],
"url": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunization",
"version": "0.1.0",
"name": "EHDSImmunization",
"title": "Immunization model",
"status": "draft",
"date": "2025-03-21T08:17:12+00:00",
"publisher": "HL7 Europe",
"contact": [
{
"name": "Xt-EHR",
"telecom": [
{
"system": "url",
"value": "http://Xt-EHR.eu"
}
]
}
],
"description": "C.24 - EHDS refined base model for Immunization",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "150",
"display": "Europe"
}
]
}
],
"copyright": "Used by permission of HL7 Europe, all rights reserved Creative Commons License",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSImmunization",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "EHDSImmunization",
"path": "EHDSImmunization",
"short": "Immunization model",
"definition": "C.24 - EHDS refined base model for Immunization",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "EHDSImmunization.identifier",
"path": "EHDSImmunization.identifier",
"short": "C.24.1 - Identifier",
"definition": "Immunization identifier",
"min": 0,
"max": "*",
"base": {
"path": "EHDSImmunization.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "EHDSImmunization.status",
"path": "EHDSImmunization.status",
"short": "C.24.2 - Status",
"definition": "Indicates the current status of the immunization event (completed, not-done).",
"min": 1,
"max": "1",
"base": {
"path": "EHDSImmunization.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "EHDSImmunization.diseaseOrAgentTargeted",
"path": "EHDSImmunization.diseaseOrAgentTargeted",
"short": "C.24.3 - Disease or agent targeted",
"definition": "Disease or agent that the vaccination provides protection against.",
"min": 0,
"max": "*",
"base": {
"path": "EHDSImmunization.diseaseOrAgentTargeted",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "ICD-10*, SNOMED CT"
}
},
{
"id": "EHDSImmunization.vaccine",
"path": "EHDSImmunization.vaccine",
"short": "C.24.4 - Vaccine",
"definition": "Generic description of the vaccine/prophylaxis or its component(s).",
"min": 1,
"max": "1",
"base": {
"path": "EHDSImmunization.vaccine",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "SNOMED CT, ATC (IDMP/ EMA SPOR SMS)"
}
},
{
"id": "EHDSImmunization.administeredProduct",
"path": "EHDSImmunization.administeredProduct",
"short": "C.24.5 - Administered product",
"definition": "Medicinal product administered.",
"min": 0,
"max": "1",
"base": {
"path": "EHDSImmunization.administeredProduct",
"min": 0,
"max": "1"
},
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication"
}
]
},
{
"id": "EHDSImmunization.doseNumber",
"path": "EHDSImmunization.doseNumber",
"short": "C.24.7 - Number in a series of vaccinations / doses",
"definition": "Order in the vaccination course.",
"min": 0,
"max": "1",
"base": {
"path": "EHDSImmunization.doseNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer64"
}
]
},
{
"id": "EHDSImmunization.batchNumber",
"path": "EHDSImmunization.batchNumber",
"short": "C.24.8 - Batch number",
"definition": "A distinctive combination of numbers and/or letters which specifically identifies a batch.",
"min": 0,
"max": "*",
"base": {
"path": "EHDSImmunization.batchNumber",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "EHDSImmunization.dateOfVaccination",
"path": "EHDSImmunization.dateOfVaccination",
"short": "C.24.9 - Date of vaccination",
"definition": "The date and time when the vaccination was administered",
"min": 1,
"max": "1",
"base": {
"path": "EHDSImmunization.dateOfVaccination",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "EHDSImmunization.administeringCentre",
"path": "EHDSImmunization.administeringCentre",
"short": "C.24.10 - Administering centre",
"definition": "Name/code of administering centre or a health authority responsible for the vaccination event",
"min": 0,
"max": "*",
"base": {
"path": "EHDSImmunization.administeringCentre",
"min": 0,
"max": "*"
},
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization"
}
]
},
{
"id": "EHDSImmunization.healthProfessionalIdentification",
"path": "EHDSImmunization.healthProfessionalIdentification",
"short": "C.24.11 - Health Professional identification",
"definition": "Name or health professional code responsible for administering the vaccine or prophylaxis",
"min": 0,
"max": "*",
"base": {
"path": "EHDSImmunization.healthProfessionalIdentification",
"min": 0,
"max": "*"
},
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional"
}
]
},
{
"id": "EHDSImmunization.countryOfVaccination",
"path": "EHDSImmunization.countryOfVaccination",
"short": "C.24.12 - Country of vaccination",
"definition": "The country in which the individual has been vaccinated",
"min": 0,
"max": "1",
"base": {
"path": "EHDSImmunization.countryOfVaccination",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "ISO 3166"
}
},
{
"id": "EHDSImmunization.nextVaccinationDate",
"path": "EHDSImmunization.nextVaccinationDate",
"short": "C.24.13 - Next vaccination date",
"definition": "The date when the vaccination is planned to be given/repeated (e.g. next dose)",
"min": 0,
"max": "1",
"base": {
"path": "EHDSImmunization.nextVaccinationDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "EHDSImmunization.subject",
"path": "EHDSImmunization.subject",
"short": "C.24.14 - Subject",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"base": {
"path": "EHDSImmunization.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "EHDSImmunization",
"path": "EHDSImmunization",
"short": "Immunization model",
"definition": "C.24 - EHDS refined base model for Immunization"
},
{
"id": "EHDSImmunization.identifier",
"path": "EHDSImmunization.identifier",
"short": "C.24.1 - Identifier",
"definition": "Immunization identifier",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "EHDSImmunization.status",
"path": "EHDSImmunization.status",
"short": "C.24.2 - Status",
"definition": "Indicates the current status of the immunization event (completed, not-done).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "EHDSImmunization.diseaseOrAgentTargeted",
"path": "EHDSImmunization.diseaseOrAgentTargeted",
"short": "C.24.3 - Disease or agent targeted",
"definition": "Disease or agent that the vaccination provides protection against.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "ICD-10*, SNOMED CT"
}
},
{
"id": "EHDSImmunization.vaccine",
"path": "EHDSImmunization.vaccine",
"short": "C.24.4 - Vaccine",
"definition": "Generic description of the vaccine/prophylaxis or its component(s).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "SNOMED CT, ATC (IDMP/ EMA SPOR SMS)"
}
},
{
"id": "EHDSImmunization.administeredProduct",
"path": "EHDSImmunization.administeredProduct",
"short": "C.24.5 - Administered product",
"definition": "Medicinal product administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSMedication"
}
]
},
{
"id": "EHDSImmunization.doseNumber",
"path": "EHDSImmunization.doseNumber",
"short": "C.24.7 - Number in a series of vaccinations / doses",
"definition": "Order in the vaccination course.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer64"
}
]
},
{
"id": "EHDSImmunization.batchNumber",
"path": "EHDSImmunization.batchNumber",
"short": "C.24.8 - Batch number",
"definition": "A distinctive combination of numbers and/or letters which specifically identifies a batch.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "EHDSImmunization.dateOfVaccination",
"path": "EHDSImmunization.dateOfVaccination",
"short": "C.24.9 - Date of vaccination",
"definition": "The date and time when the vaccination was administered",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "EHDSImmunization.administeringCentre",
"path": "EHDSImmunization.administeringCentre",
"short": "C.24.10 - Administering centre",
"definition": "Name/code of administering centre or a health authority responsible for the vaccination event",
"min": 0,
"max": "*",
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization"
}
]
},
{
"id": "EHDSImmunization.healthProfessionalIdentification",
"path": "EHDSImmunization.healthProfessionalIdentification",
"short": "C.24.11 - Health Professional identification",
"definition": "Name or health professional code responsible for administering the vaccine or prophylaxis",
"min": 0,
"max": "*",
"type": [
{
"code": "https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional"
}
]
},
{
"id": "EHDSImmunization.countryOfVaccination",
"path": "EHDSImmunization.countryOfVaccination",
"short": "C.24.12 - Country of vaccination",
"definition": "The country in which the individual has been vaccinated",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"description": "ISO 3166"
}
},
{
"id": "EHDSImmunization.nextVaccinationDate",
"path": "EHDSImmunization.nextVaccinationDate",
"short": "C.24.13 - Next vaccination date",
"definition": "The date when the vaccination is planned to be given/repeated (e.g. next dose)",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "EHDSImmunization.subject",
"path": "EHDSImmunization.subject",
"short": "C.24.14 - Subject",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient"
]
}
]
}
]
}
}