ca.uhn.fhir.model.dstu.resource

Class MedicationDispense.Dispense

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

MedicationDispense

public static class MedicationDispense.Dispense
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: MedicationDispense.dispense (Details for individual dispensed medicationdetails)

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

Constructor Summary

Constructors

Constructor and Description
MedicationDispense.Dispense()

Method Summary

Methods

Modifier and Type	Method and Description
MedicationDispense.DispenseDosage	addDosage() Adds and returns a new value for dosage (Medicine administration instructions to the patient/carer)
ResourceReferenceDt	addReceiver() Adds and returns a new value for receiver (Who collected the medication)
<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 medication was sent).
List<MedicationDispense.DispenseDosage>	getDosage() Gets the value(s) for dosage (Medicine administration instructions to the patient/carer).
MedicationDispense.DispenseDosage	getDosageFirstRep() Gets the first repetition for dosage (Medicine administration instructions to the patient/carer), creating it if it does not already exist.
IdentifierDt	getIdentifier() Gets the value(s) for identifier (External identifier for individual item).
ResourceReferenceDt	getMedication() Gets the value(s) for medication (What medication was supplied).
QuantityDt	getQuantity() Gets the value(s) for quantity (Amount dispensed).
List<ResourceReferenceDt>	getReceiver() Gets the value(s) for receiver (Who collected the medication).
BoundCodeDt<MedicationDispenseStatusEnum>	getStatus() Gets the value(s) for status (in progress | on hold | completed | entered in error | stopped).
CodeableConceptDt	getType() Gets the value(s) for type (Trial fill, partial fill, emergency fill, etc.).
DateTimeDt	getWhenHandedOver() Gets the value(s) for whenHandedOver (Handover time).
DateTimeDt	getWhenPrepared() Gets the value(s) for whenPrepared (Dispense processing time).
boolean	isEmpty()
MedicationDispense.Dispense	setDestination(ResourceReferenceDt theValue) Sets the value(s) for destination (Where the medication was sent)
MedicationDispense.Dispense	setDosage(List<MedicationDispense.DispenseDosage> theValue) Sets the value(s) for dosage (Medicine administration instructions to the patient/carer)
MedicationDispense.Dispense	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (External identifier for individual item)
MedicationDispense.Dispense	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (External identifier for individual item)
MedicationDispense.Dispense	setIdentifier(String theSystem, String theValue) Sets the value for identifier (External identifier for individual item)
MedicationDispense.Dispense	setMedication(ResourceReferenceDt theValue) Sets the value(s) for medication (What medication was supplied)
MedicationDispense.Dispense	setQuantity(double theValue) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(long theValue) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theUnits) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(QuantityCompararatorEnum theComparator, double theValue, String theSystem, String theUnits) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theUnits) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(QuantityCompararatorEnum theComparator, long theValue, String theSystem, String theUnits) Sets the value for quantity (Amount dispensed)
MedicationDispense.Dispense	setQuantity(QuantityDt theValue) Sets the value(s) for quantity (Amount dispensed)
MedicationDispense.Dispense	setReceiver(List<ResourceReferenceDt> theValue) Sets the value(s) for receiver (Who collected the medication)
MedicationDispense.Dispense	setStatus(BoundCodeDt<MedicationDispenseStatusEnum> theValue) Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
MedicationDispense.Dispense	setStatus(MedicationDispenseStatusEnum theValue) Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
MedicationDispense.Dispense	setType(CodeableConceptDt theValue) Sets the value(s) for type (Trial fill, partial fill, emergency fill, etc.)
MedicationDispense.Dispense	setWhenHandedOver(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for whenHandedOver (Handover time)
MedicationDispense.Dispense	setWhenHandedOver(DateTimeDt theValue) Sets the value(s) for whenHandedOver (Handover time)
MedicationDispense.Dispense	setWhenHandedOverWithSecondsPrecision(Date theDate) Sets the value for whenHandedOver (Handover time)
MedicationDispense.Dispense	setWhenPrepared(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for whenPrepared (Dispense processing time)
MedicationDispense.Dispense	setWhenPrepared(DateTimeDt theValue) Sets the value(s) for whenPrepared (Dispense processing time)
MedicationDispense.Dispense	setWhenPreparedWithSecondsPrecision(Date theDate) Sets the value for whenPrepared (Dispense processing 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

MedicationDispense.Dispense

public MedicationDispense.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 for individual item). creating it if it does not exist. Will not return null.

Definition: Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.

setIdentifier

public MedicationDispense.Dispense setIdentifier(IdentifierDt theValue)

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

Definition: Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.

setIdentifier

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

Sets the value for identifier (External identifier for individual item)

Definition: Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.

setIdentifier

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

Sets the value for identifier (External identifier for individual item)

Definition: Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.

getStatus

public BoundCodeDt<MedicationDispenseStatusEnum> getStatus()

Gets the value(s) for status (in progress | on hold | completed | entered in error | stopped). creating it if it does not exist. Will not return null.

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

setStatus

public MedicationDispense.Dispense setStatus(BoundCodeDt<MedicationDispenseStatusEnum> theValue)

Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)

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

setStatus

public MedicationDispense.Dispense setStatus(MedicationDispenseStatusEnum theValue)

Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)

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

