ca.uhn.fhir.model.dstu.resource

Class Supply.Dispense

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Supply

public static class Supply.Dispense
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Supply.dispense (Supply details)

Definition: Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.

Constructor Summary

Constructors

Constructor and Description
Supply.Dispense()

Method Summary

Methods

Modifier and Type	Method and Description
ResourceReferenceDt	addReceiver() Adds and returns a new value for receiver (Who collected the Supply)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
ResourceReferenceDt	getDestination() Gets the value(s) for destination (Where the Supply was sent).
IdentifierDt	getIdentifier() Gets the value(s) for identifier (External identifier).
QuantityDt	getQuantity() Gets the value(s) for quantity (Amount dispensed).
List<ResourceReferenceDt>	getReceiver() Gets the value(s) for receiver (Who collected the Supply).
BoundCodeDt<SupplyDispenseStatusEnum>	getStatus() Gets the value(s) for status (in progress | dispensed | abandoned).
ResourceReferenceDt	getSuppliedItem() Gets the value(s) for suppliedItem (Medication, Substance, or Device supplied).
ResourceReferenceDt	getSupplier() Gets the value(s) for supplier (Dispenser).
BoundCodeableConceptDt<SupplyItemTypeEnum>	getType() Gets the value(s) for type (Category of dispense event).
PeriodDt	getWhenHandedOver() Gets the value(s) for whenHandedOver (Handover time).
PeriodDt	getWhenPrepared() Gets the value(s) for whenPrepared (Dispensing time).
boolean	isEmpty()
Supply.Dispense	setDestination(ResourceReferenceDt theValue) Sets the value(s) for destination (Where the Supply was sent)
Supply.Dispense	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (External identifier)
Supply.Dispense	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (External identifier)
Supply.Dispense	setIdentifier(String theSystem, String theValue) Sets the value for identifier (External identifier)
Supply.Dispense	setQuantity(double theValue) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(long theValue) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (Amount dispensed)
Supply.Dispense	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (Amount dispensed)
Supply.Dispense	setReceiver(List<ResourceReferenceDt> theValue) Sets the value(s) for receiver (Who collected the Supply)
Supply.Dispense	setStatus(BoundCodeDt<SupplyDispenseStatusEnum> theValue) Sets the value(s) for status (in progress | dispensed | abandoned)
Supply.Dispense	setStatus(SupplyDispenseStatusEnum theValue) Sets the value(s) for status (in progress | dispensed | abandoned)
Supply.Dispense	setSuppliedItem(ResourceReferenceDt theValue) Sets the value(s) for suppliedItem (Medication, Substance, or Device supplied)
Supply.Dispense	setSupplier(ResourceReferenceDt theValue) Sets the value(s) for supplier (Dispenser)
Supply.Dispense	setType(BoundCodeableConceptDt<SupplyItemTypeEnum> theValue) Sets the value(s) for type (Category of dispense event)
Supply.Dispense	setType(SupplyItemTypeEnum theValue) Sets the value(s) for type (Category of dispense event)
Supply.Dispense	setWhenHandedOver(PeriodDt theValue) Sets the value(s) for whenHandedOver (Handover time)
Supply.Dispense	setWhenPrepared(PeriodDt theValue) Sets the value(s) for whenPrepared (Dispensing time)

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

Supply.Dispense

public Supply.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

getIdentifier

public IdentifierDt getIdentifier()

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

Definition: Identifier assigned by the dispensing facility when the dispense occurs

setIdentifier

public Supply.Dispense setIdentifier(IdentifierDt theValue)

Sets the value(s) for identifier (External identifier)

Definition: Identifier assigned by the dispensing facility when the dispense occurs

setIdentifier

public Supply.Dispense setIdentifier(IdentifierUseEnum theUse,
                            String theSystem,
                            String theValue,
                            String theLabel)

Sets the value for identifier (External identifier)

Definition: Identifier assigned by the dispensing facility when the dispense occurs

setIdentifier

public Supply.Dispense setIdentifier(String theSystem,
                            String theValue)

Sets the value for identifier (External identifier)

Definition: Identifier assigned by the dispensing facility when the dispense occurs

