| ImmunizationForecast UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
"The date the evaluation of the vaccine administration event was performed." - HL7 FHIR, ImmunizationEvaluation.date |
String | description |
"Additional information about the evaluation." - HL7 FHIR, ImmunizationEvaluation.description |
«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 |
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 |
«II» Id | identifier |
"A unique identifier assigned to this immunization evaluation record." - HL7 FHIR, ImmunizationEvaluation.identifier |
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 |
"The individual for whom the evaluation is being done." - HL7 FHIR, ImmunizationEvaluation.patient |
«CS» Code | status |
"Indicates the current status of the evaluation of the vaccination administration event." - HL7 FHIR, ImmunizationEvaluation.status |
TargetDose | targetDose | |
VaccinationEvent | vaccinationEvent |
"The vaccine administration event being evaluated." - HL7 FHIR, ImmunizationEvaluation.immunizationEvent |
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 Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ImmunizationEvaluation |
Name Expression | |
Namespace | ImmunizationForecast |
Owned Template Signature | |
Owner | ImmunizationForecast |
Owning Template Parameter | |
Package | ImmunizationForecast |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «CS» Code date
"The date the evaluation of the vaccine administration event was performed." - HL7 FHIR, ImmunizationEvaluation.date
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | date |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::date |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public String description
"Additional information about the evaluation." - HL7 FHIR, ImmunizationEvaluation.description
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | description |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::description |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | doseStatus |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::doseStatus |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | doseStatusReason |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::doseStatusReason |
Stereotype | |
Template Parameter | |
Type | String |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «II» Id identifier
"A unique identifier assigned to this immunization evaluation record." - HL7 FHIR, ImmunizationEvaluation.identifier
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | identifier |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::identifier |
Stereotype | |
Template Parameter | |
Type | «II» Id |
Upper | * |
Upper Value | (*) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | immunizationEvaluation__immunizationSchedule |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | immunizationSchedule |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::immunizationSchedule |
Stereotype | |
Template Parameter | |
Type | ImmunizationSchedule |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Patient patient
"The individual for whom the evaluation is being done." - HL7 FHIR, ImmunizationEvaluation.patient
Aggregation | None |
Alias | |
Association | immunizationEvaluation_patient |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | patient |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::patient |
Stereotype | |
Template Parameter | |
Type | Patient |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code status
"Indicates the current status of the evaluation of the vaccination administration event." - HL7 FHIR, ImmunizationEvaluation.status
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | status |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public TargetDose targetDose
Aggregation | None |
Alias | |
Association | immunizationEvaluation_targetDose |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | targetDose |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::targetDose |
Stereotype | |
Template Parameter | |
Type | TargetDose |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public VaccinationEvent vaccinationEvent
"The vaccine administration event being evaluated." - HL7 FHIR, ImmunizationEvaluation.immunizationEvent
Aggregation | None |
Alias | |
Association | immunizationEvaluation_vaccinationEvent |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | vaccinationEvent |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::vaccinationEvent |
Stereotype | |
Template Parameter | |
Type | VaccinationEvent |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | immunizationEvaluation_vaccineSeries |
Association End | |
Class | ImmunizationEvaluation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | vaccineSeries |
Name Expression | |
Namespace | ImmunizationEvaluation |
Opposite | |
Owner | ImmunizationEvaluation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationEvaluation::vaccineSeries |
Stereotype | |
Template Parameter | |
Type | VaccineSeries |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| ImmunizationForecast UML Documentation |
Summary:AttributesProperties | Detail:Attributes |