oracle.hsgbu.hdr.hl7.rim

Interface SubstanceAdministration

All Superinterfaces:

Act, InfrastructureRoot, Serializable, Versioned

public interface SubstanceAdministration
extends 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

See Also:

Act

Summary

Method Summary

Modifier and Type	Method and Description
void	addApproachSiteCode(CD approachSiteCode) Adds an approach site code to the set of codes
void	addDoseCheckQuantity(RTO<PQ,PQ> doseCheckQuantity) Adds the dose check quantity to the set
void	addMaxDoseQuantity(RTO<PQ,PQ> maxDoseQuantity) Adds the max dose quantity to the set.
void	addMethodCode(CD methodCode) Adds the methodCode to the set.
CE	getAdministrationUnitCode() A code for the administered thing taken from a larger whole.
SET<CD>	getApproachSiteCode() The detailed anatomical site where the medication enters or is applied to the subject.
SubstanceAdminCategoryCode	getCategoryCode() Gets the SubstanceAdministration Category Enum value
SET<RTO<PQ,PQ>>	getDoseCheckQuantity() This attribute identifies the expected quantity to be consumed over a period of time.
IVL<PQ>	getDoseQuantity() The amount of the therapeutic agent or other substance given at one administration event.
SET<RTO<PQ,PQ>>	getMaxDoseQuantity() Identifies the maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time.
SET<CD>	getMethodCode() Identifies the means or technique used to perform the particular substance administration.
IVL<PQ>	getRateQuantity() Identifies the speed with which the substance is introduced into the subject.
CE	getRouteCode() The the physiological path or route for introducing the therapeutic material into or onto the subject.
void	setAdministrationUnitCode(CE administrationUnitCode)
void	setApproachSiteCode(SET<CD> approachSiteCode)
void	setCategoryCode(SubstanceAdminCategoryCode subAdmnCategoryEnum) Sets the SubstanceAdministration Category Enum value
void	setDoseCheckQuantity(SET<RTO<PQ,PQ>> doseCheckQuantity)
void	setDoseQuantity(IVL<PQ> doseQuantity)
void	setMaxDoseQuantity(SET<RTO<PQ,PQ>> maxDoseQuantity)
void	setMethodCode(SET<CD> methodCode)
void	setRateQuantity(IVL<PQ> rateQuantity)
void	setRouteCode(CE routeCode)

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.Act

addConfidentialityCode, addIBActRelationship, addId, addOBActRelationship, addParticipation, addPriorityCode, addReasonCode, getActivityTime, getAvailabilityTime, getClassCode, getCode, getConfidentialityCode, getDerivationExpr, getEffectiveTime, getIBActRelationships, getIBActRelationships, getId, getIndependentInd, getInterruptibleInd, getLanguageCode, getLevelCode, getMoodCode, getNegationInd, getOBActRelationships, getOBActRelationships, getParticipations, getParticipations, getPriorityCode, getReasonCode, getRepeatNumber, getStatusCode, getText, getTitle, getUncertaintyCode, setActivityTime, setAvailabilityTime, setConfidentialityCode, setDerivationExpr, setEffectiveTime, setIndependentInd, setInterruptibleInd, setLanguageCode, setLevelCode, setNegationInd, setPriorityCode, setReasonCode, setRepeatNumber, setStatusCode, setText, setTitle, setUncertaintyCode

Methods inherited from interface oracle.hsgbu.hdr.hl7.rim.InfrastructureRoot

getControlAct, getToken, setToken

Methods inherited from interface oracle.hsgbu.hdr.hl7.fwk.Versioned

createNewVersion, getVersionNum, isCurrentVersion

Method Detail

getRouteCode

CE getRouteCode()

The the physiological path or route for introducing the therapeutic material into or onto the subject.

Discussion: If the route requires further specification, both the site of administration (administrationSiteCode) and the method of adminitration (methodCode) may be used. For example, if the routeCode is intravenous or intra-muscular, it may be necessary to specify the precise site, with approachSiteCode, (e.g., right forearm or left deltoid muscle respectively) and the precise method of administration, with methodCode, (e.g., ?slow bolus injection? or ?Z-track injection? respectively).

Route, site of administration (administrationSiteCode), method of adminitration (methodCode) and the device used in administration are closely related. All four (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)

Membership code to be used:

CL_SBADM_ROUTE_CODE

setRouteCode

void setRouteCode(CE routeCode)
           throws HDRRimException

Throws:

HDRRimException

getApproachSiteCode

