Immunization Decision Support Forecast (ImmDS) Implementation Guide
1.0.0 - STU1

This page is part of the Immunization Decision Support Forecast FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: ImmDSImmunizationEvaluation

An evaluation of an Immunization event for the patient against a set of recommendations.

The official URL for this profile is: 

http://hl7.org/fhir/us/immds/StructureDefinition/immds-immunizationevaluation

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ImmunizationEvaluation

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... patient 1..1Reference(ImmDS Patient)Who this evaluation is for
... date 1..1dateTimeDate evaluation was performed
... targetDisease 1..1CodeableConceptEvaluation target disease
Binding: Vaccine Target Disease (extensible)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: Evaluation Status Reason (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... patient Σ1..1Reference(ImmDS Patient)Who this evaluation is for
... date 1..1dateTimeDate evaluation was performed
... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
... targetDisease Σ1..1CodeableConceptEvaluation target disease
Binding: Vaccine Target Disease (extensible)
... immunizationEvent Σ1..1Reference(Immunization)Immunization being evaluated
... doseStatus Σ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (extensible)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: Evaluation Status Reason (extensible)
... description 0..1stringEvaluation notes
... series 0..1stringName of vaccine series
... doseNumber[x] 0..1Dose number within series
.... doseNumberPositiveIntpositiveInt
.... doseNumberStringstring
... seriesDoses[x] 0..1Recommended number of doses for immunity
.... seriesDosesPositiveIntpositiveInt
.... seriesDosesStringstring

doco Documentation for this format

This structure is derived from ImmunizationEvaluation

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... patient 1..1Reference(ImmDS Patient)Who this evaluation is for
... date 1..1dateTimeDate evaluation was performed
... targetDisease 1..1CodeableConceptEvaluation target disease
Binding: Vaccine Target Disease (extensible)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: Evaluation Status Reason (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationEvaluation 0..*ImmunizationEvaluationImmunization evaluation information
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.

... patient Σ1..1Reference(ImmDS Patient)Who this evaluation is for
... date 1..1dateTimeDate evaluation was performed
... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
... targetDisease Σ1..1CodeableConceptEvaluation target disease
Binding: Vaccine Target Disease (extensible)
... immunizationEvent Σ1..1Reference(Immunization)Immunization being evaluated
... doseStatus Σ1..1CodeableConceptStatus of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (extensible)
... doseStatusReason S0..*CodeableConceptReason for the dose status
Binding: Evaluation Status Reason (extensible)
... description 0..1stringEvaluation notes
... series 0..1stringName of vaccine series
... doseNumber[x] 0..1Dose number within series
.... doseNumberPositiveIntpositiveInt
.... doseNumberStringstring
... seriesDoses[x] 0..1Recommended number of doses for immunity
.... seriesDosesPositiveIntpositiveInt
.... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImmunizationEvaluation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationEvaluation.statusrequiredImmunizationEvaluationStatusCodes
ImmunizationEvaluation.targetDiseaseextensibleTargetDisease
ImmunizationEvaluation.doseStatusextensibleImmunizationEvaluationDoseStatusCodes
ImmunizationEvaluation.doseStatusReasonextensibleStatusReason

Constraints

Constraints

IdPathDetailsRequirements