Canadian Baseline
1.1.0 - CI Build Canada flag

Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions

Resource Profile: Immunization Profile

Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization Version: 1.1.0
Draft as of 2024-12-13 Computable Name: ImmunizationProfile

Proposed constraints and extensions on the Immunization resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.

This profile was generated from HL7 StructureDefinition on 2019-03-28 and constrained during a review of US Core against Canadian sources.

Note The USCoreR4 resource supports recording of vaccines not given (refused) with reasons. The Ontario Immunization Connect (ICON) profiles has fixed values for Immunization.status and Immunization.notGiven that restrict use to completed vaccinations. « As in USCoreR4, refused vaccines are supported in this profile.

Key differences from USCoreR4 Immunization:

  • Immunization.code bound to ValueSet with Canadian vaccine codes
  • Immunization.patient reference changed to profile-patient
  • Immunization.occurrenceDateTime:estimated extension added to identify estimated dates to be more consistent with ICON and CDN HL7v3 specs
  • included other Immunization resource elements used in the ICON spec for visibility

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... status S 1..1 code completed | entered-in-error | not-done
... statusReason 0..1 CodeableConcept Reason not done
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
..... coding:Generic 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
..... coding:Tradename 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
... primarySource 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
... location 0..1 Reference(Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(Organization Profile) Vaccine manufacturer
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
... performer
.... actor 1..1 Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Organization Profile) Individual or organization who was performing
... reasonReference 0..* Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) Why immunization occurred
... reaction
.... detail 0..1 Reference(Observation Profile (General Use)) Additional information on reaction
... protocolApplied
.... authority 0..1 Reference(Organization Profile) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.protocolApplied.targetDiseasepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Disease
https://cvc.canimmunize.ca/v3/ValueSet/Disease
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.


ele-1: All FHIR elements must have a @value or children
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
ele-1: All FHIR elements must have a @value or children
..... coding:Generic Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
ele-1: All FHIR elements must have a @value or children
..... coding:Tradename Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(Patient Profile) Who was immunized
ele-1: All FHIR elements must have a @value or children
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
ele-1: All FHIR elements must have a @value or children
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Vaccine administration date
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... primarySource Σ 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
ele-1: All FHIR elements must have a @value or children
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
ele-1: All FHIR elements must have a @value or children
... location 0..1 Reference(Location Profile) Where immunization occurred
ele-1: All FHIR elements must have a @value or children
... manufacturer 0..1 Reference(Organization Profile) Vaccine manufacturer
ele-1: All FHIR elements must have a @value or children
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
ele-1: All FHIR elements must have a @value or children
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference 0..* Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) Why immunization occurred
ele-1: All FHIR elements must have a @value or children
... isSubpotent ?!Σ 0..1 boolean Dose potency
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
from the FHIR Standard
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
..... coding:Generic Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
..... coding:Tradename Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient Profile) Who was immunized
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Vaccine administration date
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
..... value 0..1 dateTime Primitive value for dateTime
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
... location 0..1 Reference(Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(Organization Profile) 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: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
... doseQuantity 0..1 SimpleQuantity 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 Profile (General) | PractitionerRole Profile (General) | Organization Profile) 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 Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) 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
imm-1: One of documentType or reference SHALL be present
.... 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 Profile (General Use)) 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 Profile) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
from the FHIR Standard
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Disease
https://cvc.canimmunize.ca/v3/ValueSet/Disease

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Immunization.vaccineCode.coding
  • The element 1 is sliced based on the value of Immunization.occurrence[x] (Closed)

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... status S 1..1 code completed | entered-in-error | not-done
... statusReason 0..1 CodeableConcept Reason not done
... vaccineCode S 1..1 CodeableConcept Vaccine product administered
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
..... coding:Generic 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
..... coding:Tradename 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Vaccine administration date
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
... primarySource 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
... location 0..1 Reference(Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(Organization Profile) Vaccine manufacturer
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
... performer
.... actor 1..1 Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Organization Profile) Individual or organization who was performing
... reasonReference 0..* Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) Why immunization occurred
... reaction
.... detail 0..1 Reference(Observation Profile (General Use)) Additional information on reaction
... protocolApplied
.... authority 0..1 Reference(Organization Profile) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.protocolApplied.targetDiseasepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Disease
https://cvc.canimmunize.ca/v3/ValueSet/Disease

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.


ele-1: All FHIR elements must have a @value or children
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
ele-1: All FHIR elements must have a @value or children
..... coding:Generic Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
ele-1: All FHIR elements must have a @value or children
..... coding:Tradename Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(Patient Profile) Who was immunized
ele-1: All FHIR elements must have a @value or children
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
ele-1: All FHIR elements must have a @value or children
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Vaccine administration date
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... primarySource Σ 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
ele-1: All FHIR elements must have a @value or children
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
ele-1: All FHIR elements must have a @value or children
... location 0..1 Reference(Location Profile) Where immunization occurred
ele-1: All FHIR elements must have a @value or children
... manufacturer 0..1 Reference(Organization Profile) Vaccine manufacturer
ele-1: All FHIR elements must have a @value or children
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
ele-1: All FHIR elements must have a @value or children
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference 0..* Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) Why immunization occurred
ele-1: All FHIR elements must have a @value or children
... isSubpotent ?!Σ 0..1 boolean Dose potency
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
from the FHIR Standard
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... 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 ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1 CodeableConcept Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system, pattern:code
..... coding:Generic Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
..... coding:Tradename Σ 0..1 Coding Code defined by a terminology system
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Tradename (preferred)
.... text Σ 0..1 string Plain text representation of the concept
... patient SΣ 1..1 Reference(Patient Profile) Who was immunized
... encounter 0..1 Reference(Encounter Profile) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Vaccine administration date
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... estimated 0..1 boolean Information entered is is an estimate
URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated
..... value 0..1 dateTime Primitive value for dateTime
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates that data is from the primary record created at the time the vaccine was administered.
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RepSource (preferred)
... location 0..1 Reference(Location Profile) Where immunization occurred
... manufacturer 0..1 Reference(Organization Profile) 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: https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin (preferred)
... doseQuantity 0..1 SimpleQuantity 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 Profile (General) | PractitionerRole Profile (General) | Organization Profile) 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 Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile) 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
imm-1: One of documentType or reference SHALL be present
.... 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 Profile (General Use)) 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 Profile) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
from the FHIR Standard
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:Genericpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradenamepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Tradename
https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOriginpreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RepSource
https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.sitepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.routepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
from the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseasepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Disease
https://cvc.canimmunize.ca/v3/ValueSet/Disease

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Immunization.vaccineCode.coding
  • The element 1 is sliced based on the value of Immunization.occurrence[x] (Closed)

 

Other representations of profile: CSV, Excel, Schematron