## Profile Comparison between http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips vs http://hl7.eu/fhir/base-r5/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-r5/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-r5/StructureDefinition/immunization-eu-core'
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.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2026-04-27T22:41:19+03: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'
Warning | StructureDefinition.fhirVersion | Values for fhirVersion differ: '4.0.1' vs '5.0.0'
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.comment | Values for comment differ: 'The only time that a resource does not have an id is when it is being submitted to the server using a create operation.' vs 'Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.'
Information | StructureDefinition.comment | Values for comment differ: 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.' vs 'Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.'
Information | StructureDefinition.short | Values for short differ: 'Language of the resource content' vs 'Language of the immunization content'
Information | StructureDefinition.comment | Values for comment differ: 'Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a 'text blob' or where text is additionally entered raw or narrated and encoded information is added later.' vs 'Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a 'text blob' or where text is additionally entered raw or narrated and encoded information is added later.'
Information | StructureDefinition.definition | Values for definition differ: 'These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.' vs 'These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.'
Information | StructureDefinition.comment | Values for comment differ: 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.' vs 'This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.'
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 '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 managable, 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.'
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 and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
Information | StructureDefinition.requirements | Values for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).'
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 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: 'Indicates context the data was recorded in' vs 'Indicates context the data was captured in'
Information | StructureDefinition.definition | Values for definition differ: 'An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.' vs 'Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.'
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.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element. 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 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
Information | StructureDefinition.requirements | Values for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).'
Information | StructureDefinition.short | Values for short differ: 'Patient eligibility for a vaccination program' vs 'Patient eligibility for a specific vaccination program'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element. 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 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
Information | StructureDefinition.requirements | Values for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element. 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 'May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.'
Information | StructureDefinition.definition | Values for definition differ: 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).' vs 'May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).'
Information | StructureDefinition.requirements | Values for requirements differ: 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).' vs 'Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).'
Information | StructureDefinition.short | Values for short differ: 'Vaccine preventable disease being targeted' vs 'Vaccine preventatable disease being targeted'
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.'

### 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-04-27T22:41:19+03: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 | 5.0.0 | Values Differ
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 |
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-r5/StructureDefinition/immunization-eu-core | Values Differ
version | 2.0.0 |

### 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: ?? (required): IETF language tag for a human language
Additional Bindings | Purpose
?? | Starter
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 | Additional content defined by implementations |
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) | 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) |
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 administered Binding: ?? (preferred)
Additional Bindings | Purpose
?? | Preferred
| 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 |  |  |  |  | Removed this element
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was captured 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. |  |  |  |  | Removed this element
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 | CodeableReference(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) | 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) | 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) |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Individual or organization who was performing |
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes |
id |  |  |  |  |  | 0..1 | id | 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 | PractitionerRole | 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. |  |  |  |  | Removed this element
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |  |  |  |  | Removed this element
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 |  |  |  |  | Removed this element
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. |  | 0..* | BackboneElement | Patient eligibility for a specific vaccination program |
id |  |  |  |  |  | 0..1 | string | Unique id for inter-element referencing | Added this element
extension |  |  |  |  |  | 0..* | Extension | Additional content defined by implementations | Added this element
modifierExtension |  |  |  |  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | Added this element
program |  |  |  |  |  | 1..1 | CodeableConcept | The program that eligibility is declared for Binding: ?? (example) | Added this element
programStatus |  |  |  |  |  | 1..1 | CodeableConcept | The patient's eligibility status for the program Binding: ?? (example) | Added this element
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) |
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 |  |  |  |  | Removed this element
reported |  | 0..1 | boolean | Indicates self-reported reaction |  | 0..1 | boolean | Indicates self-reported reaction |
manifestation |  |  |  |  |  | 0..1 | CodeableReference(Observation) | Additional information on reaction | Added this element
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 targeted Binding: ?? (preferred)
Additional Bindings | Purpose
?? | Preferred
doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series |  |  |  |  | Removed this element
seriesDoses[x] |  | 0..1 | positiveInt, string | Recommended number of doses for immunity |  |  |  |  | Removed this element
doseNumber |  |  |  |  |  | 1..1 | string | Dose Number | Added this element
seriesDoses |  |  |  |  |  | 0..1 | string | Number of doses | Added this element
basedOn |  |  |  |  | Σ | 0..* | Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) | Authority that the immunization event is based on | Added this element
administeredProduct |  |  |  |  |  | 0..1 | CodeableReference(Medication) | The product that was administered or was to be administered. | Added this element
supportingInformation |  |  |  |  |  | 0..* | Reference(Resource) | Additional information in support of the immunization | Added this element
informationSource |  |  |  |  |  | 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) | Added this element
reason |  |  |  |  |  | 0..* | CodeableReference(Condition | Observation | DiagnosticReport) | Why immunization occurred Binding: ?? (example) | Added this element
Documentation for this format