MyHealth@EU Core
1.0.0 - trial-use 150

This page is part of the MyHealth@Eu Core (v1.0.0: Wave 9) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: MyHealthEuImmunisation - Detailed Descriptions

Active as of 2026-05-04

Definitions for the MyHealthEuImmunisation logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. MyHealthEuImmunisation
Definition

MyHealth@EU refined model for immunisation

ShortImmunisation model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MyHealthEuImmunisation.header
Definition

Basic metadata for this information

ShortBasic metadata for this information
Control1..1
TypeBase
4. MyHealthEuImmunisation.header.subject
Definition

Patient/subject information

ShortPatient/subject information
Control1..1
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. MyHealthEuImmunisation.header.identifier
Definition

Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).

ShortBusiness identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
8. MyHealthEuImmunisation.header.author[x]
Definition

The author of the immunisation statement.

ShortThe author of the immunisation statement.
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. MyHealthEuImmunisation.header.date
Definition

Date and optionally time of authoring/issuing

ShortDate and optionally time of authoring/issuing
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. MyHealthEuImmunisation.header.status
Definition

Status of the immunisation event (completed, not-done).

ShortStatus of the immunisation event (completed, not-done).
Control1..1
TypeCodeableConcept
14. MyHealthEuImmunisation.header.source
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.

ShortSource 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.
Control0..1
TypeCodeableConcept
16. MyHealthEuImmunisation.header.language
Definition

Language in which the resource is written. Language is expressed by the IETF language tag.

ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
Control0..1
Binding

BCP 47

TypeCodeableConcept
18. MyHealthEuImmunisation.diseaseOrAgentTargeted
Definition

Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).

ShortDisease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
Control0..*
Binding

ICD-10, SNOMED CT

