QI-Core Implementation Guide
            
            5.0.0-ballot - STU Ballot
  US
            
          
This page is part of the Quality Improvement Core Framework (v5.0.0-ballot: STU 5 Ballot) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 7.0.1. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrec | Version: 5.0.0-ballot | |||
| 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
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints![]()  | 
|---|---|---|---|---|
![]()  | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]()  | S | 1..1 | Reference(QICorePatient) | Who this profile is for | 
![]() ![]()  | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol | |
![]() ![]()  | S | 1..* | BackboneElement | Vaccine administration recommendations | 
![]() ![]() ![]()  | S | 0..* | CodeableConcept | Vaccine  or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set  | 
![]() ![]() ![]()  | S | 0..1 | positiveInt, string | Recommended dose number within series | 
![]() ![]() ![]()  | 0..* | Reference(QICore Immunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation | |
![]() ![]() ![]()  | 0..* | Reference(QICore Observation | QICore Allergy Intolerance) | Patient observations supporting recommendation | |
  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
![]() ![]()  | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]()  | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]()  | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]()  | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]()  | SΣ | 1..1 | Reference(QICorePatient) | Who this profile is for | ||||
![]() ![]()  | Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]()  | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol | |||||
![]() ![]()  | SΣI | 1..* | BackboneElement | Vaccine administration recommendations | ||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | SΣ | 0..* | CodeableConcept | Vaccine  or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set  | ||||
![]() ![]() ![]()  | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.  | ||||
![]() ![]() ![]()  | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.  | ||||
![]() ![]() ![]()  | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.  | ||||
![]() ![]() ![]()  | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.  | ||||
![]() ![]() ![]()  | 0..* | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 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.).  | |||||
![]() ![]() ![]() ![]()  | 1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]()  | 0..1 | string | Protocol details | |||||
![]() ![]() ![]()  | 0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]()  | SΣ | 0..1 | Recommended dose number within series | |||||
![]() ![]() ![]() ![]()  | positiveInt | |||||||
![]() ![]() ![]() ![]()  | string | |||||||
![]() ![]() ![]()  | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]()  | positiveInt | |||||||
![]() ![]() ![]() ![]()  | string | |||||||
![]() ![]() ![]()  | 0..* | Reference(QICore Immunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]()  | 0..* | Reference(QICore Observation | QICore Allergy Intolerance) | Patient observations supporting recommendation | |||||
  Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints![]()  | 
|---|---|---|---|---|
![]()  | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]()  | Σ | 1..1 | Reference(QICorePatient) | Who this profile is for | 
![]() ![]()  | ΣI | 1..* | BackboneElement | Vaccine administration recommendations | 
![]() ![]() ![]()  | Σ | 0..* | CodeableConcept | Vaccine  or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set  | 
![]() ![]() ![]()  | Σ | 0..1 | Recommended dose number within series | |
![]() ![]() ![]() ![]()  | positiveInt | |||
![]() ![]() ![]() ![]()  | string | |||
  Documentation for this format | ||||
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![]()  | 
|---|---|---|---|---|
![]()  | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]()  | S | 1..1 | Reference(QICorePatient) | Who this profile is for | 
![]() ![]()  | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol | |
![]() ![]()  | S | 1..* | BackboneElement | Vaccine administration recommendations | 
![]() ![]() ![]()  | S | 0..* | CodeableConcept | Vaccine  or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set  | 
![]() ![]() ![]()  | S | 0..1 | positiveInt, string | Recommended dose number within series | 
![]() ![]() ![]()  | 0..* | Reference(QICore Immunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation | |
![]() ![]() ![]()  | 0..* | Reference(QICore Observation | QICore Allergy Intolerance) | Patient observations supporting recommendation | |
  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
![]() ![]()  | Σ | 0..1 | string | Logical id of this artifact | ||||
![]() ![]()  | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]()  | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]()  | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]()  | SΣ | 1..1 | Reference(QICorePatient) | Who this profile is for | ||||
![]() ![]()  | Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]()  | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol | |||||
![]() ![]()  | SΣI | 1..* | BackboneElement | Vaccine administration recommendations | ||||
![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | SΣ | 0..* | CodeableConcept | Vaccine  or vaccine group recommendation applies to Binding: CVX Vaccines Administered Vaccine Set (extensible): CVX Vaccines Administered Vaccine Set  | ||||
![]() ![]() ![]()  | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.  | ||||
![]() ![]() ![]()  | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.  | ||||
![]() ![]() ![]()  | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.  | ||||
![]() ![]() ![]()  | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.  | ||||
![]() ![]() ![]()  | 0..* | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]()  | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 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.).  | |||||
![]() ![]() ![]() ![]()  | 1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]()  | 0..1 | string | Protocol details | |||||
![]() ![]() ![]()  | 0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]()  | SΣ | 0..1 | Recommended dose number within series | |||||
![]() ![]() ![]() ![]()  | positiveInt | |||||||
![]() ![]() ![]() ![]()  | string | |||||||
![]() ![]() ![]()  | 0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]()  | positiveInt | |||||||
![]() ![]() ![]() ![]()  | string | |||||||
![]() ![]() ![]()  | 0..* | Reference(QICore Immunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]()  | 0..* | Reference(QICore Observation | QICore Allergy Intolerance) | Patient observations supporting recommendation | |||||
  Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | 
| ImmunizationRecommendation.language | preferred | CommonLanguages Max Binding: AllLanguages  | 
| 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 | 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 | ImmunizationRecommendation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists()  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.recommendation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.recommendation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.forecastStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.forecastReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.dateCriterion.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.supportingImmunization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ele-1 | error | ImmunizationRecommendation.recommendation.supportingPatientInformation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  |