Canadian Core
0.1.0 - CI Build

Canadian Core, published by Canadian FHIR Implementor Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/scratch-fhir-profiles/CA-Core/ and changes regularly. See the Directory of published versions

Resource Profile: ImmunizationRecommendation Profile

Defining URL:http://hl7.org/fhir/ca/core/StructureDefinition/profile-immunizationrecommendation
Version:0.1.0
Name:ImmunizationRecommendationProfile
Title:ImmunizationRecommendation Profile
Status:Draft as of 2020-03-26
Definition:

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

Publisher:Canadian FHIR Implementor Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/ca/core/StructureDefinition/profile-immunizationrecommendation

Formal Views of Profile Content

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

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationImmunizationRecommendation Profile
... patient S1..1Reference(Patient Profile)Who this profile is for
... date S1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization Profile)Who is responsible for protocol
.... vaccineCode S0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
.... targetDisease S0..1CodeableConceptDisease to be immunized against
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... forecastStatus S1..1CodeableConceptVaccine recommendation status
Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
.... dateCriterion S0..*BackboneElementDates governing proposed immunization
..... code S1..1CodeableConceptType of date
..... value S1..1dateTimeRecommended date
.... supportingImmunization 0..*Reference(Immunization Profile | ImmunizationEvaluation)Past immunizations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationImmunizationRecommendation Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(Patient Profile)Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization Profile)Who is responsible for protocol
... recommendation SΣI1..*BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
.... targetDisease SΣ0..1CodeableConceptDisease to be immunized against
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!SΣ1..1CodeableConceptVaccine recommendation status
Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion S0..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptType 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 S1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization Profile | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationImmunizationRecommendation Profile
... patient Σ1..1Reference(Patient Profile)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
.... vaccineCode Σ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
.... dateCriterion 0..*BackboneElementDates governing proposed immunization
..... code 1..1CodeableConceptType 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 1..1dateTimeRecommended date

doco Documentation for this format

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationImmunizationRecommendation Profile
... patient S1..1Reference(Patient Profile)Who this profile is for
... date S1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization Profile)Who is responsible for protocol
.... vaccineCode S0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
.... targetDisease S0..1CodeableConceptDisease to be immunized against
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... forecastStatus S1..1CodeableConceptVaccine recommendation status
Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
.... dateCriterion S0..*BackboneElementDates governing proposed immunization
..... code S1..1CodeableConceptType of date
..... value S1..1dateTimeRecommended date
.... supportingImmunization 0..*Reference(Immunization Profile | ImmunizationEvaluation)Past immunizations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationImmunizationRecommendation Profile
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(Patient Profile)Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization Profile)Who is responsible for protocol
... recommendation SΣI1..*BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ0..*CodeableConceptVaccine or vaccine group recommendation applies to
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Generic (preferred)
.... targetDisease SΣ0..1CodeableConceptDisease to be immunized against
Binding: https://cvc.canimmunize.ca/v3/ValueSet/Disease (preferred)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!SΣ1..1CodeableConceptVaccine recommendation status
Binding: https://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus (preferred)
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion S0..*BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code S1..1CodeableConceptType 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 S1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization Profile | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Generic
ImmunizationRecommendation.recommendation.targetDiseasepreferredhttps://cvc.canimmunize.ca/v3/ValueSet/Disease
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatuspreferredhttps://cvc.canimmunize.ca/v3/ValueSet/ForecastStatus
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdPathDetailsRequirements
dom-2ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationRecommendationIf 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-4ImmunizationRecommendationIf 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-5ImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1ImmunizationRecommendation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1ImmunizationRecommendation.recommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingImmunizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingPatientInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())