|
| Immunization UML Documentation |
Immunization
Class PatientSeries
Patient Series is an instantiation in time of a Vaccine Series for a given Patient that represents a path towards the goal of protection against a particular disease (e.g., shingles), or a group of diseases that are commonly immunized against together (e.g., measles, mumps, and rubella). It consists of a set of Target Doses. In other words, while the Vaccine Series is the generic plan of doses that all persons sharing certain characteristics should should receive, the Patient Series is the series of doses that a particular Patient has received or is expected to receive.
| Attributes |
| Vaccine |  contraindicatedVaccine |
"Vaccine(s) which should not be used to fulfill the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
|
| NextDoseForecast | nextDoseForecast |
The recommended next dose of a particular vaccine for a given patient.
|
| Integer | numberOfDoses |
The total number of doses of a given vaccine that is anticipated to be administered to the patient."The recommended number of doses to achieve immunity." - HL7 FHIR, ImmunizationRecommendation.recommendation.seriesDoses[x]
|
| ImmunizationSchedule | protocol |
"Contains information about the protocol under which the vaccine was administered." - HL7 FHIR, ImmunizationRecommendation.recommendation.protocol
|
| String | seriesName |
A designation for the Vaccine Series, for ease in locating a given series."One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, Immunization.vaccinationProtocol.series"One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationRecommendation.recommendation.protocol.series
|
| Indication | targetDisease |
"The targeted disease for the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.targetDisease
|
| TargetDose | targetDose |
Each target dose is one step in a patient series.
|
| Vaccine | vaccine |
"Vaccine(s) or vaccine group that pertain to the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.vaccineCode
|
| VaccineSeries | vaccineSeries |
A series is one path to meet the goals for assuming protection against a target disease.
|
Properties:
| Alias | |
| Classifier Behavior | |
| Is Abstract | false |
| Is Active | false |
| Is Leaf | false |
| Keywords | |
| Name | PatientSeries |
| Name Expression | |
| Namespace | Immunization |
| Owned Template Signature | |
| Owner | Immunization |
| Owning Template Parameter | |
| Package | Immunization |
| Qualified Name | FHIM::Immunization::PatientSeries |
| Representation | |
| Stereotype | |
| Template Parameter | |
| Visibility | Public |
contraindicatedVaccine
Public Vaccine contraindicatedVaccine
-
"Vaccine(s) which should not be used to fulfill the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | patientSeries_contraindicatedVaccine |
| Association End | |
| Class | PatientSeries |
| 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 | contraindicatedVaccine |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::contraindicatedVaccine |
| Stereotype | |
| Template Parameter | |
| Type | Vaccine |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
nextDoseForecast
Public NextDoseForecast nextDoseForecast
-
The recommended next dose of a particular vaccine for a given patient.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | patientSeries_nextDoseForecast |
| Association End | |
| Class | PatientSeries |
| 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 | nextDoseForecast |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::nextDoseForecast |
| Stereotype | |
| Template Parameter | |
| Type | NextDoseForecast |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
numberOfDoses
Public Integer numberOfDoses
-
The total number of doses of a given vaccine that is anticipated to be administered to the patient."The recommended number of doses to achieve immunity." - HL7 FHIR, ImmunizationRecommendation.recommendation.seriesDoses[x]
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | PatientSeries |
| 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 | numberOfDoses |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::numberOfDoses |
| Stereotype | |
| Template Parameter | |
| Type | Integer |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
protocol
Public ImmunizationSchedule protocol
-
"Contains information about the protocol under which the vaccine was administered." - HL7 FHIR, ImmunizationRecommendation.recommendation.protocol
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | patientSeries_protocol |
| Association End | |
| Class | PatientSeries |
| 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 | protocol |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::protocol |
| Stereotype | |
| Template Parameter | |
| Type | ImmunizationSchedule |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
seriesName
Public String seriesName
-
A designation for the Vaccine Series, for ease in locating a given series."One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, Immunization.vaccinationProtocol.series"One possible path to achieve presumed immunity against a disease - within the context of an authority." - HL7 FHIR, ImmunizationRecommendation.recommendation.protocol.series
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | |
| Association End | |
| Class | PatientSeries |
| 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 | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::seriesName |
| Stereotype | |
| Template Parameter | |
| Type | String |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
targetDisease
Public Indication targetDisease
-
"The targeted disease for the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.targetDisease
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | patientSeries_targetDisease |
| Association End | |
| Class | PatientSeries |
| 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 | targetDisease |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::targetDisease |
| Stereotype | |
| Template Parameter | |
| Type | Indication |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
targetDose
Public TargetDose targetDose
-
Each target dose is one step in a patient series.
-
Constraints:
-
Properties:
-
| Aggregation | Composite |
| Alias | |
| Association | patientSeries_targetDose |
| Association End | |
| Class | PatientSeries |
| 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 | targetDose |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::targetDose |
| Stereotype | |
| Template Parameter | |
| Type | TargetDose |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
vaccine
Public Vaccine vaccine
-
"Vaccine(s) or vaccine group that pertain to the recommendation." - HL7 FHIR, ImmunizationRecommendation.recommendation.vaccineCode
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | patientSeries_vaccine |
| Association End | |
| Class | PatientSeries |
| 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 | PatientSeries |
| Opposite | |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::vaccine |
| Stereotype | |
| Template Parameter | |
| Type | Vaccine |
| Upper | * |
| Upper Value | (*) |
| Visibility | Public |
vaccineSeries
Public VaccineSeries vaccineSeries
-
A series is one path to meet the goals for assuming protection against a target disease.
-
Constraints:
-
Properties:
-
| Aggregation | None |
| Alias | |
| Association | vaccineSeries_patientSeries |
| Association End | |
| Class | PatientSeries |
| 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 | vaccineSeries |
| Name Expression | |
| Namespace | PatientSeries |
| Opposite | patientSeries |
| Owner | PatientSeries |
| Owning Association | |
| Owning Template Parameter | |
| Qualified Name | FHIM::Immunization::PatientSeries::vaccineSeries |
| Stereotype | |
| Template Parameter | |
| Type | VaccineSeries |
| Upper | 1 |
| Upper Value | (1) |
| Visibility | Public |
|
| Immunization UML Documentation |