ca.uhn.fhir.model.dstu2.resource

Class MedicationOrder.DispenseRequest

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu2.resource.MedicationOrder.DispenseRequest

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

MedicationOrder

public static class MedicationOrder.DispenseRequest
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationOrder.dispenseRequest ()

Definition: Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DispenseRequest()

Method Summary

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
DurationDt	getExpectedSupplyDuration() Gets the value(s) for expectedSupplyDuration ().
IDatatype	getMedication() Gets the value(s) for medication[x] ().
Integer	getNumberOfRepeatsAllowed() Gets the value(s) for numberOfRepeatsAllowed ().
PositiveIntDt	getNumberOfRepeatsAllowedElement() Gets the value(s) for numberOfRepeatsAllowed ().
SimpleQuantityDt	getQuantity() Gets the value(s) for quantity ().
PeriodDt	getValidityPeriod() Gets the value(s) for validityPeriod ().
boolean	isEmpty()
MedicationOrder.DispenseRequest	setExpectedSupplyDuration(DurationDt theValue) Sets the value(s) for expectedSupplyDuration ()
MedicationOrder.DispenseRequest	setMedication(IDatatype theValue) Sets the value(s) for medication[x] ()
MedicationOrder.DispenseRequest	setNumberOfRepeatsAllowed(int theInteger) Sets the value for numberOfRepeatsAllowed ()
MedicationOrder.DispenseRequest	setNumberOfRepeatsAllowed(PositiveIntDt theValue) Sets the value(s) for numberOfRepeatsAllowed ()
MedicationOrder.DispenseRequest	setQuantity(SimpleQuantityDt theValue) Sets the value(s) for quantity ()
MedicationOrder.DispenseRequest	setValidityPeriod(PeriodDt theValue) Sets the value(s) for validityPeriod ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Constructor Detail

DispenseRequest

public DispenseRequest()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getMedication

public IDatatype getMedication()

Gets the value(s) for medication[x] (). creating it if it does not exist. Will not return null.

Definition: Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

setMedication

public MedicationOrder.DispenseRequest setMedication(IDatatype theValue)

Sets the value(s) for medication[x] ()

Definition: Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.

getValidityPeriod

public PeriodDt getValidityPeriod()

Gets the value(s) for validityPeriod (). creating it if it does not exist. Will not return null.

Definition: This indicates the validity period of a prescription (stale dating the Prescription)

setValidityPeriod

public MedicationOrder.DispenseRequest setValidityPeriod(PeriodDt theValue)

Sets the value(s) for validityPeriod ()

Definition: This indicates the validity period of a prescription (stale dating the Prescription)

getNumberOfRepeatsAllowedElement

public PositiveIntDt getNumberOfRepeatsAllowedElement()

Gets the value(s) for numberOfRepeatsAllowed (). creating it if it does not exist. Will not return null.

Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

getNumberOfRepeatsAllowed

public Integer getNumberOfRepeatsAllowed()

Gets the value(s) for numberOfRepeatsAllowed (). creating it if it does not exist. Will not return null.

Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

setNumberOfRepeatsAllowed

public MedicationOrder.DispenseRequest setNumberOfRepeatsAllowed(PositiveIntDt theValue)

Sets the value(s) for numberOfRepeatsAllowed ()

Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

setNumberOfRepeatsAllowed

public MedicationOrder.DispenseRequest setNumberOfRepeatsAllowed(int theInteger)

Sets the value for numberOfRepeatsAllowed ()

Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

getQuantity

public SimpleQuantityDt getQuantity()

Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

Definition: The amount that is to be dispensed for one fill.

setQuantity

public MedicationOrder.DispenseRequest setQuantity(SimpleQuantityDt theValue)

Sets the value(s) for quantity ()

Definition: The amount that is to be dispensed for one fill.

getExpectedSupplyDuration

public DurationDt getExpectedSupplyDuration()

Gets the value(s) for expectedSupplyDuration (). creating it if it does not exist. Will not return null.

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

setExpectedSupplyDuration

public MedicationOrder.DispenseRequest setExpectedSupplyDuration(DurationDt theValue)

Sets the value(s) for expectedSupplyDuration ()

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