{
"description": "MyHealth@EU refined base model for Immunisation information in EPS",
"_filename": "StructureDefinition-MyHealthEuImmunisationEps.json",
"package_name": "myhealth.eu.fhir.eps",
"date": "2026-07-16T20:17:46+02:00",
"derivation": "specialization",
"publisher": "MyHealth@Eu",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "150",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "Europe"
} ]
} ],
"name": "MyHealthEuImmunisationEps",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "Copyright European Union, represented by the European Commission - DG SANTE. Licenced under CC-BY-4.0.",
"type": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Immunisation model",
"package_version": "1.0.0-poc",
"snapshot": {
"element": [ {
"path": "MyHealthEuImmunisationEps",
"min": 0,
"definition": "MyHealth@EU refined base model for Immunisation information in EPS",
"isModifier": false,
"short": "Immunisation model",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "*",
"id": "MyHealthEuImmunisationEps",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"id": "MyHealthEuImmunisationEps.header",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EHDSDataSet.header"
},
"path": "MyHealthEuImmunisationEps.header",
"type": [ {
"code": "Base"
} ],
"short": "Basic metadata for this information",
"definition": "Basic metadata for this information"
}, {
"id": "MyHealthEuImmunisationEps.header.subject",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EHDSDataSet.header.subject"
},
"path": "MyHealthEuImmunisationEps.header.subject",
"type": [ {
"code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"
} ],
"short": "Patient/subject information",
"definition": "Patient/subject information"
}, {
"id": "MyHealthEuImmunisationEps.header.identifier",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSDataSet.header.identifier"
},
"path": "MyHealthEuImmunisationEps.header.identifier",
"type": [ {
"code": "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)."
}, {
"id": "MyHealthEuImmunisationEps.header.author[x]",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "EHDSDataSet.header.author[x]"
},
"path": "MyHealthEuImmunisationEps.header.author[x]",
"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"
} ],
"short": "The author of the immunisation statement.",
"definition": "The author of the immunisation statement."
}, {
"id": "MyHealthEuImmunisationEps.header.date",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSDataSet.header.date"
},
"path": "MyHealthEuImmunisationEps.header.date",
"type": [ {
"code": "dateTime"
} ],
"short": "Date and optionally time of authoring/issuing",
"definition": "Date and optionally time of authoring/issuing"
}, {
"id": "MyHealthEuImmunisationEps.header.status",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "EHDSDataSet.header.status"
},
"path": "MyHealthEuImmunisationEps.header.status",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Status of the immunisation event (completed, not-done).",
"definition": "Status of the immunisation event (completed, not-done)."
}, {
"id": "MyHealthEuImmunisationEps.header.source",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "EHDSDataSet.header.source"
},
"path": "MyHealthEuImmunisationEps.header.source",
"type": [ {
"code": "CodeableConcept"
} ],
"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."
}, {
"path": "MyHealthEuImmunisationEps.header.language",
"min": 0,
"definition": "Language in which the resource is written. Language is expressed by the IETF language tag.",
"short": "Language in which the resource is written. Language is expressed by the IETF language tag.",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "BCP 47"
},
"max": "1",
"id": "MyHealthEuImmunisationEps.header.language",
"base": {
"max": "1",
"min": 0,
"path": "EHDSDataSet.header.language"
}
}, {
"path": "MyHealthEuImmunisationEps.diseaseOrAgentTargeted",
"min": 0,
"definition": "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
"short": "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"binding": {
"strength": "preferred",
"description": "ICD-10, SNOMED CT"
},
"max": "*",
"id": "MyHealthEuImmunisationEps.diseaseOrAgentTargeted",
"base": {
"max": "*",
"min": 0,
"path": "EHDSImmunisation.diseaseOrAgentTargeted"
}
}, {
"path": "MyHealthEuImmunisationEps.vaccine",
"min": 1,
"definition": "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
"short": "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHOULD:handle"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"binding": {
"strength": "preferred",
"description": "SNOMED CT, ATC"
},
"max": "1",
"id": "MyHealthEuImmunisationEps.vaccine",
"base": {
"max": "1",
"min": 1,
"path": "EHDSImmunisation.vaccine"
}
}, {
"path": "MyHealthEuImmunisationEps.administeredProduct",
"min": 0,
"definition": "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
"short": "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
"type": [ {
"code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHOULD:handle"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.administeredProduct",
"base": {
"max": "1",
"min": 0,
"path": "EHDSImmunisation.administeredProduct"
}
}, {
"path": "MyHealthEuImmunisationEps.administrationTime",
"min": 1,
"definition": "The date and optionally the exact time when the vaccination was administered.",
"short": "The date and optionally the exact time when the vaccination was administered.",
"type": [ {
"code": "dateTime"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHOULD:handle"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.administrationTime",
"base": {
"max": "1",
"min": 1,
"path": "EHDSImmunisation.administrationTime"
}
}, {
"path": "MyHealthEuImmunisationEps.administeringCentre",
"min": 0,
"definition": "Administering centre or a health authority responsible for the vaccination event",
"short": "Administering centre or a health authority responsible for the vaccination event",
"type": [ {
"code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.administeringCentre",
"base": {
"max": "1",
"min": 0,
"path": "EHDSImmunisation.administeringCentre"
}
}, {
"path": "MyHealthEuImmunisationEps.administrator",
"min": 0,
"definition": "Health professional responsible for administering the immunisation product.",
"short": "Health professional responsible for administering the immunisation product.",
"type": [ {
"code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.administrator",
"base": {
"max": "1",
"min": 0,
"path": "EHDSImmunisation.administrator"
}
}, {
"path": "MyHealthEuImmunisationEps.note",
"min": 0,
"definition": "Any additional free-text information about the immunisation. It can be used for next vaccination date and dose number, among other details.",
"short": "Any additional free-text information about the immunisation",
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation|1.0.0"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.note",
"base": {
"max": "1",
"min": 0,
"path": "EHDSImmunisation.note"
}
}, {
"path": "MyHealthEuImmunisationEps.doseNumber",
"min": 0,
"definition": "Number in a series of vaccinations",
"short": "Number in a series of vaccinations",
"type": [ {
"code": "positiveInt"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps|1.0.0-poc"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.doseNumber",
"base": {
"max": "1",
"min": 0,
"path": "MyHealthEuImmunisationEps.doseNumber"
}
}, {
"path": "MyHealthEuImmunisationEps.countryOfVaccination",
"min": 0,
"definition": "Country of vaccination",
"short": "Country of vaccination",
"type": [ {
"code": "CodeableConcept"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
"valueCanonical": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps|1.0.0-poc"
} ]
} ],
"max": "1",
"id": "MyHealthEuImmunisationEps.countryOfVaccination",
"base": {
"max": "1",
"min": 0,
"path": "MyHealthEuImmunisationEps.countryOfVaccination"
}
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.0.0"
} ]
},
"status": "draft",
"id": "a7a25223-7115-4bb7-a681-195e42805895",
"kind": "logical",
"url": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps",
"version": "1.0.0-poc",
"differential": {
"element": [ {
"id": "MyHealthEuImmunisationEps",
"path": "MyHealthEuImmunisationEps",
"definition": "MyHealth@EU refined base model for Immunisation information in EPS"
}, {
"id": "MyHealthEuImmunisationEps.doseNumber",
"max": "1",
"min": 0,
"path": "MyHealthEuImmunisationEps.doseNumber",
"type": [ {
"code": "positiveInt"
} ],
"short": "Number in a series of vaccinations",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
} ]
} ],
"definition": "Number in a series of vaccinations"
}, {
"id": "MyHealthEuImmunisationEps.countryOfVaccination",
"max": "1",
"min": 0,
"path": "MyHealthEuImmunisationEps.countryOfVaccination",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Country of vaccination",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "MAY:able-to-populate"
}, {
"url": "actor",
"valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
} ]
} ],
"definition": "Country of vaccination"
} ]
},
"contact": [ {
"name": "MyHealth@Eu",
"telecom": [ {
"value": "https://health.ec.europa.eu/other-pages/basic-page/myhealtheu-flyer-addressed-patients-and-health-professionals_en",
"system": "url"
} ]
} ],
"baseDefinition": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation"
}