getStatus

public BoundCodeDt<SupplyDispenseStatusEnum> getStatus()

Gets the value(s) for status (in progress | dispensed | abandoned). creating it if it does not exist. Will not return null.

Definition: A code specifying the state of the dispense event.

setStatus

public Supply.Dispense setStatus(BoundCodeDt<SupplyDispenseStatusEnum> theValue)

Sets the value(s) for status (in progress | dispensed | abandoned)

Definition: A code specifying the state of the dispense event.

setStatus

public Supply.Dispense setStatus(SupplyDispenseStatusEnum theValue)

Sets the value(s) for status (in progress | dispensed | abandoned)

Definition: A code specifying the state of the dispense event.

getType

public BoundCodeableConceptDt<SupplyItemTypeEnum> getType()

Gets the value(s) for type (Category of dispense event). creating it if it does not exist. Will not return null.

Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

setType

public Supply.Dispense setType(BoundCodeableConceptDt<SupplyItemTypeEnum> theValue)

Sets the value(s) for type (Category of dispense event)

Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

setType

public Supply.Dispense setType(SupplyItemTypeEnum theValue)

Sets the value(s) for type (Category of dispense event)

Definition: Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.

getQuantity

public QuantityDt getQuantity()

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

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

public Supply.Dispense setQuantity(QuantityDt theValue)

Sets the value(s) for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

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

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

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

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

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

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

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

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

public Supply.Dispense setQuantity(double theValue)

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

setQuantity

public Supply.Dispense setQuantity(long theValue)

Sets the value for quantity (Amount dispensed)

Definition: The amount of supply that has been dispensed. Includes unit of measure.

getSuppliedItem

public ResourceReferenceDt getSuppliedItem()

Gets the value(s) for suppliedItem (Medication, Substance, or Device supplied). creating it if it does not exist. Will not return null.

Definition: Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.

setSuppliedItem

public Supply.Dispense setSuppliedItem(ResourceReferenceDt theValue)

Sets the value(s) for suppliedItem (Medication, Substance, or Device supplied)

Definition: Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.

getSupplier

public ResourceReferenceDt getSupplier()

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

Definition: The individual responsible for dispensing the medication

setSupplier

public Supply.Dispense setSupplier(ResourceReferenceDt theValue)

Sets the value(s) for supplier (Dispenser)

Definition: The individual responsible for dispensing the medication

getWhenPrepared

public PeriodDt getWhenPrepared()

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

Definition: The time the dispense event occurred.

setWhenPrepared

public Supply.Dispense setWhenPrepared(PeriodDt theValue)

Sets the value(s) for whenPrepared (Dispensing time)

Definition: The time the dispense event occurred.

getWhenHandedOver

public PeriodDt getWhenHandedOver()

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

Definition: The time the dispensed item was sent or handed to the patient (or agent).

setWhenHandedOver

public Supply.Dispense setWhenHandedOver(PeriodDt theValue)

Sets the value(s) for whenHandedOver (Handover time)

Definition: The time the dispensed item was sent or handed to the patient (or agent).

getDestination

public ResourceReferenceDt getDestination()

Gets the value(s) for destination (Where the Supply was sent). creating it if it does not exist. Will not return null.

Definition: Identification of the facility/location where the Supply was shipped to, as part of the dispense event.

setDestination

public Supply.Dispense setDestination(ResourceReferenceDt theValue)

Sets the value(s) for destination (Where the Supply was sent)

Definition: Identification of the facility/location where the Supply was shipped to, as part of the dispense event.

getReceiver

public List<ResourceReferenceDt> getReceiver()

Gets the value(s) for receiver (Who collected the Supply). creating it if it does not exist. Will not return null.

Definition: Identifies the person who picked up the Supply.

setReceiver

public Supply.Dispense setReceiver(List<ResourceReferenceDt> theValue)

Sets the value(s) for receiver (Who collected the Supply)

Definition: Identifies the person who picked up the Supply.

addReceiver

public ResourceReferenceDt addReceiver()

Adds and returns a new value for receiver (Who collected the Supply)

Definition: Identifies the person who picked up the Supply.