Immunization::ImmunizationForecast
Class ImmunizationEvaluation

This class represents an evaluation of a given vaccination in which an attempt is made to match the vaccination with a Target Dose Number within a Vaccination Series. If the vaccination event passes the rules for a target dose in a series, the evaluation outcome will contain (a code meaning) "Satisfies", otherwise it will contain (a code meaning) "Does Not Satisfy".
"Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations." - HL7 FHIR, ImmunizationEvaluation

Attributes
«CS» Code date date

"The date the evaluation of the vaccine administration event was performed." - HL7 FHIR, ImmunizationEvaluation.date

String description description

"Additional information about the evaluation." - HL7 FHIR, ImmunizationEvaluation.description

«CS» Code doseStatus doseStatus

Indicates the result of the appraisal of whether the vaccine dose (whether already administered or contemplated) qualifies to be considered a valid target dose with in a series, based on the rules involved for the dose series. Possible values include: Valid, Invalid, NeverEvaluated. Note that NeverEvaluated would be appropriate for vaccines that do not occur in series, or for which there are no rules for the series.
"Indicates if the dose is valid or not valid with respect to the published recommendations." - HL7 FHIR, ImmunizationEvaluation.doseStatus Note that in FHIR the possible values are Valid, Not Valid.

Indicates the state of the assignment of the patient dose to the vaccine series. Note that this assignment will likely be accomplished by a Rules Engine evaluating various rules against the actual vaccine administration data to determine whether the vaccination satisfies the requirements of the vaccination series. Possible values include: Count, No count.
"Indicates if the immunization event should "count" against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatus

String doseStatusReason doseStatusReason

Indicates any circumstances which impacted the validation of this vaccine dose administered.
"Provides an explanation as to why an immunization event should or should not count against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatusReason
"Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations." - HL7 FHIR, ImmunizationEvaluation.doseStatusReason. Note that FHIR models this property as a code, while FHIM currently models it as a string. In FHIR, the possible values are: Adverse storage condition; Cold chain break; Expired lot; Administered outside recommended schedule; Product recall

«II» Id identifier identifier

"A unique identifier assigned to this immunization evaluation record." - HL7 FHIR, ImmunizationEvaluation.identifier

ImmunizationSchedule immunizationSchedule immunizationSchedule

Pointer to the Immunization Schedule against which an immunization event is being evaluated for inclusion.
"The protocol (set of recommendations) being followed by the provider who administered the dose." - HL7 FHIR, Immunization.protocolApplied

Patient patient patient

"The individual for whom the evaluation is being done." - HL7 FHIR, ImmunizationEvaluation.patient

«CS» Code status status

"Indicates the current status of the evaluation of the vaccination administration event." - HL7 FHIR, ImmunizationEvaluation.status

TargetDose targetDose targetDose

Each target dose is one step in a patient series.

VaccinationEvent vaccinationEvent vaccinationEvent

"The vaccine administration event being evaluated." - HL7 FHIR, ImmunizationEvaluation.immunizationEvent

VaccineSeries vaccineSeries vaccineSeries

Pointer to a series of recommended doses that should be administered according to a set of rules (generally involving the age of the patient or the timing between doses) in order to produce or boost an active immunity to a given disease.
"One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationEvaluation.series


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameImmunizationEvaluation
Name Expression
NamespaceImmunizationForecast
Owned Template Signature
OwnerImmunizationForecast
Owning Template Parameter
PackageImmunizationForecast
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 date
Public «CS» Code date

"The date the evaluation of the vaccine administration event was performed." - HL7 FHIR, ImmunizationEvaluation.date

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedate
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::date
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 description
Public String description

"Additional information about the evaluation." - HL7 FHIR, ImmunizationEvaluation.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 doseStatus
Public «CS» Code doseStatus

