## Profile Comparison between http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips vs http://hl7.eu/fhir/base/StructureDefinition/immunization-eu-core

Left: | Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips)
Right: | Immunization (EU core) (http://hl7.eu/fhir/base/StructureDefinition/immunization-eu-core)

### Messages

Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips' vs 'http://hl7.eu/fhir/base/StructureDefinition/immunization-eu-core'
Error | StructureDefinition.version | Values for version differ: '2.0.0' vs '2.0.0-gamma'
Information | StructureDefinition.name | Values for name differ: 'ImmunizationUvIps' vs 'ImmunizationEuCore'
Information | StructureDefinition.title | Values for title differ: 'Immunization (IPS)' vs 'Immunization (EU core)'
Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft'
Information | StructureDefinition.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2026-02-25T10:00:47+01:00'
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Europe'
Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
Information | StructureDefinition.jurisdiction | Added the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#150'
Information | StructureDefinition.definition | Values for definition differ: 'Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.' vs 'Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.'
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: 'Additional content defined by implementations' vs 'Extension'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.' vs 'An Extension'
Information | StructureDefinition.short | Values for short differ: 'Business identifier' vs 'Identifier of the immunization'
Information | StructureDefinition.short | Values for short differ: 'completed | entered-in-error | not-done' vs 'Immunization status.'
Warning | Immunization.status | Elements differ in definition for mustSupport: 'true' vs 'false'
Information | StructureDefinition.short | Values for short differ: 'Reason not done' vs 'Reason for not performing.'
Information | StructureDefinition.short | Values for short differ: 'Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.' vs 'Vaccine product administered'
Information | StructureDefinition.definition | Values for definition differ: 'Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunized is provided; or the known absent / unknown. Other coded information can be provided as well as: - The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept. - The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept. - The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. - The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. - Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class). The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.' vs 'Vaccine that was administered or was to be administered.'
Warning | Immunization.vaccineCode | Elements differ in definition for mustSupport: 'true' vs 'false'
Warning | Immunization.patient | Elements differ in definition for mustSupport: 'true' vs 'false'
Information | StructureDefinition.short | Values for short differ: 'Vaccine administration date' vs 'Date of vaccination'
Warning | Immunization.occurrence[x] | Elements differ in definition for mustSupport: 'true' vs 'false'
Information | StructureDefinition.short | Values for short differ: 'Vaccine manufacturer' vs 'Vaccine manufacturer/MAH'
Information | StructureDefinition.short | Values for short differ: 'Vaccine lot number' vs 'Batch/lot number'
Information | Immunization.site | Example/preferred bindings differ at Immunization.site using binding from ImmunizationUvIps
Information | Immunization.route | Example/preferred bindings differ at Immunization.route using binding from ImmunizationUvIps
Information | StructureDefinition.short | Values for short differ: 'Why immunization occurred' vs 'Reasons for the administration.'
Information | StructureDefinition.short | Values for short differ: 'Vaccine preventable disease being targeted' vs 'Vaccine preventatable disease being targetted'
Information | StructureDefinition.definition | Values for definition differ: 'The particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the [elementdefinition-additionalBinding](http://hl7.org/fhir/tools/StructureDefinition/additional-binding) extension): - [targetDiseases-uv-ips](./ValueSet-target-diseases-uv-ips.html)' vs 'The vaccine preventable disease the dose is being administered against.'
Information | StructureDefinition.short | Values for short differ: 'Dose number within series' vs 'Dose Number'
Information | StructureDefinition.short | Values for short differ: 'Recommended number of doses for immunity' vs 'Number of doses'

### Metadata

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). | Added the item 'Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).'
date | 2024-06-19T10:50:07-05:00 | 2026-02-25T10:00:47+01:00 | Values Differ
description | This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party. | This profile introduces essential constraints and extensions for the Immunization resource that apply across multiple use cases. | Values Differ
experimental |  | false | Added the item 'false'
fhirVersion | 4.0.1 |
jurisdiction |  |
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |  | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
jurisdiction[1] |  | http://unstats.un.org/unsd/methods/m49/m49.htm#150 | Added the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#150'
kind | resource |
name | ImmunizationUvIps | ImmunizationEuCore | Values Differ
publisher | HL7 International / Patient Care | HL7 Europe | Values Differ
purpose | This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International. | This profile constrains the Immunization resource for the purpose of this guide. | Values Differ
status | active | draft | Values Differ
title | Immunization (IPS) | Immunization (EU core) | Values Differ
type | Immunization |
url | http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips | http://hl7.eu/fhir/base/StructureDefinition/immunization-eu-core | Values Differ
version | 2.0.0 | 2.0.0-gamma | Values Differ

