Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ICR Immunization Event

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRImmunizationEvent Version: 0.1.0
Draft as of 2026-10-29 Computable Name: ICRImmunizationEvent

A vaccination delivery event: CVX-coded, with lot accountability and the required campaign-vs-routine record origin.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... vaccineCode SΣ 1..1 CodeableConcept CVX-coded; local codes map back via ConceptMap (working doc §8)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(Patient) Who was immunized
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... location S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco 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.statusReason Base extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... status S 1..1 code completed | not-done — an eligible person not vaccinated at the visit gets a not-done event with statusReason; not-done events never count in a coverage numerator
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... patient S 1..1 Reference(Patient) Who was immunized
... occurrence[x] S 1..1 dateTime, string Vaccine administration date
... location S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... performer S 0..* BackboneElement Who performed event
... protocolApplied S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.statusReason Base extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... 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 BindingsPurpose
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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | not-done — an eligible person not vaccinated at the visit gets a not-done event with statusReason; not-done events never count in a coverage numerator
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... vaccineCode SΣ 1..1 CodeableConcept CVX-coded; local codes map back via ConceptMap (working doc §8)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... 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 S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 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 S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration
.... 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 preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... 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

doco 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 extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization 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 example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... vaccineCode SΣ 1..1 CodeableConcept CVX-coded; local codes map back via ConceptMap (working doc §8)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(Patient) Who was immunized
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... location S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco 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.statusReason Base extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... status S 1..1 code completed | not-done — an eligible person not vaccinated at the visit gets a not-done event with statusReason; not-done events never count in a coverage numerator
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... patient S 1..1 Reference(Patient) Who was immunized
... occurrence[x] S 1..1 dateTime, string Vaccine administration date
... location S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... performer S 0..* BackboneElement Who performed event
... protocolApplied S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.statusReason Base extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization C 0..* Immunization Immunization event information
Constraints: icr-not-done-reason
... 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 BindingsPurpose
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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:campaign S 0..1 Reference(ICR Campaign) The campaign (round) this dose belongs to — supplies Immunization's missing basedOn, so 'all doses in this round' is a direct query, independent of Task wiring
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign
.... extension:campaignActivity S 0..1 canonical(ICR Campaign Activity) The campaign activity this dose was for. Required in practice when the visit Task has no instantiatesCanonical and the campaign lists more than one activity; per-activity results count events by this link
URL: https://icr.healthcampaigns.org/StructureDefinition/campaign-activity
.... extension:recordOrigin S 1..1 code Record Origin
URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin
Binding: ICR Record Origin (required)
.... extension:priorDoseStatus S 0..1 code Prior-dose (zero-dose) status of the antigen at this contact — zero-dose | previously-received | no-recall (v0.21.0)
URL: https://icr.healthcampaigns.org/StructureDefinition/prior-dose-status
Binding: ICR Dose History / Zero-dose Status (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | not-done — an eligible person not vaccinated at the visit gets a not-done event with statusReason; not-done events never count in a coverage numerator
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason S 0..1 CodeableConcept Why the dose was not given: missed, refused or excluded (ICRNotDoneReasonVS). Required when status = not-done (icr-not-done-reason)
Binding: ICR Not-done Reason (extensible)
... vaccineCode SΣ 1..1 CodeableConcept CVX-coded; local codes map back via ConceptMap (working doc §8)
Binding: VaccineAdministeredValueSet (extensible)
... patient SΣ 1..1 Reference(Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 Vaccine administration date
.... occurrenceDateTime dateTime
.... occurrenceString string
... 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 S 0..1 Reference(Location) Where immunization occurred
... manufacturer S 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiry — field forms report it alongside the lot number (v0.1)
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 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 S 0..* BackboneElement Dose number / series — supports multi-dose campaigns (OCV) and routine integration
.... 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 preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... 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

doco 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 extensible ICR Not-done Reason 📦0.1.0 This IG
Immunization.vaccineCode Base extensible Vaccine Administered Value Set 📦4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization 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 example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
icr-not-done-reason error Immunization A not-done vaccine or drug event records why it was not given (statusReason). status = 'not-done' implies statusReason.exists()

 

Other representations of profile: CSV, Excel, Schematron