Indicates the result of the appraisal of whether the vaccine dose (whether already administered or contemplated) qualifies to be considered a valid target dose with in a series, based on the rules involved for the dose series. Possible values include: Valid, Invalid, NeverEvaluated. Note that NeverEvaluated would be appropriate for vaccines that do not occur in series, or for which there are no rules for the series.
"Indicates if the dose is valid or not valid with respect to the published recommendations." - HL7 FHIR, ImmunizationEvaluation.doseStatus Note that in FHIR the possible values are Valid, Not Valid.

Indicates the state of the assignment of the patient dose to the vaccine series. Note that this assignment will likely be accomplished by a Rules Engine evaluating various rules against the actual vaccine administration data to determine whether the vaccination satisfies the requirements of the vaccination series. Possible values include: Count, No count.
"Indicates if the immunization event should "count" against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamedoseStatus
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::doseStatus
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 doseStatusReason
Public String doseStatusReason

Indicates any circumstances which impacted the validation of this vaccine dose administered.
"Provides an explanation as to why an immunization event should or should not count against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatusReason
"Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations." - HL7 FHIR, ImmunizationEvaluation.doseStatusReason. Note that FHIR models this property as a code, while FHIM currently models it as a string. In FHIR, the possible values are: Adverse storage condition; Cold chain break; Expired lot; Administered outside recommended schedule; Product recall

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamedoseStatusReason
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::doseStatusReason
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 identifier
Public «II» Id identifier

"A unique identifier assigned to this immunization evaluation record." - HL7 FHIR, ImmunizationEvaluation.identifier

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameidentifier
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::identifier
Stereotype
Template Parameter
Type«II» Id
Upper*
Upper Value(*)
VisibilityPublic


 immunizationSchedule
Public ImmunizationSchedule immunizationSchedule

Pointer to the Immunization Schedule against which an immunization event is being evaluated for inclusion.
"The protocol (set of recommendations) being followed by the provider who administered the dose." - HL7 FHIR, Immunization.protocolApplied

Constraints:
Properties:

AggregationNone
Alias
AssociationimmunizationEvaluation__immunizationSchedule
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameimmunizationSchedule
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::immunizationSchedule
Stereotype
Template Parameter
TypeImmunizationSchedule
Upper1
Upper Value(1)
VisibilityPublic


 patient
Public Patient patient

"The individual for whom the evaluation is being done." - HL7 FHIR, ImmunizationEvaluation.patient

Constraints:
Properties:

AggregationNone
Alias
AssociationimmunizationEvaluation_patient
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namepatient
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::patient
Stereotype
Template Parameter
TypePatient
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

"Indicates the current status of the evaluation of the vaccination administration event." - HL7 FHIR, ImmunizationEvaluation.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namestatus
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 targetDose
Public TargetDose targetDose

Each target dose is one step in a patient series.

Constraints:
Properties:

AggregationNone
Alias
AssociationimmunizationEvaluation_targetDose
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NametargetDose
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::targetDose
Stereotype
Template Parameter
TypeTargetDose
Upper1
Upper Value(1)
VisibilityPublic


 vaccinationEvent
Public VaccinationEvent vaccinationEvent

"The vaccine administration event being evaluated." - HL7 FHIR, ImmunizationEvaluation.immunizationEvent

Constraints:
Properties:

AggregationNone
Alias
AssociationimmunizationEvaluation_vaccinationEvent
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamevaccinationEvent
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::vaccinationEvent
Stereotype
Template Parameter
TypeVaccinationEvent
Upper1
Upper Value(1)
VisibilityPublic


 vaccineSeries
Public VaccineSeries vaccineSeries

Pointer to a series of recommended doses that should be administered according to a set of rules (generally involving the age of the patient or the timing between doses) in order to produce or boost an active immunity to a given disease.
"One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationEvaluation.series

Constraints:
Properties:

AggregationNone
Alias
AssociationimmunizationEvaluation_vaccineSeries
Association End
ClassImmunizationEvaluation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamevaccineSeries
Name Expression
NamespaceImmunizationEvaluation
Opposite
OwnerImmunizationEvaluation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::vaccineSeries
Stereotype
Template Parameter
TypeVaccineSeries
Upper1
Upper Value(1)
VisibilityPublic