oracle.hsgbu.hdr.hl7.rim

Interface Supply

All Superinterfaces:

Act, InfrastructureRoot, Serializable, Versioned

All Known Subinterfaces:

Diet

public interface Supply
extends Act

An act that involves provision of a material by one entity to another.

Discussion: The product is associated with the SupplyAct via Participation.typeCode="product". With general supply acts, the precise identification of the Material (manufacturer, serial numbers, etc.) is important. Most of the detailed information about the Supply should be represented using the Material class. If delivery needs to be scheduled, tracked, and billed separately, one can associate a transportation actwith the supply act. Pharmacy dispense services are represented as supply acts, associated with a SubstanceAdministration Act. The SubstanceAdministration class represents the administration of medication, while dispensing is supply.

Examples: Ordering bed sheets; Dispensing of a drug; Issuing medical supplies from storage

Summary

Method Summary

Modifier and Type	Method and Description
SupplyCategoryCode	getCategoryCode() Gets the Supply Category Enum value
IVL<TS>	getExpectedUseTime() Identifies the period time over which the supplied product is expected to be used, or the length of time the supply is expected to last.
PQ	getQuantity() The amount that was or is to be supplied (depending on the moodCode).
void	setCategoryCode(SupplyCategoryCode supplyCategoryEnum) Sets the Supply Category Enum value
void	setExpectedUseTime(IVL<TS> expectedUseTime)
void	setQuantity(PQ quantity)

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

getQuantity

PQ getQuantity()

The amount that was or is to be supplied (depending on the moodCode).

Discussion: This attribute may be used as an alternative to expectedUseTime or both may be used. If both are specified, then the specified quantity is the amount expected to be consumed within the expectedUseTime.

The unit of measure is restricted to a measured unit such as milliliter and milligram. Non-measured, but countable units such as tablet and capsule 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. The type of 'countable' information is determined by information in the 'product' entity.

setQuantity

void setQuantity(PQ quantity)
          throws HDRRimException

Throws:

HDRRimException

getExpectedUseTime

IVL<TS> getExpectedUseTime()

Identifies the period time over which the supplied product is expected to be used, or the length of time the supply is expected to last.

In some situations, this attribute may be used instead of Supply.quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued. E.g. 90 days supply of medication (based on an ordered dosage), 10 hours of jet fuel, etc.
NOTE: When possible, it is always better to specify Supply.quantity, as this tends to be more precise. Supply.expectedUseTime will always be an estimate that can be influenced by external factors.

setExpectedUseTime

void setExpectedUseTime(IVL<TS> expectedUseTime)
                 throws HDRRimException

Throws:

HDRRimException

getCategoryCode

SupplyCategoryCode getCategoryCode()

Gets the Supply Category Enum value

Returns:

the Supply Category Enum value

setCategoryCode

void setCategoryCode(SupplyCategoryCode supplyCategoryEnum)
              throws HDRRimException

Sets the Supply Category Enum value

Parameters:

supplyCategoryEnum - the Supply Category Enum value to set

Throws:

HDRRimException