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 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 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 seriesName

A designation for the Vaccine Series, for ease in locating a given series.

Rule seriesRule 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 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 Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameVaccineSeries
Name Expression
NamespaceImmunizationForecast
Owned Template Signature
OwnerImmunizationForecast
Owning Template Parameter
PackageImmunizationForecast
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 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:

AggregationNone
Alias
Association
Association End
ClassVaccineSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamenumberOfDoses
Name Expression
NamespaceVaccineSeries
Opposite
OwnerVaccineSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries::numberOfDoses
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
AssociationvaccineSeries_patientSeries
Association End
ClassVaccineSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
NamepatientSeries
Name Expression
NamespaceVaccineSeries
OppositevaccineSeries
OwnerVaccineSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries::patientSeries
Stereotype
Template Parameter
TypePatientSeries
Upper1
Upper Value(1)
VisibilityPublic


 seriesName
Public String seriesName

A designation for the Vaccine Series, for ease in locating a given series.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassVaccineSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NameseriesName
Name Expression
NamespaceVaccineSeries
Opposite
OwnerVaccineSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries::seriesName
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 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:

AggregationNone
Alias
AssociationvaccineSeries_seriesRule
Association End
ClassVaccineSeries
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameseriesRule
Name Expression
NamespaceVaccineSeries
Opposite
OwnerVaccineSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries::seriesRule
Stereotype
Template Parameter
TypeRule
Upper*
Upper Value(*)
VisibilityPublic


 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:

AggregationComposite
Alias
AssociationvaccineSeries_vaccineSeriesDose
Association End
ClassVaccineSeries
Datatype
Default
Default Value
Is Compositetrue
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamevaccineSeriesDose
Name Expression
NamespaceVaccineSeries
Opposite
OwnerVaccineSeries
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::ImmunizationForecast::VaccineSeries::vaccineSeriesDose
Stereotype
Template Parameter
TypeVaccineSeriesDose
Upper*
Upper Value(*)
VisibilityPublic