public class MedicationDispense extends BaseResource implements IResource
Definition: Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/MedicationDispense
| Modifier and Type | Class and Description |
|---|---|
static class |
MedicationDispense.DosageInstruction
Block class for child element: MedicationDispense.dosageInstruction ()
|
static class |
MedicationDispense.Substitution
Block class for child element: MedicationDispense.substitution ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
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_DESTINATION
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_MEDICATION
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_PRESCRIPTION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_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 |
RECEIVER
Fluent Client search parameter constant for receiver
|
static ReferenceClientParam |
RESPONSIBLEPARTY
Fluent Client search parameter constant for responsibleparty
|
static String |
SP_CODE
Search parameter constant for code
|
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_RECEIVER
Search parameter constant for receiver
|
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
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
MedicationDispense() |
| Modifier and Type | Method and Description |
|---|---|
ResourceReferenceDt |
addAuthorizingPrescription()
Adds and returns a new value for authorizingPrescription ()
|
MedicationDispense.DosageInstruction |
addDosageInstruction()
Adds and returns a new value for dosageInstruction ()
|
MedicationDispense |
addDosageInstruction(MedicationDispense.DosageInstruction theValue)
Adds a given new value for dosageInstruction ()
|
ResourceReferenceDt |
addReceiver()
Adds and returns a new value for receiver ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<ResourceReferenceDt> |
getAuthorizingPrescription()
Gets the value(s) for authorizingPrescription ().
|
SimpleQuantityDt |
getDaysSupply()
Gets the value(s) for daysSupply ().
|
ResourceReferenceDt |
getDestination()
Gets the value(s) for destination ().
|
ResourceReferenceDt |
getDispenser()
Gets the value(s) for dispenser (who.actor).
|
List<MedicationDispense.DosageInstruction> |
getDosageInstruction()
Gets the value(s) for dosageInstruction ().
|
MedicationDispense.DosageInstruction |
getDosageInstructionFirstRep()
Gets the first repetition for dosageInstruction (),
creating it if it does not already exist.
|
IdentifierDt |
getIdentifier()
Gets the value(s) for identifier (id).
|
IDatatype |
getMedication()
Gets the value(s) for medication[x] ().
|
String |
getNote()
Gets the value(s) for note ().
|
StringDt |
getNoteElement()
Gets the value(s) for note ().
|
ResourceReferenceDt |
getPatient()
Gets the value(s) for patient (who.focus).
|
SimpleQuantityDt |
getQuantity()
Gets the value(s) for quantity ().
|
List<ResourceReferenceDt> |
getReceiver()
Gets the value(s) for receiver ().
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<MedicationDispenseStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
MedicationDispense.Substitution |
getSubstitution()
Gets the value(s) for substitution ().
|
CodeableConceptDt |
getType()
Gets the value(s) for type ().
|
Date |
getWhenHandedOver()
Gets the value(s) for whenHandedOver ().
|
DateTimeDt |
getWhenHandedOverElement()
Gets the value(s) for whenHandedOver ().
|
Date |
getWhenPrepared()
Gets the value(s) for whenPrepared ().
|
DateTimeDt |
getWhenPreparedElement()
Gets the value(s) for whenPrepared ().
|
boolean |
isEmpty() |
MedicationDispense |
setAuthorizingPrescription(List<ResourceReferenceDt> theValue)
Sets the value(s) for authorizingPrescription ()
|
MedicationDispense |
setDaysSupply(SimpleQuantityDt theValue)
Sets the value(s) for daysSupply ()
|
MedicationDispense |
setDestination(ResourceReferenceDt theValue)
Sets the value(s) for destination ()
|
MedicationDispense |
setDispenser(ResourceReferenceDt theValue)
Sets the value(s) for dispenser (who.actor)
|
MedicationDispense |
setDosageInstruction(List<MedicationDispense.DosageInstruction> theValue)
Sets the value(s) for dosageInstruction ()
|
MedicationDispense |
setIdentifier(IdentifierDt theValue)
Sets the value(s) for identifier (id)
|
MedicationDispense |
setMedication(IDatatype theValue)
Sets the value(s) for medication[x] ()
|
MedicationDispense |
setNote(String theString)
Sets the value for note ()
|
MedicationDispense |
setNote(StringDt theValue)
Sets the value(s) for note ()
|
MedicationDispense |
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient (who.focus)
|
MedicationDispense |
setQuantity(SimpleQuantityDt theValue)
Sets the value(s) for quantity ()
|
MedicationDispense |
setReceiver(List<ResourceReferenceDt> theValue)
Sets the value(s) for receiver ()
|
MedicationDispense |
setStatus(BoundCodeDt<MedicationDispenseStatusEnum> theValue)
Sets the value(s) for status (status)
|
MedicationDispense |
setStatus(MedicationDispenseStatusEnum theValue)
Sets the value(s) for status (status)
|
MedicationDispense |
setSubstitution(MedicationDispense.Substitution theValue)
Sets the value(s) for substitution ()
|
MedicationDispense |
setType(CodeableConceptDt theValue)
Sets the value(s) for type ()
|
MedicationDispense |
setWhenHandedOver(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for whenHandedOver ()
|
MedicationDispense |
setWhenHandedOver(DateTimeDt theValue)
Sets the value(s) for whenHandedOver ()
|
MedicationDispense |
setWhenHandedOverWithSecondsPrecision(Date theDate)
Sets the value for whenHandedOver ()
|
MedicationDispense |
setWhenPrepared(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for whenPrepared ()
|
MedicationDispense |
setWhenPrepared(DateTimeDt theValue)
Sets the value(s) for whenPrepared ()
|
MedicationDispense |
setWhenPreparedWithSecondsPrecision(Date theDate)
Sets the value for whenPrepared ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_DESTINATION
Description: Return dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
public static final ReferenceClientParam DESTINATION
Description: Return dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
public static final String SP_DISPENSER
Description: Return all dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.dispenser
public static final ReferenceClientParam DISPENSER
Description: Return all dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.dispenser
public static final String SP_IDENTIFIER
Description: Return dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
public static final TokenClientParam IDENTIFIER
Description: Return dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
public static final String SP_MEDICATION
Description: Return dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
public static final ReferenceClientParam MEDICATION
Description: Return dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
public static final String SP_CODE
Description: Return dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
public static final TokenClientParam CODE
Description: Return dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
public static final String SP_PATIENT
Description: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.patient
public static final ReferenceClientParam PATIENT
Description: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.patient
public static final String SP_PRESCRIPTION
Description: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
public static final ReferenceClientParam PRESCRIPTION
Description: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
public static final String SP_RESPONSIBLEPARTY
Description: Return all dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
public static final ReferenceClientParam RESPONSIBLEPARTY
Description: Return all dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
public static final String SP_STATUS
Description: Status of the dispense
Type: token
Path: MedicationDispense.status
public static final TokenClientParam STATUS
Description: Status of the dispense
Type: token
Path: MedicationDispense.status
public static final String SP_TYPE
Description: Return all dispenses of a specific type
Type: token
Path: MedicationDispense.type
public static final TokenClientParam TYPE
Description: Return all dispenses of a specific type
Type: token
Path: MedicationDispense.type
public static final String SP_WHENHANDEDOVER
Description: Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)
Type: date
Path: MedicationDispense.whenHandedOver
public static final DateClientParam WHENHANDEDOVER
Description: Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)
Type: date
Path: MedicationDispense.whenHandedOver
public static final String SP_WHENPREPARED
Description: Date when medication prepared
Type: date
Path: MedicationDispense.whenPrepared
public static final DateClientParam WHENPREPARED
Description: Date when medication prepared
Type: date
Path: MedicationDispense.whenPrepared
public static final String SP_RECEIVER
Description:
Type: reference
Path: MedicationDispense.receiver
public static final ReferenceClientParam RECEIVER
Description:
Type: reference
Path: MedicationDispense.receiver
public static final Include INCLUDE_DESTINATION
public static final Include INCLUDE_DISPENSER
public static final Include INCLUDE_MEDICATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PRESCRIPTION
public static final Include INCLUDE_RECEIVER
public static final Include INCLUDE_RESPONSIBLEPARTY
public MedicationDispense()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic IdentifierDt getIdentifier()
null.
Definition: Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
public MedicationDispense setIdentifier(IdentifierDt theValue)
Definition: Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
public BoundCodeDt<MedicationDispenseStatusEnum> getStatusElement()
null.
Definition: A code specifying the state of the set of dispense events.
public String getStatus()
null.
Definition: A code specifying the state of the set of dispense events.
public MedicationDispense setStatus(BoundCodeDt<MedicationDispenseStatusEnum> theValue)
Definition: A code specifying the state of the set of dispense events.
public MedicationDispense setStatus(MedicationDispenseStatusEnum theValue)
Definition: A code specifying the state of the set of dispense events.
public ResourceReferenceDt getPatient()
null.
Definition: A link to a resource representing the person to whom the medication will be given.
public MedicationDispense setPatient(ResourceReferenceDt theValue)
Definition: A link to a resource representing the person to whom the medication will be given.
public ResourceReferenceDt getDispenser()
null.
Definition: The individual responsible for dispensing the medication
public MedicationDispense setDispenser(ResourceReferenceDt theValue)
Definition: The individual responsible for dispensing the medication
public List<ResourceReferenceDt> getAuthorizingPrescription()
null.
Definition: Indicates the medication order that is being dispensed against.
public MedicationDispense setAuthorizingPrescription(List<ResourceReferenceDt> theValue)
Definition: Indicates the medication order that is being dispensed against.
public ResourceReferenceDt addAuthorizingPrescription()
Definition: Indicates the medication order that is being dispensed against.
public CodeableConceptDt getType()
null.
Definition: Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
public MedicationDispense setType(CodeableConceptDt theValue)
Definition: Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
public SimpleQuantityDt getQuantity()
null.
Definition: The amount of medication that has been dispensed. Includes unit of measure.
public MedicationDispense setQuantity(SimpleQuantityDt theValue)
Definition: The amount of medication that has been dispensed. Includes unit of measure.
public SimpleQuantityDt getDaysSupply()
null.
Definition: The amount of medication expressed as a timing amount.
public MedicationDispense setDaysSupply(SimpleQuantityDt theValue)
Definition: The amount of medication expressed as a timing amount.
public IDatatype getMedication()
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.
public MedicationDispense setMedication(IDatatype theValue)
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.
public DateTimeDt getWhenPreparedElement()
null.
Definition: The time when the dispensed product was packaged and reviewed.
public Date getWhenPrepared()
null.
Definition: The time when the dispensed product was packaged and reviewed.
public MedicationDispense setWhenPrepared(DateTimeDt theValue)
Definition: The time when the dispensed product was packaged and reviewed.
public MedicationDispense setWhenPrepared(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The time when the dispensed product was packaged and reviewed.
public MedicationDispense setWhenPreparedWithSecondsPrecision(Date theDate)
Definition: The time when the dispensed product was packaged and reviewed.
public DateTimeDt getWhenHandedOverElement()
null.
Definition: The time the dispensed product was provided to the patient or their representative.
public Date getWhenHandedOver()
null.
Definition: The time the dispensed product was provided to the patient or their representative.
public MedicationDispense setWhenHandedOver(DateTimeDt theValue)
Definition: The time the dispensed product was provided to the patient or their representative.
public MedicationDispense setWhenHandedOver(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The time the dispensed product was provided to the patient or their representative.
public MedicationDispense setWhenHandedOverWithSecondsPrecision(Date theDate)
Definition: The time the dispensed product was provided to the patient or their representative.
public ResourceReferenceDt getDestination()
null.
Definition: Identification of the facility/location where the medication was shipped to, as part of the dispense event.
public MedicationDispense setDestination(ResourceReferenceDt theValue)
Definition: Identification of the facility/location where the medication was shipped to, as part of the dispense event.
public List<ResourceReferenceDt> getReceiver()
null.
Definition: Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional
public MedicationDispense setReceiver(List<ResourceReferenceDt> theValue)
Definition: Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional
public ResourceReferenceDt addReceiver()
Definition: Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional
public StringDt getNoteElement()
null.
Definition: Extra information about the dispense that could not be conveyed in the other attributes.
public String getNote()
null.
Definition: Extra information about the dispense that could not be conveyed in the other attributes.
public MedicationDispense setNote(StringDt theValue)
Definition: Extra information about the dispense that could not be conveyed in the other attributes.
public MedicationDispense setNote(String theString)
Definition: Extra information about the dispense that could not be conveyed in the other attributes.
public List<MedicationDispense.DosageInstruction> getDosageInstruction()
null.
Definition: Indicates how the medication is to be used by the patient
public MedicationDispense setDosageInstruction(List<MedicationDispense.DosageInstruction> theValue)
Definition: Indicates how the medication is to be used by the patient
public MedicationDispense.DosageInstruction addDosageInstruction()
Definition: Indicates how the medication is to be used by the patient
public MedicationDispense addDosageInstruction(MedicationDispense.DosageInstruction theValue)
Definition: Indicates how the medication is to be used by the patient
theValue - The dosageInstruction to add (must not be null)public MedicationDispense.DosageInstruction getDosageInstructionFirstRep()
Definition: Indicates how the medication is to be used by the patient
public MedicationDispense.Substitution getSubstitution()
null.
Definition: Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.
public MedicationDispense setSubstitution(MedicationDispense.Substitution theValue)
Definition: Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.