FHIR Clinical Guidelines (v1.0.0) (STU 1)

This page is part of the Clinical Guidelines (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition-cpg-immunizationrecommendation

Introduction:

This is an activity request profile

Examples:

ImmunizationRecommendation/ri-scenario2 ImmunizationRecommendation/ri-scenario2

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.

Text Summary
Differential Table
Snapshot Table
All

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
workflow-instantiatesCanonical	S	0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)	Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
cpg-rationale	S	0..1	markdown	Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
identifier	S	0..*	Identifier	Business identifier
patient	S	1..1	Reference(CPGPatient)	Who this profile is for
date	S	1..1	dateTime	Date recommendation(s) created
recommendation	S	1..*	BackboneElement	Vaccine administration recommendations
vaccineCode	S	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to
forecastStatus	S	1..1	CodeableConcept	Vaccine recommendation status
dateCriterion	S	0..*	BackboneElement	Dates governing proposed immunization
supportingPatientInformation	S	0..*	Reference(Resource)	Pertinent information
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
workflow-instantiatesCanonical	S	0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)	Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
cpg-rationale	S	0..1	markdown	Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business identifier
patient	SΣ	1..1	Reference(CPGPatient)	Who this profile is for
date	SΣ	1..1	dateTime	Date recommendation(s) created
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	SΣI	1..*	BackboneElement	Vaccine administration recommendations
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: VaccineAdministeredValueSet (example): The type of vaccine administered.
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
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		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		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 \| ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation	S	0..*	Reference(Resource)	Pertinent information
Documentation for this format

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

Differential View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
workflow-instantiatesCanonical	S	0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)	Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
cpg-rationale	S	0..1	markdown	Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
identifier	S	0..*	Identifier	Business identifier
patient	S	1..1	Reference(CPGPatient)	Who this profile is for
date	S	1..1	dateTime	Date recommendation(s) created
recommendation	S	1..*	BackboneElement	Vaccine administration recommendations
vaccineCode	S	0..*	CodeableConcept	Vaccine or vaccine group recommendation applies to
forecastStatus	S	1..1	CodeableConcept	Vaccine recommendation status
dateCriterion	S	0..*	BackboneElement	Dates governing proposed immunization
supportingPatientInformation	S	0..*	Reference(Resource)	Pertinent information
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
workflow-instantiatesCanonical	S	0..1	canonical(ActivityDefinition \| Measure \| OperationDefinition \| PlanDefinition \| Questionnaire)	Source URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical
cpg-rationale	S	0..1	markdown	Explanation URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	Business identifier
patient	SΣ	1..1	Reference(CPGPatient)	Who this profile is for
date	SΣ	1..1	dateTime	Date recommendation(s) created
authority		0..1	Reference(Organization)	Who is responsible for protocol
recommendation	SΣI	1..*	BackboneElement	Vaccine administration recommendations
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: VaccineAdministeredValueSet (example): The type of vaccine administered.
targetDisease	Σ	0..1	CodeableConcept	Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
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: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
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		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		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 \| ImmunizationEvaluation)	Past immunizations supporting recommendation
supportingPatientInformation	S	0..*	Reference(Resource)	Pertinent information
Documentation for this format

D.4.1.2 Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet
ImmunizationRecommendation.language	preferred	CommonLanguages Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCode	example	VaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.targetDisease	example	ImmunizationRecommendationTargetDiseaseCodes
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	example	VaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatus	example	ImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReason	example	ImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.code	example	ImmunizationRecommendationDateCriterionCodes

D.4.1.3 Constraints

Constraints

Id	Path	Details	Requirements
dom-2	ImmunizationRecommendation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	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	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	ImmunizationRecommendation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	ImmunizationRecommendation	A resource should have narrative for robust management : text.`div`.exists()
ele-1	ImmunizationRecommendation.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.extension:instantiatesCanonical	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.extension:instantiatesCanonical	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.extension:rationale	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.extension:rationale	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.patient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.date	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.authority	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
imr-1	ImmunizationRecommendation.recommendation	One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()
ele-1	ImmunizationRecommendation.recommendation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.recommendation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.recommendation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.recommendation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.recommendation.vaccineCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.targetDisease	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.contraindicatedVaccineCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.forecastStatus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.forecastReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.dateCriterion	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.dateCriterion.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.recommendation.dateCriterion.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	ImmunizationRecommendation.recommendation.dateCriterion.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.dateCriterion.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.description	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.series	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.doseNumber[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.seriesDoses[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.supportingImmunization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	ImmunizationRecommendation.recommendation.supportingPatientInformation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())