|
| ImmunizationForecast UML Documentation |
Immunization::ImmunizationForecast
Class ImmunizationSchedule
An Immunization Schedule is a series of vaccinations, including the timing of all doses, that is recommended (or compulsory, depending on the disease and the jurisdiction) in order to produce an active immunity to a given disease. Many vaccines require multiple doses for maximum effectiveness, either to produce sufficient initial immune response or to boost response that fades over time. While the term Immunization Schedule often refers to the minimum set of vaccinations a person should have throughout their lifetime, this FHIM class is a set of published rules for evaluating doses of a single vaccine administered and for forecasting the next dose of that vaccine that are due. Note however, that some vaccines, such as the MMR vaccine, targets multiple diseases (Measles, Mumps, and Rubella). Staying with the MMR as an example, the first dose is generally given to children around 9 to 15 months of age, with a second dose at 15 months to 6 years of age, with at least 4 weeks between the doses. The FHIM would then have one instance of ImmunizationSchedule called “MMR”, point to three Indication instances (Measles, Mumps, and Rubella), and point to one VaccineSeries instance where the numberOfDoses property is set to two. The rules (dose 1: age >= 9 months and age <= 15 months; dose2: date>=4 weeks after dose 1 and age: age >=15 months, and age <= 6 years) are in the seriesRule property."Contains information about the protocol under which the vaccine was administered." - HL7 FHIR, ImmunizationRecommendation.recommendation.protocol
| Attributes |
| Organization |  authority |
"Indicates the authority who published the protocol (e.g. ACIP) that is being followed." - HL7 FHIR, Immunization.protocolApplied.authority"Indicates the authority who published the protocol (e.g. ACIP)." - HL7 FHIR, ImmunizationEvaluation.authority
|
| String | description |
"Contains the description about the protocol under which the vaccine was administered." - HL7 FHIR, Immunization.vaccinationProtocol.description"Contains the description about the protocol under which the vaccine was administered." - HL7 FHIR, ImmunizationRecommendation.recommendation.description
|
| «CS» Code | kind |
A designation of the Immunization Schedule, which may include a version number or release date to distinguish it from other instances.
|
| «TS» PointInTime | releaseDate |
The date upon which the Immunization Schedule was published. Used to distinguish between different versions of the schedule for the same vaccine.
|
| Rule | scheduleRule |
This is a collection of the rules that apply to the entire schedule. These are uncommon.
|
| Indication | targetDisease |
"The targeted disease." - HL7 FHIR, Immunization.vaccinationProtocol.targetDisease"The vaccine preventable disease the dose is being evaluated against." - HL7 FHIR, ImmunizationEvaluation.targetDisease
|
| Vaccine | vaccine |
Pointer to the Vaccine that is specified to be administered by an Immunization Schedule. For example, a Measles, Mumps and Rubella Immunization Schedule will specify the use of the MMRII vaccine manufactured by Merck, CVX code 03.
|
| 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, Immunization.protocolApplied.series
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | ImmunizationSchedule |
| Name Expression | |
| Namespace | ImmunizationForecast |
| Owned Template Signature | |
| Owner | ImmunizationForecast |
| Owning Template Parameter | |
| Package | ImmunizationForecast |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
authority
Public Organization authority
-
"Indicates the authority who published the protocol (e.g. ACIP) that is being followed." - HL7 FHIR, Immunization.protocolApplied.authority"Indicates the authority who published the protocol (e.g. ACIP)." - HL7 FHIR, ImmunizationEvaluation.authority
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | authority |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::authority |
| Stereotype | |
| Template Parameter | |
| Type | Organization |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
description
Public String description
-
"Contains the description about the protocol under which the vaccine was administered." - HL7 FHIR, Immunization.vaccinationProtocol.description"Contains the description about the protocol under which the vaccine was administered." - HL7 FHIR, ImmunizationRecommendation.recommendation.description
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::description |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
kind
Public «CS» Code kind
-
A designation of the Immunization Schedule, which may include a version number or release date to distinguish it from other instances.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | kind |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::kind |
| Stereotype | |
| Template Parameter | |
| Type | «CS» Code |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
releaseDate
Public «TS» PointInTime releaseDate
-
The date upon which the Immunization Schedule was published. Used to distinguish between different versions of the schedule for the same vaccine.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | releaseDate |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::releaseDate |
| Stereotype | |
| Template Parameter | |
| Type | «TS» PointInTime |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
scheduleRule
Public Rule scheduleRule
-
This is a collection of the rules that apply to the entire schedule. These are uncommon.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | immunizationSchedule_scheduleRule |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | scheduleRule |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::scheduleRule |
| Stereotype | |
| Template Parameter | |
| Type | Rule |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
targetDisease
Public Indication targetDisease
-
"The targeted disease." - HL7 FHIR, Immunization.vaccinationProtocol.targetDisease"The vaccine preventable disease the dose is being evaluated against." - HL7 FHIR, ImmunizationEvaluation.targetDisease
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | ImmunizationSchedule_targetDisease |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | targetDisease |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::targetDisease |
| Stereotype | |
| Template Parameter | |
| Type | Indication |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
vaccine
Public Vaccine vaccine
-
Pointer to the Vaccine that is specified to be administered by an Immunization Schedule. For example, a Measles, Mumps and Rubella Immunization Schedule will specify the use of the MMRII vaccine manufactured by Merck, CVX code 03.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | immunizationSchedule_vaccine |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | vaccine |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::vaccine |
| Stereotype | |
| Template Parameter | |
| Type | Vaccine |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
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, Immunization.protocolApplied.series
-
Constraints:
-
Properties:
-
| Aggregation | Composite |
| Alias | |
| Association | immunizationSchedule_vaccineSeries |
| Association End | |
| Class | ImmunizationSchedule |
| 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 | vaccineSeries |
| Name Expression | |
| Namespace | ImmunizationSchedule |
| Opposite | |
| Owner | ImmunizationSchedule |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::ImmunizationForecast::ImmunizationSchedule::vaccineSeries |
| Stereotype | |
| Template Parameter | |
| Type | VaccineSeries |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
|
| ImmunizationForecast UML Documentation |