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

FHIR IG analytics

Packagemyhealth.eu.fhir.eps
Resource TypeStructureDefinition
IdStructureDefinition-MyHealthEuImmunisationEps.json
FHIR VersionR4
Sourcehttp://fhir.ehdsi.eu/eps/1.0.0-poc/StructureDefinition-MyHealthEuImmunisationEps.html
URLhttp://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps
Version1.0.0-poc
Statusdraft
Date2026-07-16T20:17:46+02:00
NameMyHealthEuImmunisationEps
TitleImmunisation model
Realmeu
DescriptionMyHealth@EU refined base model for Immunisation information in EPS
CopyrightCopyright European Union, represented by the European Commission - DG SANTE. Licenced under CC-BY-4.0.
Typehttp://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps
Kindlogical

Resources that use this resource

StructureDefinition
myhealth.eu.fhir.eps#1.0.0-pocMyHealthEuPatientSummaryEpsPatient Summary model

Resources that this resource uses

StructureDefinition
myhealth.eu.fhir.core#1.0.0MyHealthEuImmunisationImmunisation model

Narrative

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


Source1

{
  "resourceType": "StructureDefinition",
  "id": "MyHealthEuImmunisationEps",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps",
  "version": "1.0.0-poc",
  "name": "MyHealthEuImmunisationEps",
  "title": "Immunisation model",
  "status": "draft",
  "date": "2026-07-16T20:17:46+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 base model for Immunisation information in EPS",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "150",
          "display": "Europe"
        }
      ]
    }
  ],
  "copyright": "Copyright European Union, represented by the European Commission - DG SANTE. Licenced under CC-BY-4.0.",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://fhir.ehdsi.eu/eps/StructureDefinition/MyHealthEuImmunisationEps",
  "baseDefinition": "http://fhir.ehdsi.eu/core/StructureDefinition/MyHealthEuImmunisation",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "1.0.0"
      }
    ],
    "element": [
      {
        "id": "MyHealthEuImmunisationEps",
        "path": "MyHealthEuImmunisationEps",
        "short": "Immunisation model",
        "definition": "MyHealth@EU refined base model for Immunisation information in EPS",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisationEps.header",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.subject",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.identifier",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.author[x]",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.date",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.status",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.source",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.header.language",
        "path": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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": "MyHealthEuImmunisationEps.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"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisationEps.doseNumber",
        "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/eps/StructureDefinition/MyHealthEuImmunisationEps|1.0.0-poc"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisationEps.doseNumber",
        "short": "Number in a series of vaccinations",
        "definition": "Number in a series of vaccinations",
        "min": 0,
        "max": "1",
        "base": {
          "path": "MyHealthEuImmunisationEps.doseNumber",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "positiveInt"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisationEps.countryOfVaccination",
        "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/eps/StructureDefinition/MyHealthEuImmunisationEps|1.0.0-poc"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "MyHealthEuImmunisationEps.countryOfVaccination",
        "short": "Country of vaccination",
        "definition": "Country of vaccination",
        "min": 0,
        "max": "1",
        "base": {
          "path": "MyHealthEuImmunisationEps.countryOfVaccination",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "MyHealthEuImmunisationEps",
        "path": "MyHealthEuImmunisationEps",
        "definition": "MyHealth@EU refined base model for Immunisation information in EPS"
      },
      {
        "id": "MyHealthEuImmunisationEps.doseNumber",
        "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": "MyHealthEuImmunisationEps.doseNumber",
        "short": "Number in a series of vaccinations",
        "definition": "Number in a series of vaccinations",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "positiveInt"
          }
        ]
      },
      {
        "id": "MyHealthEuImmunisationEps.countryOfVaccination",
        "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": "MyHealthEuImmunisationEps.countryOfVaccination",
        "short": "Country of vaccination",
        "definition": "Country of vaccination",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  }
}