| Left: | Immunization (HDR) (http://hl7.eu/fhir/hdr/StructureDefinition/immunization-eu-hdr) |
| Right: | Immunization (HDR) (http://hl7.eu/fhir/hdr/StructureDefinition/immunization-eu-hdr) |
| Error | StructureDefinition.version | Values for version differ: '0.1.0-ballot' vs '0.1.0-ci-build' |
| Information | StructureDefinition.date | Values for date differ: '2025-06-03T12:48:49+02:00' vs '2026-01-13T11:22:43+00:00' |
| Information | Immunization.language | Example/preferred bindings differ at Immunization.language using binding from ImmunizationEuHdr |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Immunization | ||
copyright | Used by permission of HL7 Europe, all rights reserved Creative Commons License | ||
date | 2025-06-03T12:48:49+02:00 | 2026-01-13T11:22:43+00:00 |
|
description | This profile constrains the Immunization resource for the purpose of this guide. | ||
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#150 | ||
kind | resource | ||
name | ImmunizationEuHdr | ||
publisher | HL7 Europe | ||
purpose | This profile constrains the Immunization resource for the purpose of this guide. | ||
status | draft | ||
title | Immunization (HDR) | ||
type | Immunization | ||
url | http://hl7.eu/fhir/hdr/StructureDefinition/immunization-eu-hdr | ||
version | 0.1.0-ballot | 0.1.0-ci-build |
|
| 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 This profile also imposes the profile Immunization (IPS) | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS) (2.0.0) | |||||||||||||||
![]() ![]() | Σ | 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: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): 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 | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||
![]() ![]() | 0..* | Identifier | Business identifier | 0..* | Identifier | Business identifier | |||||||||||||||
![]() ![]() | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | |||||||||||||
![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | |||||||||||||||
![]() ![]() | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: ?? (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
| |||||||||||||
![]() ![]() | Σ | 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 | |||||||||||||||
![]() ![]() | Σ | 1..1 | dateTime | Vaccine administration date | Σ | 1..1 | dateTime | Vaccine administration date | |||||||||||||
![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||||||||||
![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was recorded in | |||||||||||||
![]() ![]() | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | |||||||||||||||
![]() ![]() | 0..1 | Reference(Location (EU base)) | Where immunization occurred | 0..1 | Reference(Location (EU core)) | Where immunization occurred | |||||||||||||||
![]() ![]() | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH | 0..1 | Reference(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 | |||||||||||||||
![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | |||||||||||||||
![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | |||||||||||||||
![]() ![]() | 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): The role a practitioner or organization plays in the immunization event. | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | |||||||||||||
![]() ![]() ![]() | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||||||
![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||||||
![]() ![]() | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | |||||||||||||||
![]() ![]() | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||||||||
![]() ![]() | ?!Σ | 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. | |||||||||||||||
![]() ![]() | C | 0..* | BackboneElement | Educational material presented to patient | C | 0..* | BackboneElement | Educational material presented to patient | |||||||||||||
![]() ![]() ![]() | 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 | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||||||
![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||||||
![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||||||
![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||||||||||||||
![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | |||||||||||||||
![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | |||||||||||||||
![]() ![]() | 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 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(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 targetted Binding: ?? (preferred) | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (preferred) | |||||||||||||||
![]() ![]() ![]() | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | |||||||||||||||
![]() ![]() ![]() | 0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | 0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |||||||||||||||
Documentation for this format | |||||||||||||||||||||