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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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)
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, 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 Results Reporting)	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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.protocolApplied.targetDisease	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Disease https://cvc.canimmunize.ca/v3/ValueSet/Disease

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
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)
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
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)
reasonReference		0..*	Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Results Reporting)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose 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 Results Reporting)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Disease https://cvc.canimmunize.ca/v3/ValueSet/Disease

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : 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-4	error	Immunization	If 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-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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)
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, 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 Results Reporting)	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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.protocolApplied.targetDisease	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Disease https://cvc.canimmunize.ca/v3/ValueSet/Disease

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
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)
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
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)
reasonReference		0..*	Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Results Reporting)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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 Bindings Purpose 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 Results Reporting)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.vaccineCode.coding:Generic	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Generic https://cvc.canimmunize.ca/v3/ValueSet/Generic
Immunization.vaccineCode.coding:Tradename	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Tradename https://cvc.canimmunize.ca/v3/ValueSet/Tradename
Immunization.reportOrigin	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RepSource https://cvc.canimmunize.ca/v3/ValueSet/RepSource
Immunization.site	preferred	https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite
Immunization.route	preferred	https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	https://cvc.canimmunize.ca/v3/ValueSet/Disease https://cvc.canimmunize.ca/v3/ValueSet/Disease

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	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 : 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-4	error	Immunization	If 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-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

This structure is derived from Immunization