SET<CD> getApproachSiteCode()

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) method of administration (methodCode) and the device used in administration are closely related. All four (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.

Membership code to be used:

CL_SBADM_APPROACH_SITE_CODE

setApproachSiteCode

void setApproachSiteCode(SET<CD> approachSiteCode)
                  throws HDRRimException

Throws:

HDRRimException

addApproachSiteCode

void addApproachSiteCode(CD approachSiteCode)
                  throws HDRRimException

Adds an approach site code to the set of codes

Parameters:

approachSiteCode - The approach site code to add

Throws:

HDRRimException

getDoseQuantity

IVL<PQ> getDoseQuantity()

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.

setDoseQuantity

void setDoseQuantity(IVL<PQ> doseQuantity)
              throws HDRRimException

Throws:

HDRRimException

getRateQuantity

IVL<PQ> getRateQuantity()

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.

setRateQuantity

void setRateQuantity(IVL<PQ> rateQuantity)
              throws HDRRimException

Throws:

HDRRimException

getDoseCheckQuantity

SET<RTO<PQ,PQ>> getDoseCheckQuantity()

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.

setDoseCheckQuantity

void setDoseCheckQuantity(SET<RTO<PQ,PQ>> doseCheckQuantity)
                   throws HDRRimException

Throws:

HDRRimException

addDoseCheckQuantity

void addDoseCheckQuantity(RTO<PQ,PQ> doseCheckQuantity)
                   throws HDRRimException

Adds the dose check quantity to the set

Parameters:

doseCheckQuantity - The dose check quantity

Throws:

HDRRimException

getMaxDoseQuantity

SET<RTO<PQ,PQ>> getMaxDoseQuantity()

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.

setMaxDoseQuantity

void setMaxDoseQuantity(SET<RTO<PQ,PQ>> maxDoseQuantity)
                 throws HDRRimException

Throws:

HDRRimException

addMaxDoseQuantity

void addMaxDoseQuantity(RTO<PQ,PQ> maxDoseQuantity)
                 throws HDRRimException

Adds the max dose quantity to the set.

Parameters:

maxDoseQuantity - The max dose quantity

Throws:

HDRRimException

getAdministrationUnitCode

CE getAdministrationUnitCode()

A code for the administered thing taken from a larger whole. Used if the consumable material is specified as a larger whole but the doseQuantity relates to a specific portion of it rather than the entire consumable material.

Example: The ordering system only has a code for "Budesonide Metered Dose Inhaler" but the dose is to be measured in "number of actuations".

Rationale: In the given example, without an administrationUnitCode the doseQty = 1 would mean that the entire inhaler bottle is to be emptied upon a single administration event. The administrationUnitCode signifying "actuation" (or "puff") specifies that the doseQty relates to this fraction of the medication rather than to the whole.

Constraints:

(1) This attribute should be used if and only if the material specified as the player of the Role attaching to the consumable participation is not in itself the finished dose form to be administered but a larger whole, pack, etc.

(2) IF the material so specified is the proper administered dose form, such as a tablet, capsule, etc. THEN this attribute should be valued NULL (not applicable).

(3) IF the material so specified is an amorphous substance (liquid, gas, powder, etc.) to be measured as a volume, mass, etc., THEN this attribute should remain NULL (not applicable).

(4) IF the material so specified is a container, and the content is to be measured as a volume, mass, etc., THEN this attribute should be specified as "measured portion".

setAdministrationUnitCode

void setAdministrationUnitCode(CE administrationUnitCode)
                        throws HDRRimException

Throws:

HDRRimException

getMethodCode

SET<CD> getMethodCode()

Identifies the means or technique used to perform the particular substance administration.

Discussion: This attribute is only needed if the routeCode requires further specification. For example, if the routeCode is "by mouth", no further information about the method may be required. If, however, routeCode is intravenous or intra-muscular, the precise method of administration may be specified in this attribute (e.g., ?slow bolus injection? or ?Z-track injection? respectively).

Route of administration (routeCode), site of administration (approachSiteCode) and the method of 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.

setMethodCode

void setMethodCode(SET<CD> methodCode)
            throws HDRRimException

Throws:

HDRRimException

addMethodCode

void addMethodCode(CD methodCode)
            throws HDRRimException

Adds the methodCode to the set.

Parameters:

methodCode - The method code

Throws:

HDRRimException

getCategoryCode

SubstanceAdminCategoryCode getCategoryCode()

Gets the SubstanceAdministration Category Enum value

Returns:

the SubstanceAdministration Category Enum value

setCategoryCode

void setCategoryCode(SubstanceAdminCategoryCode subAdmnCategoryEnum)
              throws HDRRimException

Sets the SubstanceAdministration Category Enum value

Parameters:

subAdmnCategoryEnum - the SubstanceAdministration Category Enum value to set

Throws:

HDRRimException