|
| ImmunizationForecast UML Documentation |
Immunization::ImmunizationForecast
Class VaccineSeries
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, Immunization.protocolApplied.series
| Attributes |
| Integer | numberOfDoses |
The total number of doses defined by the series."The recommended number of doses to achieve immunity." - HL7 FHIR, Immunization.vaccinationProtocol.seriesDoses
|
| PatientSeries | patientSeries |
Patient Series is an instantiation in time of the Vaccine Series that represents one path towards the goal of protection against a disease. It consists of a number of Target Doses.
|
| String | seriesName |
A designation for the Vaccine Series, for ease in locating a given series.
|
| Rule | seriesRule |
This is the collection of rules which are specific to this series. Series rules are not common. Most are associated with series doses.
|
| VaccineSeriesDose | vaccineSeriesDose |
A Series Dose is a specification of how to determine if a particular dose administered meets the goals for that dose in the series."The recommended number of doses to achieve immunity." - HL7 FHIR, Immunization.vaccinationProtocol.seriesDoses
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | VaccineSeries |
| Name Expression | |
| Namespace | ImmunizationForecast |
| Owned Template Signature | |
| Owner | ImmunizationForecast |
| Owning Template Parameter | |
| Package | ImmunizationForecast |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
numberOfDoses
Public Integer numberOfDoses
-
The total number of doses defined by the series."The recommended number of doses to achieve immunity." - HL7 FHIR, Immunization.vaccinationProtocol.seriesDoses
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | VaccineSeries |
| 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 | numberOfDoses |
| Name Expression | |
| Namespace | VaccineSeries |
| Opposite | |
| Owner | VaccineSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries::numberOfDoses |
| Stereotype | |
| Template Parameter | |
| Type | Integer |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
patientSeries
Public PatientSeries patientSeries
-
Patient Series is an instantiation in time of the Vaccine Series that represents one path towards the goal of protection against a disease. It consists of a number of Target Doses.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | vaccineSeries_patientSeries |
| Association End | |
| Class | VaccineSeries |
| 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 | VaccineSeries |
| Opposite | vaccineSeries |
| Owner | VaccineSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries::patientSeries |
| Stereotype | |
| Template Parameter | |
| Type | PatientSeries |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
seriesName
Public String seriesName
-
A designation for the Vaccine Series, for ease in locating a given series.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | VaccineSeries |
| 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 | seriesName |
| Name Expression | |
| Namespace | VaccineSeries |
| Opposite | |
| Owner | VaccineSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries::seriesName |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
seriesRule
Public Rule seriesRule
-
This is the collection of rules which are specific to this series. Series rules are not common. Most are associated with series doses.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | vaccineSeries_seriesRule |
| Association End | |
| Class | VaccineSeries |
| 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 | seriesRule |
| Name Expression | |
| Namespace | VaccineSeries |
| Opposite | |
| Owner | VaccineSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries::seriesRule |
| Stereotype | |
| Template Parameter | |
| Type | Rule |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
vaccineSeriesDose
Public VaccineSeriesDose vaccineSeriesDose
-
A Series Dose is a specification of how to determine if a particular dose administered meets the goals for that dose in the series."The recommended number of doses to achieve immunity." - HL7 FHIR, Immunization.vaccinationProtocol.seriesDoses
-
Constraints:
-
Properties:
-
| Aggregation | Composite |
| Alias | |
| Association | vaccineSeries_vaccineSeriesDose |
| Association End | |
| Class | VaccineSeries |
| Datatype | |
| Default | |
| Default Value | |
| Is Composite | true |
| 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 | vaccineSeriesDose |
| Name Expression | |
| Namespace | VaccineSeries |
| Opposite | |
| Owner | VaccineSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::VaccineSeries::vaccineSeriesDose |
| Stereotype | |
| Template Parameter | |
| Type | VaccineSeriesDose |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
|
| ImmunizationForecast UML Documentation |