This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-immunizationrecommendation
Profile of ImmunizationRecommendation for use with CPG Implementation Guide
This profile builds on ImmunizationRecommendation.
This profile was published on Thu Jun 06 00:00:00 EDT 2019 as a draft by Health Level Seven, Inc. - CDS WG.
Description of Profiles, Differentials, and Snapshots.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | 0..* | |||
workflow-instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
patient | S | 1..1 | Reference(Patient) | |
date | S | 1..1 | dateTime | |
recommendation | S | 1..* | BackboneElement | |
vaccineCode | S | 0..* | CodeableConcept | |
forecastStatus | S | 1..1 | CodeableConcept | |
dateCriterion | S | 0..* | BackboneElement | |
supportingPatientInformation | S | 0..* | Reference(Resource) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | I | 0..* | Guidance or advice relating to an immunization | |
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) Max Binding: AllLanguages | |
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 | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Business identifier |
patient | SΣ | 1..1 | Reference(Patient) | 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) |
targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example) |
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example) |
forecastStatus | ?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example) |
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example) |
dateCriterion | SI | 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) | |
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) | Patient observations supporting recommendation |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | 0..* | |||
workflow-instantiatesCanonical | S | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | S | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | S | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
identifier | S | 1..* | Identifier | |
patient | S | 1..1 | Reference(Patient) | |
date | S | 1..1 | dateTime | |
recommendation | S | 1..* | BackboneElement | |
vaccineCode | S | 0..* | CodeableConcept | |
forecastStatus | S | 1..1 | CodeableConcept | |
dateCriterion | S | 0..* | BackboneElement | |
supportingPatientInformation | S | 0..* | Reference(Resource) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ImmunizationRecommendation | I | 0..* | Guidance or advice relating to an immunization | |
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) Max Binding: AllLanguages | |
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 | SI | 0..* | canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire) | FHIR protocol or definition URL: http://hl7.org/fhir/StructureDefinition/workflow-instantiatesCanonical |
cqf-strengthOfRecommendation | SI | 0..* | CodeableConcept | The strength of the recommendation URL: http://hl7.org/fhir/StructureDefinition/cqf-strengthOfRecommendation Binding: StrengthOfRecommendationRating (example) |
cqf-qualityOfEvidence | SI | 0..* | CodeableConcept | The quality of the evidence URL: http://hl7.org/fhir/StructureDefinition/cqf-qualityOfEvidence Binding: QualityOfEvidenceRating (example) |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Business identifier |
patient | SΣ | 1..1 | Reference(Patient) | 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) |
targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example) |
contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example) |
forecastStatus | ?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example) |
forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example) |
dateCriterion | SI | 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) | |
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) | Patient observations supporting recommendation |
Documentation for this format |
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 |
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-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-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-6 | ImmunizationRecommendation | A resource should have narrative for robust management : text.div.exists() | |
dom-5 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
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 | 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 | 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 | 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.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.dateCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |