ca.uhn.fhir.model.dstu.resource

Class MedicationDispense

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class MedicationDispense
extends BaseResource
implements IResource

HAPI/FHIR MedicationDispense Resource (Dispensing a medication to a named patient)

Definition: Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/MedicationDispense

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MedicationDispense.Dispense Block class for child element: MedicationDispense.dispense (Details for individual dispensed medicationdetails)
static class	MedicationDispense.DispenseDosage Block class for child element: MedicationDispense.dispense.dosage (Medicine administration instructions to the patient/carer)
static class	MedicationDispense.Substitution Block class for child element: MedicationDispense.substitution (Deals with substitution of one medicine for another)

Field Summary

Fields

Modifier and Type	Field and Description
static ReferenceClientParam	DESTINATION Fluent Client search parameter constant for destination
static ReferenceClientParam	DISPENSER Fluent Client search parameter constant for dispenser
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_AUTHORIZINGPRESCRIPTION Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_DISPENSE_DESTINATION Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_DISPENSE_MEDICATION Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_DISPENSER Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_SUBSTITUTION_RESPONSIBLEPARTY Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	MEDICATION Fluent Client search parameter constant for medication
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static ReferenceClientParam	PRESCRIPTION Fluent Client search parameter constant for prescription
static ReferenceClientParam	RESPONSIBLEPARTY Fluent Client search parameter constant for responsibleparty
static String	SP_DESTINATION Search parameter constant for destination
static String	SP_DISPENSER Search parameter constant for dispenser
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_MEDICATION Search parameter constant for medication
static String	SP_PATIENT Search parameter constant for patient
static String	SP_PRESCRIPTION Search parameter constant for prescription
static String	SP_RESPONSIBLEPARTY Search parameter constant for responsibleparty
static String	SP_STATUS Search parameter constant for status
static String	SP_TYPE Search parameter constant for type
static String	SP_WHENHANDEDOVER Search parameter constant for whenhandedover
static String	SP_WHENPREPARED Search parameter constant for whenprepared
static TokenClientParam	STATUS Fluent Client search parameter constant for status
static TokenClientParam	TYPE Fluent Client search parameter constant for type
static DateClientParam	WHENHANDEDOVER Fluent Client search parameter constant for whenhandedover
static DateClientParam	WHENPREPARED Fluent Client search parameter constant for whenprepared

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
MedicationDispense()

Method Summary

Methods

Modifier and Type	Method and Description
ResourceReferenceDt	addAuthorizingPrescription() Adds and returns a new value for authorizingPrescription (Medication order that authorizes the dispense)
MedicationDispense.Dispense	addDispense() Adds and returns a new value for dispense (Details for individual dispensed medicationdetails)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<ResourceReferenceDt>	getAuthorizingPrescription() Gets the value(s) for authorizingPrescription (Medication order that authorizes the dispense).
List<MedicationDispense.Dispense>	getDispense() Gets the value(s) for dispense (Details for individual dispensed medicationdetails).
MedicationDispense.Dispense	getDispenseFirstRep() Gets the first repetition for dispense (Details for individual dispensed medicationdetails), creating it if it does not already exist.
ResourceReferenceDt	getDispenser() Gets the value(s) for dispenser (Practitioner responsible for dispensing medication).
IdentifierDt	getIdentifier() Gets the value(s) for identifier (External identifier).
ResourceReferenceDt	getPatient() Gets the value(s) for patient (Who the dispense is for).
BoundCodeDt<MedicationDispenseStatusEnum>	getStatus() Gets the value(s) for status (in progress | on hold | completed | entered in error | stopped).
MedicationDispense.Substitution	getSubstitution() Gets the value(s) for substitution (Deals with substitution of one medicine for another).
boolean	isEmpty()
MedicationDispense	setAuthorizingPrescription(List<ResourceReferenceDt> theValue) Sets the value(s) for authorizingPrescription (Medication order that authorizes the dispense)
MedicationDispense	setDispense(List<MedicationDispense.Dispense> theValue) Sets the value(s) for dispense (Details for individual dispensed medicationdetails)
MedicationDispense	setDispenser(ResourceReferenceDt theValue) Sets the value(s) for dispenser (Practitioner responsible for dispensing medication)
MedicationDispense	setIdentifier(IdentifierDt theValue) Sets the value(s) for identifier (External identifier)
MedicationDispense	setIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Sets the value for identifier (External identifier)
MedicationDispense	setIdentifier(String theSystem, String theValue) Sets the value for identifier (External identifier)
MedicationDispense	setPatient(ResourceReferenceDt theValue) Sets the value(s) for patient (Who the dispense is for)
MedicationDispense	setStatus(BoundCodeDt<MedicationDispenseStatusEnum> theValue) Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
MedicationDispense	setStatus(MedicationDispenseStatusEnum theValue) Sets the value(s) for status (in progress | on hold | completed | entered in error | stopped)
MedicationDispense	setSubstitution(MedicationDispense.Substitution theValue) Sets the value(s) for substitution (Deals with substitution of one medicine for another)

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

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

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

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

