| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
"The amount of medication administered." - HL7 FHIR, Dosage.doseAndRate
Attributes | ||
«IVL_PQ» Range | dose |
"The measured quantity of a therapeutic agent to be taken at one time." (MedlinePlus/Merriam-Webster). Note that this property is currently modeled as a single property of type Physical Quanity Interval, rather than having two properties for the low dosage and high dosage."Indicates the manner in which the medication/treatment is aggregated for dispensing, e.g., tablets, capsules, suppositories." - HL7 Version 2.8, RXA-8"This field is the ordered amount. In a variable dose order, this is the minimum ordered amount. In a non-varying dose order, this is the exact amount of the order." - HL7 Version 2.8, RXO-2."In a variable dose order, this is the maximum ordered amount. In a non-varying dose order, this field is not used." - HL7 Version 2.8, RXO-3."Indicates the units for the give amount." - HL7 Version 2.8, RXO-4."Amount of medication per dose." - HL7 FHIR, Dosage.dose[x]"The quantity of vaccine product that was administered." - HL7 FHIR, Immunization.doseQuantity. Note that in FHIR, the data type can be a Range or a Simple Quantity. In FHIM, we model this as a Range to accomodate both."The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection." - HL7 FHIR, MedicationAdministration.dosage.dose"Dose of a given mediation, as dispensed." - PCORnet Common Data Model, Dispensing.Dispense_Dose_Disp."Units of measure associated with the dose of the medication as dispensed." - PCORnet Common Data Model, Dispensing.Dispense_Dose_Disp_Unit. |
«CS» Code | kind |
"The kind of dose or rate specified, for example, ordered or calculated." Possible values are: Calculated; Ordered. - HL7 FHIR, Dosage.doseAndRate.type |
«RTO» RateQuantity | rate |
Indicates the speed at which the medication has been (or is to be) introduced into the patient. This property utilizes the FHIM RateQuantity datatype, which is expressed as a physical Quantity divided by a Time Quantity. In other words, it pre-supposes that the data will be expressed as a single amount to be administered over time. In the case where a clinician wishes to specify a quantity of medication that is based on the patient’s weight, e.g., 1 microgram per Kg of body weight per minute, it is presumed that the quantity of medication would first be calculated (i.e., 50 micrograms for a patient weighing 50 Kg), thus this property would resolve to 50 micrograms / minute. Note that this property should not be used to specify the duration of the administration. If the clinician wishes the medication to be administered over two hours, the duration property should be used."Amount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period." - HL7 FHIR, Dosage.rate"Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours." - HL7 FHIR, MedicationAdministration.dosage.rate[x] |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | DoseAndRate |
Name Expression | |
Namespace | Pharmacy |
Owned Template Signature | |
Owner | Pharmacy |
Owning Template Parameter | |
Package | Pharmacy |
Qualified Name | FHIM::Pharmacy::DoseAndRate |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public «IVL_PQ» Range dose
"The measured quantity of a therapeutic agent to be taken at one time." (MedlinePlus/Merriam-Webster). Note that this property is currently modeled as a single property of type Physical Quanity Interval, rather than having two properties for the low dosage and high dosage."Indicates the manner in which the medication/treatment is aggregated for dispensing, e.g., tablets, capsules, suppositories." - HL7 Version 2.8, RXA-8"This field is the ordered amount. In a variable dose order, this is the minimum ordered amount. In a non-varying dose order, this is the exact amount of the order." - HL7 Version 2.8, RXO-2."In a variable dose order, this is the maximum ordered amount. In a non-varying dose order, this field is not used." - HL7 Version 2.8, RXO-3."Indicates the units for the give amount." - HL7 Version 2.8, RXO-4."Amount of medication per dose." - HL7 FHIR, Dosage.dose[x]"The quantity of vaccine product that was administered." - HL7 FHIR, Immunization.doseQuantity. Note that in FHIR, the data type can be a Range or a Simple Quantity. In FHIM, we model this as a Range to accomodate both."The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection." - HL7 FHIR, MedicationAdministration.dosage.dose"Dose of a given mediation, as dispensed." - PCORnet Common Data Model, Dispensing.Dispense_Dose_Disp."Units of measure associated with the dose of the medication as dispensed." - PCORnet Common Data Model, Dispensing.Dispense_Dose_Disp_Unit.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | DoseAndRate |
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 | dose |
Name Expression | |
Namespace | DoseAndRate |
Opposite | |
Owner | DoseAndRate |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::DoseAndRate::dose |
Stereotype | |
Template Parameter | |
Type | «IVL_PQ» Range |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code kind
"The kind of dose or rate specified, for example, ordered or calculated." Possible values are: Calculated; Ordered. - HL7 FHIR, Dosage.doseAndRate.type
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | DoseAndRate |
Terminologies | [ HL7_FHIR_R4 DoseAndRateType http://hl7.org/fhir/ValueSet/dose-rate-type ] |
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 | DoseAndRate |
Opposite | |
Owner | DoseAndRate |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::DoseAndRate::kind |
Stereotype | ValueSetConstraints |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «RTO» RateQuantity rate
Indicates the speed at which the medication has been (or is to be) introduced into the patient. This property utilizes the FHIM RateQuantity datatype, which is expressed as a physical Quantity divided by a Time Quantity. In other words, it pre-supposes that the data will be expressed as a single amount to be administered over time. In the case where a clinician wishes to specify a quantity of medication that is based on the patient’s weight, e.g., 1 microgram per Kg of body weight per minute, it is presumed that the quantity of medication would first be calculated (i.e., 50 micrograms for a patient weighing 50 Kg), thus this property would resolve to 50 micrograms / minute. Note that this property should not be used to specify the duration of the administration. If the clinician wishes the medication to be administered over two hours, the duration property should be used."Amount of medication per unit of time. Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period." - HL7 FHIR, Dosage.rate"Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours." - HL7 FHIR, MedicationAdministration.dosage.rate[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | DoseAndRate |
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 | rate |
Name Expression | |
Namespace | DoseAndRate |
Opposite | |
Owner | DoseAndRate |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Pharmacy::DoseAndRate::rate |
Stereotype | |
Template Parameter | |
Type | «RTO» RateQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Pharmacy UML Documentation |
Summary:AttributesProperties | Detail:Attributes |