2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.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/Profile/cqf-immunizationrecommendation-cqf-immunizationrecommendation
. Profile of immunization recommendation for decision support/quality metrics. Indicates which elements must be supported by CQF rules and measure engines. : Clinical Quality Framework (CQF) Immunization Recommendation Profile
This profile was published on Mon, Nov 3, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.
Required/Prohibited Elements
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Differential View
This structure is derived from ImmunizationRecommendation.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation | 1..1 | |||
  patient | S | 1..1 | Patient | |
 recommendation | S | 1..* | ||
  date | S | 1..1 | dateTime | |
 vaccineType | S | 1..1 | CodeableConcept | |
| doseNumber | S | 0..1 | integer | |
| forecastStatus | 1..1 | CodeableConcept | ||
| dateCriterion | S | 0..* | ||
 code | 1..1 | CodeableConcept | ||
| value | S | 1..1 | dateTime | |
| protocol | S | 0..1 | ||
| doseSequence | S | 0..1 | integer | |
| series | S | 0..1 | string | |
| supportingImmunization | 0..* | Immunization | ||
| supportingPatientInformation | 0..* | Observation, AllergyIntolerance |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 1..1 | Immunization profile | ||
| id | 0..1 | id | Logical id of this artefact | |
 meta | 0..1 | Meta | Metadata about the resource | |
| implicitRules | M | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Language (required, not extensible) | |
| 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 | Patient | Who this profile is for |
| recommendation | S | 1..* | Vaccine administration recommendations | |
| id | 0..1 | id | 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 |
| vaccineType | S | 1..1 | CodeableConcept | Vaccine recommendation applies to Binding: VaccineType (example, extensible) |
| doseNumber | S | 0..1 | integer | Recommended dose number |
| forecastStatus | 1..1 | CodeableConcept | Vaccine administration status Binding: ImmunizationRecommendationStatus (example, extensible) | |
| dateCriterion | S | 0..* | Dates governing proposed immunization | |
| id | 0..1 | id | 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: ImmunizationRecommendationDateCriterion (example, extensible) | |
| value | S | 1..1 | dateTime | Recommended date |
| protocol | S | 0..1 | Protocol used by recommendation | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
| doseSequence | S | 0..1 | integer | Number of dose within sequence |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Organization | Who is responsible for protocol | |
| series | S | 0..1 | string | Name of vaccination series |
| supportingImmunization | 0..* | Immunization | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Observation, AllergyIntolerance | Patient observations supporting recommendation |
XML Template
JSON Template
todo
Differential View
This structure is derived from ImmunizationRecommendation.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 1..1 | |||
| patient | S | 1..1 | Patient | |
| recommendation | S | 1..* | ||
| date | S | 1..1 | dateTime | |
| vaccineType | S | 1..1 | CodeableConcept | |
| doseNumber | S | 0..1 | integer | |
| forecastStatus | 1..1 | CodeableConcept | ||
| dateCriterion | S | 0..* | ||
| code | 1..1 | CodeableConcept | ||
| value | S | 1..1 | dateTime | |
| protocol | S | 0..1 | ||
| doseSequence | S | 0..1 | integer | |
| series | S | 0..1 | string | |
| supportingImmunization | 0..* | Immunization | ||
| supportingPatientInformation | 0..* | Observation, AllergyIntolerance |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | 1..1 | Immunization profile | ||
| id | 0..1 | id | Logical id of this artefact | |
| meta | 0..1 | Meta | Metadata about the resource | |
| implicitRules | M | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Language (required, not extensible) | |
| 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 | Patient | Who this profile is for |
| recommendation | S | 1..* | Vaccine administration recommendations | |
| id | 0..1 | id | 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 |
| vaccineType | S | 1..1 | CodeableConcept | Vaccine recommendation applies to Binding: VaccineType (example, extensible) |
| doseNumber | S | 0..1 | integer | Recommended dose number |
| forecastStatus | 1..1 | CodeableConcept | Vaccine administration status Binding: ImmunizationRecommendationStatus (example, extensible) | |
| dateCriterion | S | 0..* | Dates governing proposed immunization | |
| id | 0..1 | id | 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: ImmunizationRecommendationDateCriterion (example, extensible) | |
| value | S | 1..1 | dateTime | Recommended date |
| protocol | S | 0..1 | Protocol used by recommendation | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
| doseSequence | S | 0..1 | integer | Number of dose within sequence |
| description | 0..1 | string | Protocol details | |
| authority | 0..1 | Organization | Who is responsible for protocol | |
| series | S | 0..1 | string | Name of vaccination series |
| supportingImmunization | 0..* | Immunization | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Observation, AllergyIntolerance | Patient observations supporting recommendation |
XML Template
JSON Template
todo
Other definitions: (todo)
| Path | Name | Conformance | ValueSet |
| ImmunizationRecommendation.language | Language | required | http://tools.ietf.org/html/bcp47 |
| ImmunizationRecommendation.recommendation.vaccineType | VaccineType | example (extensible) | v3 Code System VaccineType |
| ImmunizationRecommendation.recommendation.forecastStatus | ImmunizationRecommendationStatus | example (extensible) | Immunization Recommendation Status Codes |
| ImmunizationRecommendation.recommendation.dateCriterion.code | ImmunizationRecommendationDateCriterion | example (extensible) | Immunization Recommendation Date Criterion Codes |
| Id | Path | Name | Details |
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:20+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change