Methods inherited from class java.lang.Object

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

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

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Detail

SP_DESTINATION

public static final String SP_DESTINATION

Search parameter constant for destination

Description: Return dispenses that should be sent to a secific destination
Type: reference
Path: MedicationDispense.dispense.destination

See Also:

Constant Field Values

DESTINATION

public static final ReferenceClientParam DESTINATION

Fluent Client search parameter constant for destination

Description: Return dispenses that should be sent to a secific destination
Type: reference
Path: MedicationDispense.dispense.destination

INCLUDE_DISPENSE_DESTINATION

public static final Include INCLUDE_DISPENSE_DESTINATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.dispense.destination".

SP_DISPENSER

public static final String SP_DISPENSER

Search parameter constant for dispenser

Description: Return all dispenses performed by a specific indiividual
Type: reference
Path: MedicationDispense.dispenser

See Also:

Constant Field Values

DISPENSER

public static final ReferenceClientParam DISPENSER

Fluent Client search parameter constant for dispenser

Description: Return all dispenses performed by a specific indiividual
Type: reference
Path: MedicationDispense.dispenser

INCLUDE_DISPENSER

public static final Include INCLUDE_DISPENSER

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.dispenser".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description: Return dispenses with this external identity
Type: token
Path: MedicationDispense.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Return dispenses with this external identity
Type: token
Path: MedicationDispense.identifier

SP_MEDICATION

public static final String SP_MEDICATION

Search parameter constant for medication

Description: Returns dispenses of this medicine
Type: reference
Path: MedicationDispense.dispense.medication

See Also:

Constant Field Values

MEDICATION

public static final ReferenceClientParam MEDICATION

Fluent Client search parameter constant for medication

Description: Returns dispenses of this medicine
Type: reference
Path: MedicationDispense.dispense.medication

INCLUDE_DISPENSE_MEDICATION

public static final Include INCLUDE_DISPENSE_MEDICATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.dispense.medication".

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.patient

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.patient

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.patient".

SP_PRESCRIPTION

public static final String SP_PRESCRIPTION

Search parameter constant for prescription

Description: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription

See Also:

Constant Field Values

PRESCRIPTION

public static final ReferenceClientParam PRESCRIPTION

Fluent Client search parameter constant for prescription

Description: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription

INCLUDE_AUTHORIZINGPRESCRIPTION

public static final Include INCLUDE_AUTHORIZINGPRESCRIPTION

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.authorizingPrescription".

SP_RESPONSIBLEPARTY

public static final String SP_RESPONSIBLEPARTY

Search parameter constant for responsibleparty

Description: Return all dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty

See Also:

Constant Field Values

RESPONSIBLEPARTY

public static final ReferenceClientParam RESPONSIBLEPARTY

Fluent Client search parameter constant for responsibleparty

Description: Return all dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty

INCLUDE_SUBSTITUTION_RESPONSIBLEPARTY

public static final Include INCLUDE_SUBSTITUTION_RESPONSIBLEPARTY

Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense.substitution.responsibleParty".

SP_STATUS

public static final String SP_STATUS

Search parameter constant for status

Description: Status of the dispense
Type: token
Path: MedicationDispense.dispense.status

See Also:

Constant Field Values

STATUS

public static final TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: Status of the dispense
Type: token
Path: MedicationDispense.dispense.status

SP_TYPE

public static final String SP_TYPE

Search parameter constant for type

Description: Return all dispenses of a specific type
Type: token
Path: MedicationDispense.dispense.type

See Also:

Constant Field Values

TYPE

