QI-Core Implementation Guide
5.0.0 - STU5
QI-Core Implementation Guide
5.0.0 - STU5
This page is part of the Quality Improvement Core Framework (v5.0.0: STU5 (v5.0.0)) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrecommendation | Version: 5.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreImmunizationRecommendation | |||
Profile of ImmunizationRecommendation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
| Example of immunizationrecommendation using a vaccine code |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
  patient | S | 1..1 | Reference(QICore Patient) | Who this profile is for |
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |
  recommendation | S | 1..* | BackboneElement | Vaccine administration recommendations |
 vaccineCode | S | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set |
| doseNumber[x] | S | 0..1 | positiveInt, string | Recommended dose number within series |
| supportingImmunization | 0..* | Reference(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |
 supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
 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(QICore Patient) | Who this profile is for |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |
 recommendation | SΣC | 1..* | BackboneElement | Vaccine administration recommendations |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode | SΣ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set |
| forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
  doseNumber[x] | SΣ | 0..1 | Recommended dose number within series | |
 doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| supportingImmunization | 0..* | Reference(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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(QICore Patient) | Who this profile is for | ||||
| date | Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |||||
| recommendation | SΣC | 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: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set | ||||
| 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 | ?!Σ | 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 | 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] | SΣ | 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(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImmunizationRecommendation.language | preferred | CommonLanguages
| ||||
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set | ||||
| 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 | Grade | Path(s) | Details | Requirements |
| 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: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| patient | S | 1..1 | Reference(QICore Patient) | Who this profile is for |
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |
| recommendation | S | 1..* | BackboneElement | Vaccine administration recommendations |
| vaccineCode | S | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set |
| doseNumber[x] | S | 0..1 | positiveInt, string | Recommended dose number within series |
| supportingImmunization | 0..* | Reference(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| 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(QICore Patient) | Who this profile is for |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |
| recommendation | SΣC | 1..* | BackboneElement | Vaccine administration recommendations |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode | SΣ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set |
| forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
| doseNumber[x] | SΣ | 0..1 | Recommended dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| supportingImmunization | 0..* | Reference(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodes |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation | 0..* | ImmunizationRecommendation | 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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(QICore Patient) | Who this profile is for | ||||
| date | Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority | 0..1 | Reference(QICore Organization) | Who is responsible for protocol | |||||
| recommendation | SΣC | 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: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set | ||||
| 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 | ?!Σ | 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 | 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] | SΣ | 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(QICore Immunization | QICore ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation | 0..* | Reference(QICore Observation | QICore AllergyIntolerance) | Patient observations supporting recommendation | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImmunizationRecommendation.language | preferred | CommonLanguages
| ||||
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set | ||||
| 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 | Grade | Path(s) | Details | Requirements |
| 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: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ http://www.hl7.org/Special/committees/cqi/index.cfm. Package hl7.fhir.us.qicore#5.0.0 based on FHIR 4.0.1. Generated 2023-04-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change