### Structure

Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information |  | 0..* | Immunization | Immunization event information |
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 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 |
language |  | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
|  | 0..1 | code | Language of the immunization content Binding: ?? (preferred): A human language.
Additional Bindings | Purpose
?? | Max Binding
text |  | 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 |
contained |  | 0..* | Resource | Contained, inline Resources |  | 0..* | Resource | Contained, inline Resources |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier |  | 0..* | Identifier | Business identifier |  | 0..* | Identifier | Identifier of the immunization |
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| ?!Σ | 1..1 | code | Immunization status. Binding: ?? (required): A set of codes indicating the current status of an Immunization. | Elements differ in definition for mustSupport: 'true' vs 'false'
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. |  | 0..1 | CodeableConcept | Reason for not performing. Binding: ?? (example): The reason why a vaccine was not administered. |
vaccineCode | SO Σ | 1..1 | ?? | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. 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.
Additional Bindings | Purpose | Documentation
?? | candidate | For when WHO ATC code system is preferred
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| Σ | 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.
Additional Bindings | Purpose | Documentation
?? | candidate | For when WHO ATC code system is preferred
?? | candidate | For EU cross-border use
| Elements differ in definition for mustSupport: 'true' vs 'false'
patient | SO Σ | 1..1 | Reference(Patient (IPS)) | Who was immunized
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized | Elements differ in definition for mustSupport: 'true' vs 'false'
id |  | 0..1 | string | Unique id for inter-element referencing |  |  |  |  | Removed this element
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |  |  |  |  | Removed this element
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
|  |  |  |  | Removed this element
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |  |  |  |  | Removed this element
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |  |  |  |  | Removed this element
display | Σ | 0..1 | string | Text alternative for the resource |  |  |  |  | Removed this element
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of |  | 0..1 | Reference(Encounter) | Encounter immunization was part of |
Slices for occurrence[x] | SO Σ | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
| Σ | 1..1 | dateTime, string | Date of vaccination Slice: Unordered, Open by type:$this | Elements differ in definition for mustSupport: 'true' vs 'false'
recorded |  | 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 |
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was recorded in |
reportOrigin |  | 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. |
location |  | 0..1 | Reference(Location) | Where immunization occurred |  | 0..1 | Reference(Location (EU core)) | Where immunization occurred |
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH |
lotNumber |  | 0..1 | string | Vaccine lot number |  | 0..1 | string | Batch/lot number |
expirationDate |  | 0..1 | date | Vaccine expiration date |  | 0..1 | date | Vaccine expiration date |
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (preferred) |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | Example/preferred bindings differ at Immunization.site using binding from ImmunizationUvIps
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (preferred): SNOMED Route Terms
Additional Bindings | Purpose
?? | candidate
|  | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | Example/preferred bindings differ at Immunization.route using binding from ImmunizationUvIps
doseQuantity |  | 0..1 | ?? | Amount of vaccine administered |  | 0..1 | ?? | Amount of vaccine administered |
performer | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
function | Σ | 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. |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes |
id |  |  |  |  |  | 0..1 | string | Unique id for inter-element referencing | Added this element
Slices for extension |  |  |  |  |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | Added this element
author[x] |  |  |  |  | Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation | Added this element
time |  |  |  |  | Σ | 0..1 | dateTime | When the annotation was made | Added this element
text |  |  |  |  | Σ | 1..1 | markdown | Additional notes about the immunization | Added this element
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. |  | 0..* | CodeableConcept | Reasons for the administration. Binding: ?? (example): The reason why a vaccine was administered. |
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency |
subpotentReason |  | 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. |
education | C | 0..* | BackboneElement | Educational material presented to patient | C | 0..* | BackboneElement | Educational material presented to patient |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
documentType |  | 0..1 | string | Educational material document identifier |  | 0..1 | string | Educational material document identifier |
reference |  | 0..1 | uri | Educational material reference pointer |  | 0..1 | uri | Educational material reference pointer |
publicationDate |  | 0..1 | dateTime | Educational material publication date |  | 0..1 | dateTime | Educational material publication date |
presentationDate |  | 0..1 | dateTime | Educational material presentation date |  | 0..1 | dateTime | Educational material presentation date |
programEligibility |  | 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. |
fundingSource |  | 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. |
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization |  | 0..* | BackboneElement | Details of a reaction that follows immunization |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
date |  | 0..1 | dateTime | When reaction started |  | 0..1 | dateTime | When reaction started |
detail |  | 0..1 | Reference(Observation) | Additional information on reaction |  | 0..1 | Reference(Observation) | Additional information on reaction |
reported |  | 0..1 | boolean | Indicates self-reported reaction |  | 0..1 | boolean | Indicates self-reported reaction |
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider |  | 0..* | BackboneElement | Protocol followed by the provider |
id |  | 0..1 | string | Unique id for inter-element referencing |  | 0..1 | string | Unique id for inter-element referencing |
extension |  | 0..* | Extension | Additional content defined by implementations |  | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
series |  | 0..1 | string | Name of vaccine series |  | 0..1 | string | Name of vaccine series |
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized. |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (preferred): The diseases against which the patient has been immunised
Additional Bindings | Purpose | Documentation
?? | candidate | For when WHO ATC code system is preferred
doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series |  | 1..1 | positiveInt, string | Dose Number |
seriesDoses[x] |  | 0..1 | positiveInt, string | Recommended number of doses for immunity |  | 0..1 | positiveInt, string | Number of doses |
Documentation for this format