QI-Core Implementation Guide: STU 3.2 (v3.2.0 for FHIR 3.0.1)
This page is part of the Quality Improvement Core Framework (v3.2.0: STU 3) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions 
| Example of immunizationrecommendation using a vaccine code |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationrec
Profile of ImmunizationRecommendation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
This profile builds on ImmunizationRecommendation.
This profile was published on Wed Aug 22 00:00:00 AEST 2018 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 |
 recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| date | SΣ | 1..1 | dateTime | Date recommendation created |
| vaccineCode | SΣ | 0..1 | CodeableConcept | Vaccine recommendation applies to Binding: Vaccine Administered Value Set (CVX) (preferred) |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: Immunization Recommendation Target Disease Codes (example) |
| doseNumber | SΣ | 0..1 | positiveInt | Recommended dose number |
| forecastStatus | Σ | 1..1 | CodeableConcept | Vaccine administration status Binding: Immunization Recommendation Status Codes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed immunization |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | CodeableConcept | Type of date Binding: Immunization Recommendation Date Criterion Codes (example) | |
| value | 1..1 | dateTime | Recommended date | |
| protocol | I | 0..1 | BackboneElement | Protocol used by recommendation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| doseSequence | 0..1 | positiveInt | Dose number within sequence | |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Reference(QICore-Organization) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccination series | |
| supportingImmunization | 0..* | Reference(QICore-Immunization) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(QICore-Observation | QICore-AllergyIntolerance) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
Differential View
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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 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 |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| date | SΣ | 1..1 | dateTime | Date recommendation created |
| vaccineCode | SΣ | 0..1 | CodeableConcept | Vaccine recommendation applies to Binding: Vaccine Administered Value Set (CVX) (preferred) |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: Immunization Recommendation Target Disease Codes (example) |
| doseNumber | SΣ | 0..1 | positiveInt | Recommended dose number |
| forecastStatus | Σ | 1..1 | CodeableConcept | Vaccine administration status Binding: Immunization Recommendation Status Codes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed immunization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | 1..1 | CodeableConcept | Type of date Binding: Immunization Recommendation Date Criterion Codes (example) | |
| value | 1..1 | dateTime | Recommended date | |
| protocol | I | 0..1 | BackboneElement | Protocol used by recommendation |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| doseSequence | 0..1 | positiveInt | Dose number within sequence | |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Reference(QICore-Organization) | Who is responsible for protocol | |
| series | 0..1 | string | Name of vaccination series | |
| supportingImmunization | 0..* | Reference(QICore-Immunization) | 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 | preferred | Vaccine Administered Value Set (CVX) |
| 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-1 | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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 : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | ImmunizationRecommendation.recommendation | All FHIR elements must have a @value or children : hasValue() | (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() | (children().count() > id.count()) | |
| ele-1 | ImmunizationRecommendation.recommendation.protocol | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
© HL7.org 2011+. Package hl7.fhir.us.qicore#3.2.0 based on FHIR v3.0.1-11917. Generated on 14/04/2019
Links: Search |
QA Page |
|
Propose a change