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 immunization evaluation |
The official URL for this profile is:
http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation
Defines constraints and extensions on the ImmunizationEvaluation resource for the minimal set of data to query and retrieve a patient's Immunization Evaluation.
This profile builds on ImmunizationEvaluation.
This profile was published on Sun Jul 28 00:00:00 UTC 2019 as a draft by Health Level Seven, Inc. - CQI WG.
Description of Profiles, Differentials, and Snapshots.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationEvaluation | I | 0..* | ImmunizationEvaluation | Immunization evaluation information |
  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 | SI | 0..* | Identifier | Business identifier |
| status | ?!SΣI | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required) |
 patient | SΣI | 1..1 | Reference(QICorePatient) | Who this evaluation is for |
| date | SI | 1..1 | dateTime | Date evaluation was performed |
| authority | I | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations |
| targetDisease | SΣI | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (example) |
| immunizationEvent | SΣI | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated |
| doseStatus | SΣI | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (example) |
| doseStatusReason | SI | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example) |
| description | I | 0..1 | string | Evaluation notes |
| series | I | 0..1 | string | Name of vaccine series |
 doseNumber[x] | I | 0..1 | Dose number within series | |
 doseNumberPositiveInt | positiveInt | |||
 doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
 seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationEvaluation | I | 0..* | ImmunizationEvaluation | Immunization evaluation information |
| 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 | SI | 0..* | Identifier | Business identifier |
| status | ?!SΣI | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required) |
| patient | SΣI | 1..1 | Reference(QICorePatient) | Who this evaluation is for |
| date | SI | 1..1 | dateTime | Date evaluation was performed |
| authority | I | 0..1 | Reference(QICoreOrganization) | Who is responsible for publishing the recommendations |
| targetDisease | SΣI | 1..1 | CodeableConcept | Evaluation target disease Binding: ImmunizationEvaluationTargetDiseaseCodes (example) |
| immunizationEvent | SΣI | 1..1 | Reference(QICoreImmunization) | Immunization being evaluated |
| doseStatus | SΣI | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (example) |
| doseStatusReason | SI | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (example) |
| description | I | 0..1 | string | Evaluation notes |
| series | I | 0..1 | string | Name of vaccine series |
| doseNumber[x] | I | 0..1 | Dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
| seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImmunizationEvaluation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationEvaluation.status | required | ImmunizationEvaluationStatusCodes |
| ImmunizationEvaluation.targetDisease | example | ImmunizationEvaluationTargetDiseaseCodes |
| ImmunizationEvaluation.doseStatus | example | ImmunizationEvaluationDoseStatusCodes |
| ImmunizationEvaluation.doseStatusReason | example | ImmunizationEvaluationDoseStatusReasonCodes |
| Id | Path | Details | Requirements |
| dom-2 | ImmunizationEvaluation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | ImmunizationEvaluation | 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 | ImmunizationEvaluation | 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 | ImmunizationEvaluation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | ImmunizationEvaluation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | ImmunizationEvaluation.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationEvaluation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationEvaluation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ImmunizationEvaluation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ImmunizationEvaluation.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.immunizationEvent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.doseStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.doseStatusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ImmunizationEvaluation.seriesDoses[x] | 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 
