| Left: | Immunization (EU core) (http://hl7.eu/fhir/base-r5/StructureDefinition/immunization-eu-core) |
| Right: | Immunization (EU core) (http://hl7.eu/fhir/base-r5/StructureDefinition/immunization-eu-core) |
| Error | StructureDefinition.version | Values for version differ: '2.0.0-ballot' vs '2.0.0' |
| Information | StructureDefinition.date | Values for date differ: '2025-12-19T19:52:30+01:00' vs '2026-04-27T22:41:19+03:00' |
| Information | StructureDefinition.short | Values for short differ: 'Language of the resource content' vs 'Language of the immunization content' |
| Information | StructureDefinition.short | Values for short differ: 'Business identifier' vs 'Identifier of the immunization' |
| Information | StructureDefinition.short | Values for short differ: 'Product that was administered' vs 'The product that was administered or was to be administered.' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Immunization | ||
copyright | Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0). | ||
date | 2025-12-19T19:52:30+01:00 | 2026-04-27T22:41:19+03:00 |
|
description | This profile sets minimum expectations for the Immunization resource common to most of the use cases. | This profile introduces essential constraints and extensions for the Immunization resource that apply across multiple use cases. |
|
experimental | false | ||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#150 | ||
kind | resource | ||
name | ImmunizationEuCore | ||
publisher | HL7 Europe | ||
purpose | This profile constrains the Immunization resource for the purpose of this guide. | ||
status | active | ||
title | Immunization (EU core) | ||
type | Immunization | ||
url | http://hl7.eu/fhir/base-r5/StructureDefinition/immunization-eu-core | ||
version | 2.0.0-ballot | 2.0.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Immunization | Immunization event information | 0..* | Immunization | Immunization event information | |||||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language
| 0..1 | code | Language of the immunization content Binding: ?? (required): IETF language tag for a human language
| |||||||||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() | 0..* | Identifier | Business identifier | 0..* | Identifier | Identifier of the immunization | |||||||||||
![]() ![]() | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | |||||||||
![]() ![]() | ?!Σ | 1..1 | code | Immunization status. Binding: ?? (required) | ?!Σ | 1..1 | code | Immunization status. Binding: ?? (required) | |||||||||
![]() ![]() | 0..1 | CodeableConcept | Reason for not performing. Binding: ?? (example) | 0..1 | CodeableConcept | Reason for not performing. Binding: ?? (example) | |||||||||||
![]() ![]() | Σ | 1..1 | CodeableConcept | Vaccine administered Binding: ?? (preferred)
| Σ | 1..1 | CodeableConcept | Vaccine administered Binding: ?? (preferred)
| |||||||||
![]() ![]() | 0..1 | CodeableReference(Medication) | Product that was administered | 0..1 | CodeableReference(Medication) | The product that was administered or was to be administered. | |||||||||||
![]() ![]() | 0..1 | CodeableReference(Organization) | Vaccine manufacturer/MAH | 0..1 | CodeableReference(Organization) | Vaccine manufacturer/MAH | |||||||||||
![]() ![]() | 0..1 | string | Batch/lot number | 0..1 | string | Batch/lot number | |||||||||||
![]() ![]() | 0..1 | date | Vaccine expiration date | 0..1 | date | Vaccine expiration date | |||||||||||
![]() ![]() | Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized | Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized | |||||||||
![]() ![]() | 0..1 | Reference(Encounter) | Encounter immunization was part of | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||||||
![]() ![]() | 0..* | Reference(Resource) | Additional information in support of the immunization | 0..* | Reference(Resource) | Additional information in support of the immunization | |||||||||||
![]() ![]() | Σ | 1..1 | dateTime, string | Date of vaccination Slice: Unordered, Open by type:$this | Σ | 1..1 | dateTime, string | Date of vaccination Slice: Unordered, Open by type:$this | |||||||||
![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was captured in | Σ | 0..1 | boolean | Indicates context the data was captured in | |||||||||
![]() ![]() | 0..1 | CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Indicates the source of a reported record Binding: ?? (example) | 0..1 | CodeableReference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core)) | Indicates the source of a reported record Binding: ?? (example) | |||||||||||
![]() ![]() | 0..1 | Reference(Location (EU core)) | Where immunization occurred | 0..1 | Reference(Location (EU core)) | Where immunization occurred | |||||||||||
![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example) | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example) | |||||||||||
![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example) | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example) | |||||||||||
![]() ![]() | 0..1 | ?? | Amount of vaccine administered | 0..1 | ?? | Amount of vaccine administered | |||||||||||
![]() ![]() | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible) | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible) | |||||||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing | |||||||||
![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing |
| |||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..1 | dateTime | When the annotation was made |
| ||||||||||||
![]() ![]() ![]() | Σ | 1..1 | markdown | Additional notes about the immunization |
| ||||||||||||
![]() ![]() | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ?? (example) | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ?? (example) | |||||||||||
![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | 0..1 | id | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Reasons for the administration. | Σ | 0..1 | CodeableConcept | Reasons for the administration. | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Reference() | Reference to a resource (by instance) | Σ | 0..1 | Reference() | Reference to a resource (by instance) | |||||||||
![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency | |||||||||
![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | |||||||||||
![]() ![]() | 0..* | BackboneElement | Patient eligibility for a specific vaccination program | 0..* | BackboneElement | Patient eligibility for a specific vaccination program | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The program that eligibility is declared for Binding: ?? (example) | 1..1 | CodeableConcept | The program that eligibility is declared for Binding: ?? (example) | |||||||||||
![]() ![]() ![]() | 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ?? (example) | 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ?? (example) | |||||||||||
![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example) | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example) | |||||||||||
![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableReference(Observation) | Additional information on reaction | 0..1 | CodeableReference(Observation) | Additional information on reaction | |||||||||||
![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
![]() ![]() | 0..* | BackboneElement | Protocol followed by the provider | 0..* | BackboneElement | Protocol followed by the provider | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||||||
![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ?? (preferred)
| 0..* | CodeableConcept | Vaccine preventatable disease being targeted Binding: ?? (preferred)
| |||||||||||
![]() ![]() ![]() | 1..1 | string | Dose Number | 1..1 | string | Dose Number | |||||||||||
![]() ![]() ![]() | 0..1 | string | Number of doses | 0..1 | string | Number of doses | |||||||||||
Documentation for this format | |||||||||||||||||