Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
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
| Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRImmunizationEvent | Version: 0.1.0 | |||
| Draft as of 2026-08-20 | 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) |
![]() ![]() ![]() |
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) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) |
![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Dose number within series | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) |
![]() ![]() ![]() |
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) |
![]() ![]() |
S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() |
S | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
S | 1..1 | dateTime, string | Vaccine administration date |
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) |
![]() ![]() |
S | 0..* | BackboneElement | Who performed event |
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.vaccineCode | Base | extensible | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) | ||||
![]() ![]() ![]() |
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) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() |
0..1 | 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. | |||||
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred | ||||
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) | ||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() |
1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
Documentation for this format | ||||||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Immunization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) |
![]() ![]() ![]() |
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) |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
string | |||
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) |
![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
1..1 | Dose number within series | ||
![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() |
string | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std. |
| Immunization.vaccineCode | Base | extensible | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) |
![]() ![]() ![]() |
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) |
![]() ![]() |
S | 1..1 | code | completed | entered-in-error | not-done |
![]() ![]() |
S | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) |
![]() ![]() |
S | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() |
S | 1..1 | dateTime, string | Vaccine administration date |
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) |
![]() ![]() |
S | 0..* | BackboneElement | Who performed event |
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Immunization.vaccineCode | Base | extensible | Vaccine Administered Value Set | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Immunization | Immunization event information | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 1..1 | code | Record Origin URL: https://icr.healthcampaigns.org/StructureDefinition/record-origin Binding: ICR Record Origin (required) | ||||
![]() ![]() ![]() |
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) | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
![]() ![]() |
0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | CVX-coded; local codes map back via ConceptMap (working doc §8) Binding: VaccineAdministeredValueSet (extensible) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who was immunized | ||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() |
SΣ | 1..1 | Vaccine administration date | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() |
0..1 | 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. | |||||
![]() ![]() |
S | 0..1 | Reference(Location) | Where immunization occurred | ||||
![]() ![]() |
S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() |
S | 0..1 | date | Vaccine expiry — field forms report it alongside the lot number (v0.1) | ||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |||||
![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() |
S | 0..* | BackboneElement | Dose number / series — supports multi-dose campaigns (OCV) and routine integration | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() |
1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
Documentation for this format | ||||||||
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Immunization
Other representations of profile: CSV, Excel, Schematron