ca.uhn.fhir.model.dstu.resource

Class MedicationPrescription.Dispense

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.MedicationPrescription.Dispense

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

MedicationPrescription

public static class MedicationPrescription.Dispense
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationPrescription.dispense (Medication supply authorization)

Definition: Deals with details of the dispense part of the order

Constructor Summary

Constructors

Constructor and Description
MedicationPrescription.Dispense()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
DurationDt	getExpectedSupplyDuration() Gets the value(s) for expectedSupplyDuration (Days supply per dispense).
ResourceReferenceDt	getMedication() Gets the value(s) for medication (Product to be supplied).
IntegerDt	getNumberOfRepeatsAllowed() Gets the value(s) for numberOfRepeatsAllowed (# of refills authorized).
QuantityDt	getQuantity() Gets the value(s) for quantity (Amount of medication to supply per dispense).
PeriodDt	getValidityPeriod() Gets the value(s) for validityPeriod (Time period supply is authorized for).
boolean	isEmpty()
MedicationPrescription.Dispense	setExpectedSupplyDuration(DurationDt theValue) Sets the value(s) for expectedSupplyDuration (Days supply per dispense)
MedicationPrescription.Dispense	setMedication(ResourceReferenceDt theValue) Sets the value(s) for medication (Product to be supplied)
MedicationPrescription.Dispense	setNumberOfRepeatsAllowed(int theInteger) Sets the value for numberOfRepeatsAllowed (# of refills authorized)
MedicationPrescription.Dispense	setNumberOfRepeatsAllowed(IntegerDt theValue) Sets the value(s) for numberOfRepeatsAllowed (# of refills authorized)
MedicationPrescription.Dispense	setQuantity(double theValue) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(long theValue) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (Amount of medication to supply per dispense)
MedicationPrescription.Dispense	setValidityPeriod(PeriodDt theValue) Sets the value(s) for validityPeriod (Time period supply is authorized for)

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

MedicationPrescription.Dispense

public MedicationPrescription.Dispense()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

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

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getMedication

public ResourceReferenceDt getMedication()

Gets the value(s) for medication (Product to be supplied). creating it if it does not exist. Will not return null.

Definition: Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

setMedication

public MedicationPrescription.Dispense setMedication(ResourceReferenceDt theValue)

Sets the value(s) for medication (Product to be supplied)

Definition: Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.

getValidityPeriod

public PeriodDt getValidityPeriod()

Gets the value(s) for validityPeriod (Time period supply is authorized for). creating it if it does not exist. Will not return null.

Definition: Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.

setValidityPeriod

public MedicationPrescription.Dispense setValidityPeriod(PeriodDt theValue)

Sets the value(s) for validityPeriod (Time period supply is authorized for)

Definition: Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.

getNumberOfRepeatsAllowed

public IntegerDt getNumberOfRepeatsAllowed()

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

Definition: An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.

setNumberOfRepeatsAllowed

public MedicationPrescription.Dispense setNumberOfRepeatsAllowed(IntegerDt theValue)

Sets the value(s) for numberOfRepeatsAllowed (# of refills authorized)

Definition: An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.

setNumberOfRepeatsAllowed

public MedicationPrescription.Dispense setNumberOfRepeatsAllowed(int theInteger)

Sets the value for numberOfRepeatsAllowed (# of refills authorized)

Definition: An integer indicating the number of repeats of the Dispense. UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.

getQuantity

public QuantityDt getQuantity()

Gets the value(s) for quantity (Amount of medication to supply per dispense). creating it if it does not exist. Will not return null.

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(QuantityDt theValue)

Sets the value(s) for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(QuantityCompararatorEnum theComparator,
                                          double theValue,
                                          String theUnits)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(QuantityCompararatorEnum theComparator,
                                          long theValue,
                                          String theUnits)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(QuantityCompararatorEnum theComparator,
                                          double theValue,
                                          String theSystem,
                                          String theUnits)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(QuantityCompararatorEnum theComparator,
                                          long theValue,
                                          String theSystem,
                                          String theUnits)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(double theValue)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

setQuantity

public MedicationPrescription.Dispense setQuantity(long theValue)

Sets the value for quantity (Amount of medication to supply per dispense)

Definition: The amount that is to be dispensed.

getExpectedSupplyDuration

public DurationDt getExpectedSupplyDuration()

Gets the value(s) for expectedSupplyDuration (Days supply per dispense). 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. In some situations, this attribute may be used instead of 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) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.

setExpectedSupplyDuration

public MedicationPrescription.Dispense setExpectedSupplyDuration(DurationDt theValue)

Sets the value(s) for expectedSupplyDuration (Days supply per dispense)

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. In some situations, this attribute may be used instead of 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) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.