|
| ImmunizationForecast UML Documentation |
Immunization::ImmunizationForecast
Class NextDoseForecast
The recommended next dose of a particular vaccine for a given patient. It does not deal with usage projections over a population. This forecast is based on application of the rules of the series dose.
| Attributes |
| «TS» PointInTime |  earliestDate |
The date that is the earliest recommended date. This is not always the earliest date that a dose administered will be acceptable.
|
| «CS» Code | forecastStatus |
"Indicates the patient status with respect to the path to immunity for the target disease." - HL7 FHIR, ImmunizationRecommendation.recommendation.forecastStatus. The possible values in FHIR are: Due; Overdue; Immune; Contraindicated; Complete.
|
| «CS» Code | forecastStatusReason |
"The reason for the assigned forecast status." - HL7 FHIR, ImmunizationRecommendation.recommendation.forecastReason
|
| «TS» PointInTime | latestDate |
The latest date patient should receive the vaccine
|
| «TS» PointInTime | overdueDate |
The date when patient is considered behind schedule.
|
| PatientSeries | patientSeries |
Pointer to the series of doses that a Patient is expected to receive in order to provide immunity against a disease or group of diseases."One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationRecommendation.recommendation.series
|
| «TS» PointInTime | recommendedDate |
The ideal date upon which the patient should receive the next dose of the vaccine.
|
| VaccinationEvent | supportingImmunization |
"Immunization event history that supports the status and recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.supportingImmunization
|
| ClinicalStatement | supportingPatientInformation |
"Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information." - HL7 FHIR, ImmunizationRecommendation.recommendation.supportingPatientInformation
|
| TargetDose | targetDose |
Pointer to the individual dose within a series of doses that a Patient is expected to receive in order to provide immunity against a disease or group of diseases.
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | NextDoseForecast |
| Name Expression | |
| Namespace | ImmunizationForecast |
| Owned Template Signature | |
| Owner | ImmunizationForecast |
| Owning Template Parameter | |
| Package | ImmunizationForecast |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
earliestDate
Public «TS» PointInTime earliestDate
-
The date that is the earliest recommended date. This is not always the earliest date that a dose administered will be acceptable.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | earliestDate |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::earliestDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
forecastStatus
Public «CS» Code forecastStatus
-
"Indicates the patient status with respect to the path to immunity for the target disease." - HL7 FHIR, ImmunizationRecommendation.recommendation.forecastStatus. The possible values in FHIR are: Due; Overdue; Immune; Contraindicated; Complete.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | forecastStatus |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::forecastStatus |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
forecastStatusReason
Public «CS» Code forecastStatusReason
-
"The reason for the assigned forecast status." - HL7 FHIR, ImmunizationRecommendation.recommendation.forecastReason
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | forecastStatusReason |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::forecastStatusReason |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
latestDate
Public «TS» PointInTime latestDate
-
The latest date patient should receive the vaccine
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | latestDate |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::latestDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
overdueDate
Public «TS» PointInTime overdueDate
-
The date when patient is considered behind schedule.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | overdueDate |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::overdueDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
patientSeries
Public PatientSeries patientSeries
-
Pointer to the series of doses that a Patient is expected to receive in order to provide immunity against a disease or group of diseases."One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationRecommendation.recommendation.series
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | nextDoseForecast_patientSeries |
| Association End | |
| Class | NextDoseForecast |
| 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 | patientSeries |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::patientSeries |
| Stereotype | |
| Template Parameter | |
| Type | PatientSeries |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
recommendedDate
Public «TS» PointInTime recommendedDate
-
The ideal date upon which the patient should receive the next dose of the vaccine.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | recommendedDate |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::recommendedDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
supportingImmunization
Public VaccinationEvent supportingImmunization
-
"Immunization event history that supports the status and recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.supportingImmunization
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | nextDoseForecast_supportingImmunization |
| Association End | |
| Class | NextDoseForecast |
| 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 | supportingImmunization |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::supportingImmunization |
| Stereotype | |
| Template Parameter | |
| Type | VaccinationEvent |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
supportingPatientInformation
Public ClinicalStatement supportingPatientInformation
-
"Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information." - HL7 FHIR, ImmunizationRecommendation.recommendation.supportingPatientInformation
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | NextDoseForecast |
| 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 | supportingPatientInformation |
| Name Expression | |
| Namespace | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::supportingPatientInformation |
| Stereotype | |
| Template Parameter | |
| Type | ClinicalStatement |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
targetDose
Public TargetDose targetDose
-
Pointer to the individual dose within a series of doses that a Patient is expected to receive in order to provide immunity against a disease or group of diseases.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | nextDoseForecast_targetDose |
| Association End | |
| Class | NextDoseForecast |
| 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 | NextDoseForecast |
| Opposite | |
| Owner | NextDoseForecast |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::NextDoseForecast::targetDose |
| Stereotype | |
| Template Parameter | |
| Type | TargetDose |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
|
| ImmunizationForecast UML Documentation |