public static final TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: Return all dispenses of a specific type
Type: token
Path: MedicationDispense.dispense.type

SP_WHENHANDEDOVER

public static final String SP_WHENHANDEDOVER

Search parameter constant for whenhandedover

Description: Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)
Type: date
Path: MedicationDispense.dispense.whenHandedOver

See Also:

Constant Field Values

WHENHANDEDOVER

public static final DateClientParam WHENHANDEDOVER

Fluent Client search parameter constant for whenhandedover

Description: Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)
Type: date
Path: MedicationDispense.dispense.whenHandedOver

SP_WHENPREPARED

public static final String SP_WHENPREPARED

Search parameter constant for whenprepared

Description: Date when medication prepared
Type: date
Path: MedicationDispense.dispense.whenPrepared

See Also:

Constant Field Values

WHENPREPARED

public static final DateClientParam WHENPREPARED

Fluent Client search parameter constant for whenprepared

Description: Date when medication prepared
Type: date
Path: MedicationDispense.dispense.whenPrepared

Constructor Detail

MedicationDispense

public MedicationDispense()

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 - this is an identifier assigned outside FHIR.

setIdentifier

public MedicationDispense setIdentifier(IdentifierDt theValue)

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

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

setIdentifier

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

Sets the value for identifier (External identifier)

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

setIdentifier

public MedicationDispense setIdentifier(String theSystem,
                               String theValue)

Sets the value for identifier (External identifier)

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 set of dispense events.

setStatus

public MedicationDispense 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 set of dispense events.

setStatus

public MedicationDispense 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 set of dispense events.

getPatient

public ResourceReferenceDt getPatient()

Gets the value(s) for patient (Who the dispense is for). creating it if it does not exist. Will not return null.

Definition: A link to a resource representing the person to whom the medication will be given.

setPatient

public MedicationDispense setPatient(ResourceReferenceDt theValue)

Sets the value(s) for patient (Who the dispense is for)

Definition: A link to a resource representing the person to whom the medication will be given.

getDispenser

public ResourceReferenceDt getDispenser()

Gets the value(s) for dispenser (Practitioner responsible for dispensing medication). creating it if it does not exist. Will not return null.

Definition: The individual responsible for dispensing the medication

setDispenser

public MedicationDispense setDispenser(ResourceReferenceDt theValue)

Sets the value(s) for dispenser (Practitioner responsible for dispensing medication)

Definition: The individual responsible for dispensing the medication

getAuthorizingPrescription

public List<ResourceReferenceDt> getAuthorizingPrescription()

Gets the value(s) for authorizingPrescription (Medication order that authorizes the dispense). creating it if it does not exist. Will not return null.

Definition: Indicates the medication order that is being dispensed against.

setAuthorizingPrescription

public MedicationDispense setAuthorizingPrescription(List<ResourceReferenceDt> theValue)

Sets the value(s) for authorizingPrescription (Medication order that authorizes the dispense)

Definition: Indicates the medication order that is being dispensed against.

addAuthorizingPrescription

public ResourceReferenceDt addAuthorizingPrescription()

Adds and returns a new value for authorizingPrescription (Medication order that authorizes the dispense)

Definition: Indicates the medication order that is being dispensed against.

getDispense

public List<MedicationDispense.Dispense> getDispense()

Gets the value(s) for dispense (Details for individual dispensed medicationdetails). creating it if it does not exist. Will not return null.

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

setDispense

public MedicationDispense setDispense(List<MedicationDispense.Dispense> theValue)

Sets the value(s) for dispense (Details for individual dispensed medicationdetails)

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

addDispense

public MedicationDispense.Dispense addDispense()

Adds and returns a new value for dispense (Details for individual dispensed medicationdetails)

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

getDispenseFirstRep

public MedicationDispense.Dispense getDispenseFirstRep()

Gets the first repetition for dispense (Details for individual dispensed medicationdetails), creating it if it does not already exist.

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

getSubstitution

public MedicationDispense.Substitution getSubstitution()

Gets the value(s) for substitution (Deals with substitution of one medicine for another). creating it if it does not exist. Will not return null.

Definition: Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.

setSubstitution

public MedicationDispense setSubstitution(MedicationDispense.Substitution theValue)

Sets the value(s) for substitution (Deals with substitution of one medicine for another)

Definition: Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.