Canadian Baseline
1.2.0 - CI Build

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.2.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: ImmunizationRecommendation Profile

Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunizationrecommendation | Version: 1.2.0
Draft as of 2024-08-09 | Computable Name: ImmunizationRecommendationProfile

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

# CA Baseline ImmunizationRecommendation Profile

Usages:

- Refer to this Profile: Encounter Profile and MedicationRequest Profile

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
patient | S Σ | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
vaccineCode | S Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
Slices for coding | Σ | 0..* | 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)
targetDisease | S Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
forecastStatus | ?!S Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed immunization
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | S | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value | S | 1..1 | dateTime | Recommended date
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
patient | S | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S | 1..* | BackboneElement | Vaccine administration recommendations
vaccineCode | S | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
Slices for coding |  | 0..* | 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)
targetDisease | S | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
forecastStatus | S | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed immunization
code | S | 1..1 | CodeableConcept | Type of date
value | S | 1..1 | dateTime | Recommended date
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
patient | S Σ | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
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
vaccineCode | S Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
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 | Σ | 0..* | 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
targetDisease | S Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus | ?!S Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed 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
code | S | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value | S | 1..1 | dateTime | Recommended date
description |  | 0..1 | string | Protocol details
series |  | 0..1 | string | Name of vaccination series
doseNumber[x] | Σ | 0..1 |  | Recommended dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
supportingPatientInformation |  | 0..* | Reference(Resource) | Patient observations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastReason | Base | example | Immunization Recommendation Reason Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Summary

Must-Support: 9 elements

Structures

This structure refers to these other structures:

- Patient Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient)
- Organization Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organization)
- Immunization Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization)

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of ImmunizationRecommendation.recommendation.vaccineCode.coding

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
patient | S Σ | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
vaccineCode | S Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
Slices for coding | Σ | 0..* | 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)
targetDisease | S Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
forecastStatus | ?!S Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed immunization
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | S | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value | S | 1..1 | dateTime | Recommended date
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

Differential View

This structure is derived from ImmunizationRecommendation

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
patient | S | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S | 1..* | BackboneElement | Vaccine administration recommendations
vaccineCode | S | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
Slices for coding |  | 0..* | 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)
targetDisease | S | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
forecastStatus | S | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed immunization
code | S | 1..1 | CodeableConcept | Type of date
value | S | 1..1 | dateTime | Recommended date
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImmunizationRecommendation |  | 0..* | ImmunizationRecommendation | ImmunizationRecommendation Profile
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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
patient | S Σ | 1..1 | Reference(Patient Profile) | Who this profile is for
date | S Σ | 1..1 | dateTime | Date recommendation(s) created
authority |  | 0..1 | Reference(Organization Profile) | Who is responsible for protocol
recommendation | S Σ C | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1
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
vaccineCode | S Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
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 | Σ | 0..* | 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
targetDisease | S Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
forecastStatus | ?!S Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
dateCriterion | S | 0..* | BackboneElement | Dates governing proposed 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
code | S | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
value | S | 1..1 | dateTime | Recommended date
description |  | 0..1 | string | Protocol details
series |  | 0..1 | string | Name of vaccination series
doseNumber[x] | Σ | 0..1 |  | Recommended dose number within series
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
supportingImmunization |  | 0..* | Reference(Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation
supportingPatientInformation |  | 0..* | Reference(Resource) | Patient observations supporting recommendation
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
ImmunizationRecommendation.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Generic | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Generic | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.vaccineCode.​coding:Tradename | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Tradename | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.targetDisease | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/Disease | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus | Base | preferred | https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus | Not Stated | Unknown
ImmunizationRecommendation.​recommendation.forecastReason | Base | example | Immunization Recommendation Reason Codes | 📍4.0.1 | FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code | Base | example | Immunization Recommendation Date Criterion Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ImmunizationRecommendation | 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()`
imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present | `vaccineCode.exists() or targetDisease.exists()`

This structure is derived from ImmunizationRecommendation

Summary

Must-Support: 9 elements

Structures

This structure refers to these other structures:

- Patient Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient)
- Organization Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organization)
- Immunization Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization)

Slices

This structure defines the following Slices:

- The element 2 is sliced based on the values of ImmunizationRecommendation.recommendation.vaccineCode.coding

Other representations of profile: CSV, Excel, Schematron