org.hl7.rim
public interface SubstanceAdministration extends RimObject, Act
The act of introducing or otherwise applying a substance to the subject.
Discussion: The effect of the substance is typically established on a biochemical basis, however, that is not a requirement. For example, radiotherapy can largely be described in the same way, especially if it is a systemic therapy such as radio-iodine. This class also includes the application of chemical treatments to an area.
Examples: Chemotherapy protocol; Drug prescription; Vaccination record
| Method Summary | |
|---|---|
| SET<CD> | getApproachSiteCode()
Gets attribute approachSiteCode of type SET |
| SET<RTO> | getDoseCheckQuantity()
Gets attribute doseCheckQuantity of type SET |
| IVL<PQ> | getDoseQuantity()
Gets attribute doseQuantity of type IVL |
| SET<RTO> | getMaxDoseQuantity()
Gets attribute maxDoseQuantity of type SET |
| IVL<PQ> | getRateQuantity()
Gets attribute rateQuantity of type IVL |
| CE | getRouteCode()
Gets attribute routeCode of type CE and cardinality 0..1.
|
| void | setApproachSiteCode(SET<CD> value)
Sets attribute approachSiteCode of type SET |
| void | setDoseCheckQuantity(SET<RTO> value)
Sets attribute doseCheckQuantity of type SET |
| void | setDoseQuantity(IVL<PQ> value)
Sets attribute doseQuantity of type IVL |
| void | setMaxDoseQuantity(SET<RTO> value)
Sets attribute maxDoseQuantity of type SET |
| void | setRateQuantity(IVL<PQ> value)
Sets attribute rateQuantity of type IVL |
| void | setRouteCode(CE value)
Sets attribute routeCode of type CE and cardinality 0..1.
|
The detailed anatomical site where the medication enters or is applied to the subject.
Discussion: This attribute is only needed if the routeCode requires further specification. For example, if the routeCode is "by mouth", no further specification of approach site is needed. If, however, routeCode is intravenous or intra-muscular, the precise site may be specified in this attribute (e.g., right forearm or left deltoid muscle respectively).
Route, site of administration (approachSiteCode) and the device used in administration are closely related. All three (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.
Returns: the attribute value
This attribute identifies the expected quantity to be consumed over a period of time. It is used as a verification check on the values specified for other values.
Discussion: This attribute should not generally be used; it is only provided for a special purpose. In some countries, especially Japan, there is a regulatory requirement to note the total daily dose on the prescription and associated documentation. The purpose of this requirement obviously is to encourage and facilitate reviewing the total dose prescribed to avoid over- (or under-) dosage.
Examples:
With Erythromycin 250 mg 1 tablet 3 times a day one can calculate the total daily dose as "doseCheckQuantity = doseQuantity (1) * Ingredient.quantity (250 mg) * effectiveTime (3 /d) = 750 mg/1d."
For an intravenous example, this term would be "doseCheckQuantity = doseQuantity (100 ml) * Ingredient.quantity (5mg/L) / rateQuantity (1 h) = 0.5 mg/h" which can be calculated on a daily basis as "doseCheckQuantity = 0.5 mg/h * 24 h/d = 12 mg/d."
Rationale: Rather than defining a "total daily dose" attribute as HL7 v2.3 did, we define this general purpose doseCheckQuantity attribute of the Ratio (RTO) data type.
Constraints: invariant(SubstanceAdministration med, RTO max) where med.doseCheckQuantity.contains(max) {max.numerator.compares(med.doseQuantity); max.denominator.compares(1 s);} Numerator must be in units comparable to doseQuantity and denominator must be a measurement of time.
Returns: the attribute value
The amount of the therapeutic agent or other substance given at one administration event.
Discussion: The dose may be specified either as a physical quantity of active ingredient (e.g. 200 mg) or as the count of administration-units (e.g., tablets, capsules, "eaches"). Which approach is chosen depends upon the player of the 'consumable' participation (which identifies the drug being administered). If the consumable has a non-countable dosage form (e.g. measured in milligram or litre) then the dose must be expressed in those units. If the consumable has a countable dosage form (tablets, capsules, "eaches"), then the dose must be expressed as a dimensionless count (i.e., with no other unit of measure specified).
The unit of measure is restricted to a measurable unit such as milliliters and milligrams. Non-measurable, but countable units such as tablets and capsules must not be specified using the unit component of the PQ data type, except as an annotation, marked by {xxx}. Refer to Data Types Part II Unabridged Specification, Appendix A :Unified Code for Units of Measure.
Returns: the attribute value
Identifies the maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time.
Discussion: This attribute is particularly useful where the allowed dosage is specified as a range or the timing is variable or PRN (as needed). It provides an overall limit on the quantity that may be administered in a period of time. Multiple occurrences of maxDoseQuantity may be used to indicate different limits over different time periods.
Examples: 500 mg/day; 1200mg/week.
Constraints: invariant(SubstanceAdministration med, RTO max) where med.maxDoseQuantity.contains(max) {max.numerator.compares(med.doseQuantity); max.denominator.compares(1 s);} Numerator must be in units comparable to doseQuantity and denominator must be a measurement of time.
Returns: the attribute value
Identifies the speed with which the substance is introduced into the subject. Expressed as a physical (extensive) quantity over elapsed time (e.g., examples are 100 mL/h, 1 g/d, 40 mmol/h, etc.)
Discussion: This is appropriate for continuously divisible dose forms (e.g., liquids, gases). If specified as an interval, the rate should be anywhere in the specified range. This attribute is specified as a extensive physical quantity over elapsed time, i.e., a quantity that could be used for the doseQuantity divided by a duration quantity.
Returns: the attribute value
The method of introducing the therapeutic material into or onto the subject.
Discussion: Route, site of administration (administrationSiteCode) and the device used in administration are closely related. All three (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.
When the medication is delivered to an environmental site, or a location, the route code indicates a site on its "body".
Examples: per os (PO), sublingual (SL), rectal (PR), per inhalationem (IH), ophtalmic (OP), nasal (NS), otic (OT), vaginal (VG), intra-dermal (ID), subcutaneous (SC), intra-venous (IV), and intra-cardial (IC)
Returns: the attribute value
The detailed anatomical site where the medication enters or is applied to the subject.
Discussion: This attribute is only needed if the routeCode requires further specification. For example, if the routeCode is "by mouth", no further specification of approach site is needed. If, however, routeCode is intravenous or intra-muscular, the precise site may be specified in this attribute (e.g., right forearm or left deltoid muscle respectively).
Route, site of administration (approachSiteCode) and the device used in administration are closely related. All three (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.
Parameters: value the new attribute value
This attribute identifies the expected quantity to be consumed over a period of time. It is used as a verification check on the values specified for other values.
Discussion: This attribute should not generally be used; it is only provided for a special purpose. In some countries, especially Japan, there is a regulatory requirement to note the total daily dose on the prescription and associated documentation. The purpose of this requirement obviously is to encourage and facilitate reviewing the total dose prescribed to avoid over- (or under-) dosage.
Examples:
With Erythromycin 250 mg 1 tablet 3 times a day one can calculate the total daily dose as "doseCheckQuantity = doseQuantity (1) * Ingredient.quantity (250 mg) * effectiveTime (3 /d) = 750 mg/1d."
For an intravenous example, this term would be "doseCheckQuantity = doseQuantity (100 ml) * Ingredient.quantity (5mg/L) / rateQuantity (1 h) = 0.5 mg/h" which can be calculated on a daily basis as "doseCheckQuantity = 0.5 mg/h * 24 h/d = 12 mg/d."
Rationale: Rather than defining a "total daily dose" attribute as HL7 v2.3 did, we define this general purpose doseCheckQuantity attribute of the Ratio (RTO) data type.
Constraints: invariant(SubstanceAdministration med, RTO max) where med.doseCheckQuantity.contains(max) {max.numerator.compares(med.doseQuantity); max.denominator.compares(1 s);} Numerator must be in units comparable to doseQuantity and denominator must be a measurement of time.
Parameters: value the new attribute value
The amount of the therapeutic agent or other substance given at one administration event.
Discussion: The dose may be specified either as a physical quantity of active ingredient (e.g. 200 mg) or as the count of administration-units (e.g., tablets, capsules, "eaches"). Which approach is chosen depends upon the player of the 'consumable' participation (which identifies the drug being administered). If the consumable has a non-countable dosage form (e.g. measured in milligram or litre) then the dose must be expressed in those units. If the consumable has a countable dosage form (tablets, capsules, "eaches"), then the dose must be expressed as a dimensionless count (i.e., with no other unit of measure specified).
The unit of measure is restricted to a measurable unit such as milliliters and milligrams. Non-measurable, but countable units such as tablets and capsules must not be specified using the unit component of the PQ data type, except as an annotation, marked by {xxx}. Refer to Data Types Part II Unabridged Specification, Appendix A :Unified Code for Units of Measure.
Parameters: value the new attribute value
Identifies the maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time.
Discussion: This attribute is particularly useful where the allowed dosage is specified as a range or the timing is variable or PRN (as needed). It provides an overall limit on the quantity that may be administered in a period of time. Multiple occurrences of maxDoseQuantity may be used to indicate different limits over different time periods.
Examples: 500 mg/day; 1200mg/week.
Constraints: invariant(SubstanceAdministration med, RTO max) where med.maxDoseQuantity.contains(max) {max.numerator.compares(med.doseQuantity); max.denominator.compares(1 s);} Numerator must be in units comparable to doseQuantity and denominator must be a measurement of time.
Parameters: value the new attribute value
Identifies the speed with which the substance is introduced into the subject. Expressed as a physical (extensive) quantity over elapsed time (e.g., examples are 100 mL/h, 1 g/d, 40 mmol/h, etc.)
Discussion: This is appropriate for continuously divisible dose forms (e.g., liquids, gases). If specified as an interval, the rate should be anywhere in the specified range. This attribute is specified as a extensive physical quantity over elapsed time, i.e., a quantity that could be used for the doseQuantity divided by a duration quantity.
Parameters: value the new attribute value
The method of introducing the therapeutic material into or onto the subject.
Discussion: Route, site of administration (administrationSiteCode) and the device used in administration are closely related. All three (if present) must be closely coordinated and in agreement. In some cases, the coding system used to specify one may pre-coordinate one or more of the others.
When the medication is delivered to an environmental site, or a location, the route code indicates a site on its "body".
Examples: per os (PO), sublingual (SL), rectal (PR), per inhalationem (IH), ophtalmic (OP), nasal (NS), otic (OT), vaginal (VG), intra-dermal (ID), subcutaneous (SC), intra-venous (IV), and intra-cardial (IC)
Parameters: value the new attribute value