getType

public CodeableConceptDt getType()

Gets the value(s) for type (Trial fill, partial fill, emergency fill, etc.). 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 MedicationDispense.Dispense setType(CodeableConceptDt theValue)

Sets the value(s) for type (Trial fill, partial fill, emergency fill, etc.)

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 medication that has been dispensed. Includes unit of measure.

setQuantity

public MedicationDispense.Dispense setQuantity(QuantityDt theValue)

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

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

setQuantity

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

Sets the value for quantity (Amount dispensed)

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

setQuantity

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

Sets the value for quantity (Amount dispensed)

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

setQuantity

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

Sets the value for quantity (Amount dispensed)

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

setQuantity

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

Sets the value for quantity (Amount dispensed)

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

setQuantity

public MedicationDispense.Dispense setQuantity(double theValue)

Sets the value for quantity (Amount dispensed)

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

setQuantity

public MedicationDispense.Dispense setQuantity(long theValue)

Sets the value for quantity (Amount dispensed)

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

getMedication

public ResourceReferenceDt getMedication()

Gets the value(s) for medication (What medication was supplied). creating it if it does not exist. Will not return null.

Definition: Identifies the medication being administered. 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 MedicationDispense.Dispense setMedication(ResourceReferenceDt theValue)

Sets the value(s) for medication (What medication was supplied)

Definition: Identifies the medication being administered. 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.

getWhenPrepared

public DateTimeDt getWhenPrepared()

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

Definition: The time when the dispensed product was packaged and reviewed.

setWhenPrepared

public MedicationDispense.Dispense setWhenPrepared(DateTimeDt theValue)

Sets the value(s) for whenPrepared (Dispense processing time)

Definition: The time when the dispensed product was packaged and reviewed.

setWhenPreparedWithSecondsPrecision

public MedicationDispense.Dispense setWhenPreparedWithSecondsPrecision(Date theDate)

Sets the value for whenPrepared (Dispense processing time)

Definition: The time when the dispensed product was packaged and reviewed.

setWhenPrepared

public MedicationDispense.Dispense setWhenPrepared(Date theDate,
                                          TemporalPrecisionEnum thePrecision)

Sets the value for whenPrepared (Dispense processing time)

Definition: The time when the dispensed product was packaged and reviewed.

getWhenHandedOver

public DateTimeDt 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 product was provided to the patient or their representative.

setWhenHandedOver

public MedicationDispense.Dispense setWhenHandedOver(DateTimeDt theValue)

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

Definition: The time the dispensed product was provided to the patient or their representative.

setWhenHandedOverWithSecondsPrecision

public MedicationDispense.Dispense setWhenHandedOverWithSecondsPrecision(Date theDate)

Sets the value for whenHandedOver (Handover time)

Definition: The time the dispensed product was provided to the patient or their representative.

setWhenHandedOver

public MedicationDispense.Dispense setWhenHandedOver(Date theDate,
                                            TemporalPrecisionEnum thePrecision)

Sets the value for whenHandedOver (Handover time)

Definition: The time the dispensed product was provided to the patient or their representative.

getDestination

public ResourceReferenceDt getDestination()

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

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

setDestination

public MedicationDispense.Dispense setDestination(ResourceReferenceDt theValue)

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

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

getReceiver

public List<ResourceReferenceDt> getReceiver()

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

Definition: Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional

setReceiver

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

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

Definition: Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional

addReceiver

public ResourceReferenceDt addReceiver()

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

Definition: Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional

getDosage

public List<MedicationDispense.DispenseDosage> getDosage()

Gets the value(s) for dosage (Medicine administration instructions to the patient/carer). creating it if it does not exist. Will not return null.

Definition: Indicates how the medication is to be used by the patient

setDosage

public MedicationDispense.Dispense setDosage(List<MedicationDispense.DispenseDosage> theValue)

Sets the value(s) for dosage (Medicine administration instructions to the patient/carer)

Definition: Indicates how the medication is to be used by the patient

addDosage

public MedicationDispense.DispenseDosage addDosage()

Adds and returns a new value for dosage (Medicine administration instructions to the patient/carer)

Definition: Indicates how the medication is to be used by the patient

getDosageFirstRep

public MedicationDispense.DispenseDosage getDosageFirstRep()

Gets the first repetition for dosage (Medicine administration instructions to the patient/carer), creating it if it does not already exist.

Definition: Indicates how the medication is to be used by the patient