This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition-immds-immunizationevaluation
Scope and Usage
Defines constraints and extensions on the immunizationevaluation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation.
Must Support
For CDS engines, the engine must be capable of generating the Must Support elements even though the CDS process may not always result in a value. For example, there may not always be a doseStatusReason and invalid doses may not have a dose number. For the system requesting the forecast, that system must be capable of receiving the Must Support elements from the engine and when appropriate presenting them back to a user (either through a IU or through an HL7 message, etc).
Examples
The following examples are provided to illustrate conformant resource content to this profile.
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/immds/StructureDefinition/immds-immunizationevaluation
Published on Thu Jun 27 20:00:00 EDT 2019 as a active by HL7 International - Public Health Work Group.
This profile builds on ImmunizationEvaluation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationEvaluation | 0..* | ImmDS Immunization evaluation information | ||
  date | 1..1 | dateTime | Date evaluation was performed | |
 targetDisease | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| doseStatus | Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (extensible) |
 doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (extensible) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationEvaluation | I | 0..* | ImmDS Immunization evaluation information | |
| 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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 | |
| status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required) |
 patient | Σ | 1..1 | Reference(Patient) | Who this evaluation is for |
| date | 1..1 | dateTime | Date evaluation was performed | |
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
| targetDisease | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| immunizationEvent | Σ | 1..1 | Reference(Immunization) | Immunization being evaluated |
| doseStatus | Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (extensible) |
| doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (extensible) |
| description | 0..1 | string | Evaluation notes | |
| series | 0..1 | string | Name of vaccine series | |
 doseNumber[x] | 0..1 | positiveInt, string | Dose number within series | |
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationEvaluation | 0..* | ImmDS Immunization evaluation information | ||
| date | 1..1 | dateTime | Date evaluation was performed | |
| targetDisease | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| doseStatus | Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (extensible) |
| doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (extensible) |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationEvaluation | I | 0..* | ImmDS Immunization evaluation information | |
| 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: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 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 | |
| status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: ImmunizationEvaluationStatusCodes (required) |
| patient | Σ | 1..1 | Reference(Patient) | Who this evaluation is for |
| date | 1..1 | dateTime | Date evaluation was performed | |
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |
| targetDisease | Σ | 1..1 | CodeableConcept | Evaluation target disease Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| immunizationEvent | Σ | 1..1 | Reference(Immunization) | Immunization being evaluated |
| doseStatus | Σ | 1..1 | CodeableConcept | Status of the dose relative to published recommendations Binding: ImmunizationEvaluationDoseStatusCodes (extensible) |
| doseStatusReason | S | 0..* | CodeableConcept | Reason for the dose status Binding: ImmunizationEvaluationDoseStatusReasonCodes (extensible) |
| description | 0..1 | string | Evaluation notes | |
| series | 0..1 | string | Name of vaccine series | |
| doseNumber[x] | 0..1 | positiveInt, string | Dose number within series | |
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| ImmunizationEvaluation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationEvaluation.status | required | ImmunizationEvaluationStatusCodes |
| ImmunizationEvaluation.targetDisease | extensible | USCoreVaccineAdministeredValueSetCvx |
| ImmunizationEvaluation.doseStatus | extensible | ImmunizationEvaluationDoseStatusCodes |
| ImmunizationEvaluation.doseStatusReason | extensible | ImmunizationEvaluationDoseStatusReasonCodes |
Constraints
| 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-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-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-6 | ImmunizationEvaluation | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | ImmunizationEvaluation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
