FHIR Clinical Guidelines (v1.0.0) (STU1)

Clinical Practice Guidelines, published by Clinical Decision Support WG. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-cpg-immunizationrecommendation

Introduction:

Examples:

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunizationrecommendation

Recommendation for a particular immunization as part of the delivery of a computable clinical practice guideline

This profile builds on ImmunizationRecommendation.

This profile was published on Thu Jun 06 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CDS WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-instantiatesCanonical S0..1canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)Source
URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
... cpg-rationale S0..1markdownExplanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(CPGPatient)Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization)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: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... 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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... 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 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
.... 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 | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation S0..*Reference(Resource)Pertinent information

doco Documentation for this format

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... workflow-instantiatesCanonical S0..1canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire)Source
URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
... cpg-rationale S0..1markdownExplanation
URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(CPGPatient)Who this profile is for
... date SΣ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization)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: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

.... 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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... 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 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
.... 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 | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation S0..*Reference(Resource)Pertinent information

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

D.4.1.3 Constraints

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.extension:instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extension:instantiatesCanonicalMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.extension:rationaleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extension:rationaleMust 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())