International Patient Summary Implementation Guide
2.0.0 -

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

## Resource Profile: Immunization (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: ImmunizationUvIps

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.

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: Composition (IPS)
- Examples for this Profile: Immunization/75680
- CapabilityStatements using this Profile: IPS Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (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)
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
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)
Slices for occurrence[x] | SO Σ | 1..1 |  | 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)
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
status | SO | 1..1 | code | completed | entered-in-error | not-done
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
vaccineCode | SO | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
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)
occurrence[x]:occurrenceDateTime | SO | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
protocolApplied |  |  |  |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccine Target Diseases - IPS | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (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)
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | SO Σ | 1..1 |  | 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)
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
recorded |  | 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
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
doseQuantity |  | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered
performer | Σ | 0..* | BackboneElement | Who performed event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (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
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
doseNumber[x] |  | 1..1 |  | Dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std.
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std.
Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccine Target Diseases - IPS | 📦2.0.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.occurrence[x]

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (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)
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
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)
Slices for occurrence[x] | SO Σ | 1..1 |  | 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)
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
status | SO | 1..1 | code | completed | entered-in-error | not-done
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
vaccineCode | SO | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
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)
occurrence[x]:occurrenceDateTime | SO | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
protocolApplied |  |  |  |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccine Target Diseases - IPS | 📦2.0.0 | This IG

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!SO Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (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)
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | SO Σ | 1..1 | CodeableConceptIPS | 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: Vaccines - IPS (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
Vaccines WHO ATC - IPS | 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)
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)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | SO Σ | 1..1 |  | 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)
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | SO Σ | 0..1 | dateTime | Vaccine administration date
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
recorded |  | 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
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber |  | 0..1 | string | Vaccine lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: SNOMEDCTBodyStructures (preferred)
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: SNOMEDCTRouteCodes (preferred): SNOMED Route Terms
Additional Bindings | Purpose
Medicine EDQM Route of Administration - IPS | candidate
doseQuantity |  | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered
performer | Σ | 0..* | BackboneElement | Who performed event
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (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
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
doseNumber[x] |  | 1..1 |  | Dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | example | Immunization Status Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦2.0.0 | This IG
Immunization.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std.
Immunization.site | Base | preferred | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Immunization.route | Base | preferred | SNOMED CT Route Codes | 📦4.0.1 | FHIR Std.
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std.
Immunization.fundingSource | Base | example | Immunization Funding Source | 📍4.0.1 | FHIR Std.
Immunization.protocolApplied.​targetDisease | Base | preferred | Vaccine Target Diseases - IPS | 📦2.0.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Immunization |  |
status | SHALL:populate-if-known | SHALL:handle SHOULD:display
vaccineCode | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for occurrence[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
occurrence[x]:occurrenceDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 1 element
Must-Support: 6 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.occurrence[x]

Maturity: 3

Other representations of profile: CSV, Excel, Schematron