TypeCodeableConcept
Obligations
    ObligationsActor
    MAY:able-to-populateMyHealth@EU Handler
    20. MyHealthEuImmunisation.vaccine
    Definition

    Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.

    ShortType of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
    Control1..1
    Binding

    SNOMED CT, ATC

    TypeCodeableConcept
    Obligations
      ObligationsActor
      SHOULD:handleMyHealth@EU Handler
      22. MyHealthEuImmunisation.administeredProduct
      Definition

      Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.

      ShortAdministered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
      Control0..1
      Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication
      Obligations
        ObligationsActor
        SHOULD:handleMyHealth@EU Handler
        24. MyHealthEuImmunisation.administrationTime
        Definition

        The date and optionally the exact time when the vaccination was administered.

        ShortThe date and optionally the exact time when the vaccination was administered.
        Control1..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Obligations
          ObligationsActor
          SHOULD:handleMyHealth@EU Handler
          26. MyHealthEuImmunisation.administeringCentre
          Definition

          Administering centre or a health authority responsible for the vaccination event

          ShortAdministering centre or a health authority responsible for the vaccination event
          Control0..1
          Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation
          Obligations
            ObligationsActor
            MAY:able-to-populateMyHealth@EU Handler
            28. MyHealthEuImmunisation.administrator
            Definition

            Health professional responsible for administering the immunisation product.

            ShortHealth professional responsible for administering the immunisation product.
            Control0..1
            Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional
            Obligations
              ObligationsActor
              MAY:able-to-populateMyHealth@EU Handler
              30. MyHealthEuImmunisation.note
              Definition

              Any additional free-text information about the immunisation. It can be used for next vaccination date and dose number, among other details.

              ShortAny additional free-text information about the immunisation
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Obligations
                ObligationsActor
                MAY:able-to-populateMyHealth@EU Handler

                Guidance on how to interpret the contents of this table can be foundhere

                0. MyHealthEuImmunisation
                Definition

                MyHealth@EU refined model for immunisation

                Logical ModelInstances of this logical model are not marked to be the target of a Reference
                2. MyHealthEuImmunisation.diseaseOrAgentTargeted
                Obligations
                  ObligationsActor
                  MAY:able-to-populateMyHealth@EU Handler
                  4. MyHealthEuImmunisation.vaccine
                  Obligations
                    ObligationsActor
                    SHOULD:handleMyHealth@EU Handler
                    6. MyHealthEuImmunisation.administeredProduct
                    Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication
                    Obligations
                      ObligationsActor
                      SHOULD:handleMyHealth@EU Handler
                      8. MyHealthEuImmunisation.administrationTime
                      Obligations
                        ObligationsActor
                        SHOULD:handleMyHealth@EU Handler
                        10. MyHealthEuImmunisation.administeringCentre
                        Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation
                        Obligations
                          ObligationsActor
                          MAY:able-to-populateMyHealth@EU Handler
                          12. MyHealthEuImmunisation.administrator
                          Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional
                          Obligations
                            ObligationsActor
                            MAY:able-to-populateMyHealth@EU Handler
                            14. MyHealthEuImmunisation.note
                            Definition

                            Any additional free-text information about the immunisation. It can be used for next vaccination date and dose number, among other details.

                            Obligations
                              ObligationsActor
                              MAY:able-to-populateMyHealth@EU Handler

                              Guidance on how to interpret the contents of this table can be foundhere

                              0. MyHealthEuImmunisation
                              Definition

                              MyHealth@EU refined model for immunisation

                              ShortImmunisation model
                              Control0..*
                              Is Modifierfalse
                              Logical ModelInstances of this logical model are not marked to be the target of a Reference
                              2. MyHealthEuImmunisation.header
                              Definition

                              Basic metadata for this information

                              ShortBasic metadata for this information
                              Control1..1
                              TypeBase
                              4. MyHealthEuImmunisation.header.subject
                              Definition

                              Patient/subject information

                              ShortPatient/subject information
                              Control1..1
                              Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
                              6. MyHealthEuImmunisation.header.identifier
                              Definition

                              Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).

                              ShortBusiness identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control0..*
                              TypeIdentifier
                              8. MyHealthEuImmunisation.header.author[x]
                              Definition

                              The author of the immunisation statement.

                              ShortThe author of the immunisation statement.
                              Control0..*
                              TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              10. MyHealthEuImmunisation.header.date
                              Definition

                              Date and optionally time of authoring/issuing

                              ShortDate and optionally time of authoring/issuing
                              Control0..1
                              TypedateTime
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              12. MyHealthEuImmunisation.header.status
                              Definition

                              Status of the immunisation event (completed, not-done).

                              ShortStatus of the immunisation event (completed, not-done).
                              Control1..1
                              TypeCodeableConcept
                              14. MyHealthEuImmunisation.header.source
                              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.

                              ShortSource 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.
                              Control0..1
                              TypeCodeableConcept
                              16. MyHealthEuImmunisation.header.language
                              Definition

                              Language in which the resource is written. Language is expressed by the IETF language tag.

                              ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
                              Control0..1
                              Binding

                              BCP 47

                              TypeCodeableConcept
                              18. MyHealthEuImmunisation.diseaseOrAgentTargeted
                              Definition

                              Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).

                              ShortDisease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
                              Control0..*
                              Binding

                              ICD-10, SNOMED CT

                              TypeCodeableConcept
                              Obligations
                                ObligationsActor
                                MAY:able-to-populateMyHealth@EU Handler
                                20. MyHealthEuImmunisation.vaccine
                                Definition

                                Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.

                                ShortType of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
                                Control1..1
                                Binding

                                SNOMED CT, ATC

                                TypeCodeableConcept
                                Obligations
                                  ObligationsActor
                                  SHOULD:handleMyHealth@EU Handler
                                  22. MyHealthEuImmunisation.administeredProduct
                                  Definition

                                  Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.

                                  ShortAdministered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
                                  Control0..1
                                  Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication
                                  Obligations
                                    ObligationsActor
                                    SHOULD:handleMyHealth@EU Handler
                                    24. MyHealthEuImmunisation.administrationTime
                                    Definition

                                    The date and optionally the exact time when the vaccination was administered.

                                    ShortThe date and optionally the exact time when the vaccination was administered.
                                    Control1..1
                                    TypedateTime
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Obligations
                                      ObligationsActor
                                      SHOULD:handleMyHealth@EU Handler
                                      26. MyHealthEuImmunisation.administeringCentre
                                      Definition

                                      Administering centre or a health authority responsible for the vaccination event

                                      ShortAdministering centre or a health authority responsible for the vaccination event
                                      Control0..1
                                      Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation
                                      Obligations
                                        ObligationsActor
                                        MAY:able-to-populateMyHealth@EU Handler
                                        28. MyHealthEuImmunisation.administrator
                                        Definition

                                        Health professional responsible for administering the immunisation product.

                                        ShortHealth professional responsible for administering the immunisation product.
                                        Control0..1
                                        Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional
                                        Obligations
                                          ObligationsActor
                                          MAY:able-to-populateMyHealth@EU Handler
                                          30. MyHealthEuImmunisation.note
                                          Definition

                                          Any additional free-text information about the immunisation. It can be used for next vaccination date and dose number, among other details.

                                          ShortAny additional free-text information about the immunisation
                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Obligations
                                            ObligationsActor
                                            MAY:able-to-populateMyHealth@EU Handler