QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)
QI-Core Implementation Guide - This is the current published version.. 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 UTC 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..* | ImmunizationRecommendation | Guidance or advice relating to an immunization |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Business identifier |
 patient | SΣI | 1..1 | Reference(QICorePatient) | Who this profile is for |
| date | ΣI | 1..1 | dateTime | Date recommendation(s) created |
| authority | I | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol |
 recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode | ΣI | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| targetDisease | ΣI | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example) |
| contraindicatedVaccineCode | ΣI | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example) |
| forecastStatus | ?!ΣI | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example) |
| forecastReason | ΣI | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed immunization |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example) |
| value | I | 1..1 | dateTime | Recommended date |
| description | I | 0..1 | string | Protocol details |
| series | I | 0..1 | string | Name of vaccination series |
 doseNumber[x] | ΣI | 0..1 | Recommended dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
| seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| supportingImmunization | I | 0..* | Reference(QICoreImmunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation |
| supportingPatientInformation | I | 0..* | Reference(QICoreObservation | QICoreAllergyIntolerance) | Patient observations supporting recommendation |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | I | 0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | Business identifier |
| patient | SΣI | 1..1 | Reference(QICorePatient) | Who this profile is for |
| date | ΣI | 1..1 | dateTime | Date recommendation(s) created |
| authority | I | 0..1 | Reference(QICoreOrganization) | Who is responsible for protocol |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode | ΣI | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| targetDisease | ΣI | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example) |
| contraindicatedVaccineCode | ΣI | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example) |
| forecastStatus | ?!ΣI | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example) |
| forecastReason | ΣI | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example) |
| dateCriterion | I | 0..* | BackboneElement | Dates governing proposed immunization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | I | 1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example) |
| value | I | 1..1 | dateTime | Recommended date |
| description | I | 0..1 | string | Protocol details |
| series | I | 0..1 | string | Name of vaccination series |
| doseNumber[x] | ΣI | 0..1 | Recommended dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
| seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| supportingImmunization | I | 0..* | Reference(QICoreImmunization | QICoreImmunizationEvaluation) | Past immunizations supporting recommendation |
| supportingPatientInformation | I | 0..* | Reference(QICoreObservation | QICoreAllergyIntolerance) | Patient observations supporting recommendation |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | USCoreVaccineAdministeredValueSetCvx |
| 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-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.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()) |
© HL7.org 2011+. (Clinical Quality Improvement WG). hl7.fhir.us.qicore#4.0.0 based on FHIR v4.0.1 Generated 2020-03-24.
Links: Home
| QA Report | Search
| Version History
| 
| Propose a change 
