| Immunization UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
Pointer to the Patient Series of which this Target Dose is a member. |
«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 |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | TargetDose |
Name Expression | |
Namespace | Immunization |
Owned Template Signature | |
Owner | Immunization |
Owning Template Parameter | |
Package | Immunization |
Qualified Name | FHIM::Immunization::TargetDose |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | TargetDose |
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 | doseNumber |
Name Expression | |
Namespace | TargetDose |
Opposite | |
Owner | TargetDose |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::TargetDose::doseNumber |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public PatientSeries patientSeries
Pointer to the Patient Series of which this Target Dose is a member.
Aggregation | None |
Alias | |
Association | targetDose_patientSeries |
Association End | |
Class | TargetDose |
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 | TargetDose |
Opposite | |
Owner | TargetDose |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::TargetDose::patientSeries |
Stereotype | |
Template Parameter | |
Type | PatientSeries |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | TargetDose |
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 | status |
Name Expression | |
Namespace | TargetDose |
Opposite | |
Owner | TargetDose |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Immunization::TargetDose::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Immunization UML Documentation |
Summary:AttributesProperties | Detail:Attributes |