FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Vaccination

Packagehl7.fhir.eu.eps
TypeStructureDefinition
IdVaccination
FHIR VersionR4
Sourcehttp://hl7.eu/fhir/eps/https://build.fhir.org/ig/hl7-eu/eps/StructureDefinition-Vaccination.html
URLhttp://hl7.eu/fhir/eps/StructureDefinition/Vaccination
Version0.0.1-ci
Statusdraft
Date2025-06-20T15:31:33+00:00
NameVaccinationPsEhn
TitleA.2.2.1 - Vaccination/ prophylaxis information
Realmeu
Authorityhl7
DescriptionVaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.
CopyrightUsed by permission of HL7 Europe, all rights reserved Creative Commons License
Typehttp://hl7.eu/fhir/eps/StructureDefinition/Vaccination
Kindlogical

Resources that use this resource

ConceptMap
vaccination2FHIR-eu-epseHN Alerts Model to this guide Map
StructureDefinition
PatientSummaryA - Patient Summary

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: StructureDefinition Vaccination

NameFlagsCard.TypeDescription & Constraintsdoco
.. Vaccination 0..*BaseA.2.2.1 - Vaccination/ prophylaxis information
... targetDisease 0..*CodeableConceptA.2.2.1.1 Disease or agent targeted
... vaccine 0..*CodeableConceptA.2.2.1.2 Vaccine/prophylaxis
... productName 0..*stringA.2.2.1.3 Vaccine medicinal product name
... productId 0..*CodeableConceptA.2.2.1.3.1 Identifier of the vaccine medicinal product
... marketingAuthorisationHolder 0..*CodeableConceptA.2.2.1.4 Marketing Autorisation Holder
... numberInSeries 0..*BackboneElementA.2.2.1.5 Number in a series of vaccinations/doses
... batchNumber 0..*stringA.2.2.1.6 Batch/lot number
... dateOfVaccination 0..*dateTimeA.2.2.1.7 Date of vaccination
... administeringCentre 0..*OrganizationA.2.2.1.8 Administering centre
... healthProfessionalId 0..*Identifier(5.2.0)A.2.2.1.9 Health Professional identification
... countryOfVaccination 0..*CodeableConceptA.2.2.1.10 Country of vaccination
... dateOfNextVaccination 0..*dateTimeA.2.2.1.11 Next vaccination date

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "Vaccination",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/eps/StructureDefinition/Vaccination",
  "version": "0.0.1-ci",
  "name": "VaccinationPsEhn",
  "title": "A.2.2.1 - Vaccination/ prophylaxis information",
  "status": "draft",
  "date": "2025-06-20T15:31:33+00:00",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "HL7 Europe",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.eu"
        }
      ]
    }
  ],
  "description": "Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.",
  "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": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "http://hl7.eu/fhir/eps/StructureDefinition/Vaccination",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "Vaccination",
        "path": "Vaccination",
        "short": "A.2.2.1 - Vaccination/ prophylaxis information",
        "definition": "Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "Vaccination.targetDisease",
        "path": "Vaccination.targetDisease",
        "short": "A.2.2.1.1 Disease or agent targeted",
        "definition": "Disease or agent that the vaccination provides protection against - Preferred system(s):  ICD-10*, SNOMED CT GPS",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.targetDisease",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.vaccine",
        "path": "Vaccination.vaccine",
        "short": "A.2.2.1.2 Vaccine/prophylaxis",
        "definition": "Generic description of the vaccine/prophylaxis or its component(s) - Preferred system(s): SNOMED CT GPS ATC* (IDMP, when available)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.vaccine",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.productName",
        "path": "Vaccination.productName",
        "short": "A.2.2.1.3 Vaccine medicinal product name",
        "definition": "Brand name of the vaccine medicinal product.z",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.productName",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Vaccination.productId",
        "path": "Vaccination.productId",
        "short": "A.2.2.1.3.1 Identifier of the vaccine medicinal product",
        "definition": "Identifier for the vaccine medicinal product. It could be MPID according to ISO 11615, EMA PMS ID and/or a national identifier. EMA PMS",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.productId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.marketingAuthorisationHolder",
        "path": "Vaccination.marketingAuthorisationHolder",
        "short": "A.2.2.1.4 Marketing Autorisation Holder",
        "definition": "Marketing Authorisation Holder EMA's Organisations System data (SPOR)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.marketingAuthorisationHolder",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.numberInSeries",
        "path": "Vaccination.numberInSeries",
        "short": "A.2.2.1.5 Number in a series of vaccinations/doses",
        "definition": "Vaccination in the vaccination course",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.numberInSeries",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "Vaccination.batchNumber",
        "path": "Vaccination.batchNumber",
        "short": "A.2.2.1.6 Batch/lot number",
        "definition": "A distinctive combination of numbers and/or letters which specifically identifies a batch",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.batchNumber",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Vaccination.dateOfVaccination",
        "path": "Vaccination.dateOfVaccination",
        "short": "A.2.2.1.7 Date of vaccination",
        "definition": "The date when the vaccination was administered - Preferred system(s): ISO 8601",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.dateOfVaccination",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Vaccination.administeringCentre",
        "path": "Vaccination.administeringCentre",
        "short": "A.2.2.1.8 Administering centre",
        "definition": "Name/code of administering centre or a health authority responsible for the vaccination event",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.administeringCentre",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Organization"
          }
        ]
      },
      {
        "id": "Vaccination.healthProfessionalId",
        "path": "Vaccination.healthProfessionalId",
        "short": "A.2.2.1.9 Health Professional identification",
        "definition": "Name or health professional code responsible for administering the vaccine or prophylaxis",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.healthProfessionalId",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/elementdefinition-identifier"
            ]
          }
        ]
      },
      {
        "id": "Vaccination.countryOfVaccination",
        "path": "Vaccination.countryOfVaccination",
        "short": "A.2.2.1.10 Country of vaccination",
        "definition": "The country in which the individual has been vaccinated - Preferred system(s): ISO 3166",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.countryOfVaccination",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.dateOfNextVaccination",
        "path": "Vaccination.dateOfNextVaccination",
        "short": "A.2.2.1.11 Next vaccination date",
        "definition": "The date when the vaccination is planned to be given/repeated (e.g. next dose) - Preferred system(s): ISO 8601",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Vaccination.dateOfNextVaccination",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Vaccination",
        "path": "Vaccination",
        "short": "A.2.2.1 - Vaccination/ prophylaxis information",
        "definition": "Vaccination/ prophylaxis information. Sections A2.2.2.1 of the eHN guideline."
      },
      {
        "id": "Vaccination.targetDisease",
        "path": "Vaccination.targetDisease",
        "short": "A.2.2.1.1 Disease or agent targeted",
        "definition": "Disease or agent that the vaccination provides protection against - Preferred system(s):  ICD-10*, SNOMED CT GPS",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.vaccine",
        "path": "Vaccination.vaccine",
        "short": "A.2.2.1.2 Vaccine/prophylaxis",
        "definition": "Generic description of the vaccine/prophylaxis or its component(s) - Preferred system(s): SNOMED CT GPS ATC* (IDMP, when available)",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.productName",
        "path": "Vaccination.productName",
        "short": "A.2.2.1.3 Vaccine medicinal product name",
        "definition": "Brand name of the vaccine medicinal product.z",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Vaccination.productId",
        "path": "Vaccination.productId",
        "short": "A.2.2.1.3.1 Identifier of the vaccine medicinal product",
        "definition": "Identifier for the vaccine medicinal product. It could be MPID according to ISO 11615, EMA PMS ID and/or a national identifier. EMA PMS",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.marketingAuthorisationHolder",
        "path": "Vaccination.marketingAuthorisationHolder",
        "short": "A.2.2.1.4 Marketing Autorisation Holder",
        "definition": "Marketing Authorisation Holder EMA's Organisations System data (SPOR)",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.numberInSeries",
        "path": "Vaccination.numberInSeries",
        "short": "A.2.2.1.5 Number in a series of vaccinations/doses",
        "definition": "Vaccination in the vaccination course",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "Vaccination.batchNumber",
        "path": "Vaccination.batchNumber",
        "short": "A.2.2.1.6 Batch/lot number",
        "definition": "A distinctive combination of numbers and/or letters which specifically identifies a batch",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Vaccination.dateOfVaccination",
        "path": "Vaccination.dateOfVaccination",
        "short": "A.2.2.1.7 Date of vaccination",
        "definition": "The date when the vaccination was administered - Preferred system(s): ISO 8601",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Vaccination.administeringCentre",
        "path": "Vaccination.administeringCentre",
        "short": "A.2.2.1.8 Administering centre",
        "definition": "Name/code of administering centre or a health authority responsible for the vaccination event",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Organization"
          }
        ]
      },
      {
        "id": "Vaccination.healthProfessionalId",
        "path": "Vaccination.healthProfessionalId",
        "short": "A.2.2.1.9 Health Professional identification",
        "definition": "Name or health professional code responsible for administering the vaccine or prophylaxis",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/elementdefinition-identifier"
            ]
          }
        ]
      },
      {
        "id": "Vaccination.countryOfVaccination",
        "path": "Vaccination.countryOfVaccination",
        "short": "A.2.2.1.10 Country of vaccination",
        "definition": "The country in which the individual has been vaccinated - Preferred system(s): ISO 3166",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "Vaccination.dateOfNextVaccination",
        "path": "Vaccination.dateOfNextVaccination",
        "short": "A.2.2.1.11 Next vaccination date",
        "definition": "The date when the vaccination is planned to be given/repeated (e.g. next dose) - Preferred system(s): ISO 8601",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      }
    ]
  }
}