FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagemyhealth.eu.fhir.core
Resource TypeStructureDefinition
IdStructureDefinition-MyHealthEuImmunisation.json
FHIR VersionR4
Sourcehttp://fhir.ehdsi.eu/core/1.0.0/StructureDefinition-MyHealthEuImmunisation.html
URLhttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation
Version1.0.0
Statusactive
Date2026-05-04T15:59:03+02:00
NameMyHealthEuImmunisation
TitleImmunisation model
Realmeu
DescriptionMyHealth@EU refined model for immunisation
Typehttp://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation
Kindlogical

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
myhealth.eu.fhir.core#1.0.0MyHealthEuHealthProfessionalHealth professional model
myhealth.eu.fhir.core#1.0.0MyHealthEuMedicationMedication model
myhealth.eu.fhir.core#1.0.0MyHealthEuOrganisationOrganisation model
xtehr.eu.ehds.models#currentEHDSImmunisationImmunisation model

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition MyHealthEuImmunisation

NameFlagsCard.TypeDescription & Constraintsdoco
.. MyHealthEuImmunisation 0..*EHDSImmunisationImmunisation model

Elements defined in Ancestors:header, diseaseOrAgentTargeted, vaccine, administeredProduct, administrationTime, administeringCentre, administrator, note
... diseaseOrAgentTargeted O0..*CodeableConceptDisease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
ObligationsActor
MAY:able-to-populateMyHealth@EU Handler
... vaccine O1..1CodeableConceptType of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
ObligationsActor
SHOULD:handleMyHealth@EU Handler
... administeredProduct O0..1MyHealthEuMedicationAdministered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
ObligationsActor
SHOULD:handleMyHealth@EU Handler
... administrationTime O1..1dateTimeThe date and optionally the exact time when the vaccination was administered.
ObligationsActor
SHOULD:handleMyHealth@EU Handler
... administeringCentre O0..1MyHealthEuOrganisationAdministering centre or a health authority responsible for the vaccination event
ObligationsActor
MAY:able-to-populateMyHealth@EU Handler
... administrator O0..1MyHealthEuHealthProfessionalHealth professional responsible for administering the immunisation product.
ObligationsActor
MAY:able-to-populateMyHealth@EU Handler
... note O0..1stringAny additional free-text information about the immunisation
ObligationsActor
MAY:able-to-populateMyHealth@EU Handler

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "MyHealthEuImmunisation",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation",
  "version": "1.0.0",
  "name": "MyHealthEuImmunisation",
  "title": "Immunisation model",
  "status": "active",
  "date": "2026-05-04T15:59:03+02:00",
  "publisher": "MyHealth@Eu",
  "contact": [
    {
      "name": "MyHealth@Eu",
      "telecom": [
        {
          "system": "url",
          "value": "https://health.ec.europa.eu/other-pages/basic-page/myhealtheu-flyer-addressed-patients-and-health-professionals_en"
        }
      ]
    }
  ],
  "description": "MyHealth@EU refined model for immunisation",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "150",
          "display": "Europe"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation",
  "baseDefinition": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "0.3.0"
      }
    ],
    "element": [
      {
        "id": "MyHealthEuImmunisation",
        "path": "MyHealthEuImmunisation",
        "short": "Immunisation model",
        "definition": "MyHealth@EU refined model for immunisation",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.header",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.subject",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.identifier",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.author[x]",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.date",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.status",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.source",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.header.language",
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.diseaseOrAgentTargeted",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.vaccine",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.administeredProduct",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.administrationTime",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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": "MyHealthEuImmunisation.administeringCentre",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.administrator",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.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://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.note",
        "extension": [
          {
            "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"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.note",
        "short": "Any additional free-text information about the immunisation",
        "definition": "Any additional free-text information about the immunisation. It can be used for next vaccination date and dose number, among other details.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "EHDSImmunisation.note",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "MyHealthEuImmunisation",
        "path": "MyHealthEuImmunisation",
        "definition": "MyHealth@EU refined model for immunisation"
      },
      {
        "id": "MyHealthEuImmunisation.diseaseOrAgentTargeted",
        "extension": [
          {
            "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/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.diseaseOrAgentTargeted"
      },
      {
        "id": "MyHealthEuImmunisation.vaccine",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.vaccine"
      },
      {
        "id": "MyHealthEuImmunisation.administeredProduct",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.administeredProduct",
        "type": [
          {
            "code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuMedication"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.administrationTime",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://fhir.ehdsi.eu/core/ActorDefinition/actor-handler-ehdsi"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.administrationTime"
      },
      {
        "id": "MyHealthEuImmunisation.administeringCentre",
        "extension": [
          {
            "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/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.administeringCentre",
        "type": [
          {
            "code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuOrganisation"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.administrator",
        "extension": [
          {
            "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/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisation.administrator",
        "type": [
          {
            "code": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuHealthProfessional"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisation.note",
        "extension": [
          {
            "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/StructureDefinition/obligation"
          }
        ],
        "path": "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."
      }
    ]
  }
}