CA Core+
cibuild 
1.2.0-DFT - The specification is version 1.2.0-DFT of CA Core+ For a full list of available versions, see the Directory of published versions
Immunization (CA-Core)
Many ValueSet and CodeSystem bindings in this guide link to resources hosted on the Canada Health Infoway Terminology Service (Ontoserver). If you are redirected to a login page: This is expected and you are being directed to Infoway’s secure environment. To access these resources: You’ll need an InfoCentral Account.
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/Immunization
Examples
Description
This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context.
References to this resource
CFMM: 2
Resource Content
| ImmunizationCACore (Immunization) | C | Immunization | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | 0..* | Identifier | |
| status | Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| vaccineCode | O Σ | 1..1 | CodeableConceptCACoreBinding |
| patient | Σ C | 1..1 | Reference(PatientCACore) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| encounter | C | 0..1 | Reference(Encounter) |
| occurrence[x] | Σ | 1..1 | |
| occurrenceDateTime | Σ | 0..1 | dateTime |
| occurrenceString | Σ | 0..1 | string |
| recorded | 0..1 | dateTime | |
| primarySource | Σ | 0..1 | boolean |
| reportOrigin | 0..1 | CodeableConceptBinding | |
| location | C | 0..1 | Reference(LocationCACore) |
| manufacturer | C | 0..1 | Reference(Organization) |
| lotNumber | O | 0..1 | string |
| expirationDate | 0..1 | date | |
| site | 0..1 | CodeableConceptBinding | |
| route | 0..1 | CodeableConceptBinding | |
| doseQuantity | C | 0..1 | SimpleQuantity |
| performer | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| function | Σ | 0..1 | CodeableConceptBinding |
| actor | Σ C | 1..1 | Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore) |
| note | Σ | 0..* | Annotation |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | C | 0..* | Reference(ConditionCACore | DiagnosticReport | Observation) |
| isSubpotent | Σ ?! | 0..1 | boolean |
| subpotentReason | 0..* | CodeableConcept | |
| education | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| documentType | 0..1 | string | |
| reference | 0..1 | uri | |
| publicationDate | 0..1 | dateTime | |
| presentationDate | 0..1 | dateTime | |
| programEligibility | 0..* | CodeableConcept | |
| fundingSource | 0..1 | CodeableConcept | |
| reaction | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| date | 0..1 | dateTime | |
| detail | C | 0..1 | Reference(Observation) |
| reported | 0..1 | boolean | |
| protocolApplied | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| series | 0..1 | string | |
| authority | C | 0..1 | Reference(Organization) |
| targetDisease | 0..* | CodeableConcept | |
| doseNumber[x] | 1..1 | ||
| doseNumberPositiveInt | positiveInt | ||
| doseNumberString | string | ||
| seriesDoses[x] | 0..1 | ||
| seriesDosesPositiveInt | positiveInt | ||
| seriesDosesString | string |
| ImmunizationCACore (Immunization) | C | Immunization | |
| vaccineCode | O | CodeableConceptCACoreBinding | |
| patient | Reference(PatientCACore) | ||
| reference | 1.. | ||
| occurrence[x] | |||
| occurrenceDateTime | 0..1 | dateTime | |
| occurrenceString | 0..1 | string | |
| reportOrigin | Binding | ||
| location | Reference(LocationCACore) | ||
| lotNumber | O | ||
| site | Binding | ||
| route | Binding | ||
| performer | |||
| actor | Reference(OrganizationCACore | PractitionerCACore | PractitionerRoleCACore) | ||
| reasonReference | Reference(ConditionCACore | DiagnosticReport | Observation) |
</extension>
</telecom>
</telecom>
</contact>
<description value="This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context." />
</jurisdiction>
<copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<comment value="Mapping for ImmunizationCACore to Canadian Core Data for Interoperability (CACDI)." />
</mapping>
<human value="Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'" />
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<comment value="The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
</extension>
</extension>
<valueMarkdown value="Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</extension>
</extension>
</extension>
</binding>
</mapping>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
</type>
</element>
</element>
</discriminator>
</slicing>
</element>
</type>
</mapping>
</mapping>
</mapping>
</element>
</type>
</mapping>
</element>
</binding>
</mapping>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core" />
</type>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</mapping>
</element>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode" />
</binding>
</element>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode" />
</binding>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core" />
</type>
</element>
</differential>
</StructureDefinition>
{
],
{
{
},
{
}
]
}
],
"description": "This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context.",
],
"copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
{
}
],
{
{
"human": "Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'",
}
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
"comment": "The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips",
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
{
{
},
{
},
{
"valueMarkdown": "Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)."
}
],
},
{
{
},
{
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
}
],
}
],
},
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core"
]
}
]
},
{
},
{
}
},
{
],
{
},
{
},
{
}
]
},
{
],
]
},
{
},
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core"
]
}
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
]
},
{
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode"
}
},
{
}
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
]
}
]
}
]
}
}
Terminology bindings
| Path | Conformance | ValueSet |
|---|---|---|
| Immunization.vaccineCode | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode |
| Immunization.reportOrigin | preferred | https://fhir.infoway-inforoute.ca/ValueSet/immunizationreportingsourcecode |
| Immunization.site | preferred | https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode |
| Immunization.route | preferred | https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode |
Additional Terminology Bindings
These bindings may be used in lieu of the primary bindings in the table above.
| Path | Conformance | AdditionalValueSet |
|---|---|---|
| Immunization.vaccineCode | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccinehistoricalnamecode |
Mappings to CACDI
The following tables list how the data elements from CA Core+ map to CACDI. For more information visit Mapping Logic.
| FHIR Profile Element | CACDI Element(s) |
|---|---|
| Immunization.vaccineCode | Immunization |
| Immunization.occurrence[x]:occurrenceDateTime | Immunization Date, Event Start Date and Time, Reported Clinical Information Date Time |
| Immunization.occurrence[x]:occurrenceString | Reported Clinical Information Date Time |
| Immunization.reportOrigin | Reported Clinical Information Source (Recommended) |
| Immunization.lotNumber | Immunization Lot Number |
Constraints
The following table lists constraints (from differential).
| Path | Id | Grade | Details | Expression |
|---|---|---|---|---|
| Immunization | ca-core-im-1 | warning | Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true' | Immunization.primarySource = true implies Immunization.occurrence.exists() |