Immunization
Class TargetDose

Each target dose is one step in a patient series. The target dose links the vaccine dose administered to the series dose that it meets the goals of. A vaccine dose may not meet the goals of a given series dose and therefore be not valid.

Attributes
Integer doseNumber doseNumber

Indicates the position in which the dose represented by this class is in the sequence of doses that make up a series of doses prescribed by a vaccination protocol. For example, a particular administration of an MMR vaccine met the rules to count as the second of two recommended administrations.
"Nominal position in a series." - HL7 FHIR, Immunization.vaccinationProtocol.doseSequence
"Nominal position in a series." - HL7 FHIR, ImmunizationEvaluation.doseNumber[x]
"Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose)." - HL7 FHIR, ImmunizationRecommendation.recommendation.doseNumber[x]

PatientSeries patientSeries patientSeries

Pointer to the Patient Series of which this Target Dose is a member.

«CS» Code status status

Indicates the state of the assignment of the patient dose to the vaccine series. Note that this assignment will likely be accomplished by a Rules Engine evaluating various rules against the actual vaccine administration data to determine whether the vaccination satisfies the requirements of the vaccination series. Possible values include: Count, No count.
"Indicates if the immunization event should "count" against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatus


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameTargetDose
Name Expression
NamespaceImmunization
Owned Template Signature
OwnerImmunization
Owning Template Parameter
PackageImmunization
Qualified NameFHIM::Immunization::TargetDose
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 doseNumber
Public Integer doseNumber

Indicates the position in which the dose represented by this class is in the sequence of doses that make up a series of doses prescribed by a vaccination protocol. For example, a particular administration of an MMR vaccine met the rules to count as the second of two recommended administrations.
"Nominal position in a series." - HL7 FHIR, Immunization.vaccinationProtocol.doseSequence
"Nominal position in a series." - HL7 FHIR, ImmunizationEvaluation.doseNumber[x]
"Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose)." - HL7 FHIR, ImmunizationRecommendation.recommendation.doseNumber[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassTargetDose
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
NamedoseNumber
Name Expression
NamespaceTargetDose
Opposite
OwnerTargetDose
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::TargetDose::doseNumber
Stereotype
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 patientSeries
Public PatientSeries patientSeries

Pointer to the Patient Series of which this Target Dose is a member.

Constraints:
Properties:

AggregationNone
Alias
AssociationtargetDose_patientSeries
Association End
ClassTargetDose
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
NamespaceTargetDose
Opposite
OwnerTargetDose
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::TargetDose::patientSeries
Stereotype
Template Parameter
TypePatientSeries
Upper1
Upper Value(1)
VisibilityPublic


 status
Public «CS» Code status

Indicates the state of the assignment of the patient dose to the vaccine series. Note that this assignment will likely be accomplished by a Rules Engine evaluating various rules against the actual vaccine administration data to determine whether the vaccination satisfies the requirements of the vaccination series. Possible values include: Count, No count.
"Indicates if the immunization event should "count" against the protocol." - HL7 FHIR, Immunization.vaccinationProtocol.doseStatus

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassTargetDose
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
Namestatus
Name Expression
NamespaceTargetDose
Opposite
OwnerTargetDose
Owning Association
Owning Template Parameter
Qualified NameFHIM::Immunization::TargetDose::status
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic