Immunization (CA-Core)

Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at package/structuredefinition-immunization-ca-core.json

This profile imposes the CA Baseline (v1.1.7) Immunization Profile.

Profile

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifier0..*Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ1..1code
id0..1string
translationI0..*Extension(Complex)
value0..1System.String
userSelectedΣ0..1boolean
textΣ0..1string
patientS Σ I1..1Reference(PatientCACore)
encounterI0..1Reference(Encounter)
occurrenceStringstring
occurrenceDateTimeS Σ0..1dateTime
recorded0..1dateTime
primarySourceΣ0..1boolean
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
locationI0..1Reference(Location)
manufacturerI0..1Reference(Organization)
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConcept
route0..1CodeableConcept
doseQuantityI0..1SimpleQuantity
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(Practitioner | PractitionerRole | Organization)
noteΣ0..*Annotation
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation | DiagnosticReport)
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
date0..1dateTime
detailI0..1Reference(Observation)
reported0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
series0..1string
authorityI0..1Reference(Organization)
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Obligations

Obligations are a new (and evolving) mechanism in FHIR to provide a consistent and machine processable way for profiles to define their expectations for system behaviors.

This profile utilizes the Obligation Extension to convey these expectations.

Note: Simplifier is working on rendering of Obligations. In the meantime the Obligations applied on the profile (see JSON & XML structure) have been rendered as a table below for easier viewing.

Obligation Code Actor Elements
SHALL:able-to-populate Server Actor (CA Core) vaccineCode, vaccineCode.coding, vaccineCode.coding.code, vaccineCode.coding.display, patient, occurrence[x]:occurrenceDateTime, reportOrigin, reportOrigin.coding, reportOrigin.coding.code
SHALL:handle Client Actor (CA Core) ​vaccineCode, vaccineCode.coding, vaccineCode.coding.code, vaccineCode.coding.display, patient, occurrence[x]:occurrenceDateTime, reportOrigin, reportOrigin.coding, reportOrigin.coding.code

Terminology

This version of the guide is based on the early content development of the pan-Canadian Health Data Content Framework (pCHDCF) and CACDI. The pCHDCF is beginning to introduce recommended terminology for select concepts. Implementers should be aware that the identification of preferred terminology continues to progress and that some coded elements may have terminology recommendations added in future releases.

Note: Implementers should be aware of the limitations in some terminology referenced in this guide that is not fully expressed as an enumerated FHIR ValueSet or resolvable FHIR CodeSystems. Readers should refer to the Known Issues & Future Development page.

Bindings

Primary bindings are expressed in the rendering of the profile above (as well as can be found in the JSON/XML file).

Additional terminology bindings are also expressed in this profile to surface Alternate Value Sets expressed in the pCHDCF Data Content Standard.

Additional terminology bindings can be viewed by scrolling over the element in the table above.

Note: In future releases, 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

Mappings to pCHDCF-CACDI Logical Data Model

MappingCACDI Logical Data Model ElementFHIR Profile ElementComment
pCHDCF-CACDIImmunizationImmunization
pCHDCF-CACDIDrugImmunization.vaccineCode
Immunization.vaccineCode.coding
pCHDCF-CACDIDrug CodeImmunization.vaccineCode.coding.code
pCHDCF-CACDI; pCHDCF-CACDIDrug English Description; Drug French DescriptionImmunization.vaccineCode.coding.displayDisplay may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension; Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension
Immunization.vaccineCode.coding.display.extension:translation
pCHDCF-CACDIPatientImmunization.patient
Immunization.occurrence[x]
pCHDCF-CACDI; pCHDCF-CACDIPatient Provided Immunization Date; Event Start Date TimeImmunization.occurrence[x]:occurrenceDateTime
Immunization.primarySource
Immunization.reportOrigin
Immunization.reportOrigin.coding
pCHDCF-CACDIImmunization Reporting Source CodeImmunization.reportOrigin.coding.code

Additional Mapping Notes

Immunization.vaccineCode.coding.display - Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension