MedicationDispense (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.MedicationDispense

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class MedicationDispense
extends DomainResource
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MedicationDispense.MedicationDispenseDosageInstructionComponent`
`static class`	`MedicationDispense.MedicationDispenseStatus`
`static class`	`MedicationDispense.MedicationDispenseStatusEnumFactory`
`static class`	`MedicationDispense.MedicationDispenseSubstitutionComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Reference>`	`authorizingPrescription` Indicates the medication order that is being dispensed against.
`protected List<MedicationOrder>`	`authorizingPrescriptionTarget` The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`protected SimpleQuantity`	`daysSupply` The amount of medication expressed as a timing amount.
`protected Reference`	`destination` Identification of the facility/location where the medication was shipped to, as part of the dispense event.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DESTINATION` Fluent Client search parameter constant for destination
`protected Location`	`destinationTarget` The actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
`protected Reference`	`dispenser` The individual responsible for dispensing the medication.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DISPENSER` Fluent Client search parameter constant for dispenser
`protected Practitioner`	`dispenserTarget` The actual object that is the target of the reference (The individual responsible for dispensing the medication.)
`protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent>`	`dosageInstruction` Indicates how the medication is to be used by the patient.
`protected Identifier`	`identifier` Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DESTINATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DISPENSER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_MEDICATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PRESCRIPTION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RECEIVER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RESPONSIBLEPARTY` Constant for fluent queries to be used to add include statements.
`protected Type`	`medication` Identifies the medication being administered.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`MEDICATION` Fluent Client search parameter constant for medication
`protected List<Annotation>`	`note` Extra information about the dispense that could not be conveyed in the other attributes.
`protected Reference`	`patient` A link to a resource representing the person to whom the medication will be given.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Patient`	`patientTarget` The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PRESCRIPTION` Fluent Client search parameter constant for prescription
`protected SimpleQuantity`	`quantity` The amount of medication that has been dispensed.
`protected List<Reference>`	`receiver` Identifies the person who picked up the medication.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RECEIVER` Fluent Client search parameter constant for receiver
`protected List<Resource>`	`receiverTarget` The actual objects that are the target of the reference (Identifies the person who picked up the medication.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RESPONSIBLEPARTY` Fluent Client search parameter constant for responsibleparty
`static String`	`SP_CODE` Search parameter: code
`static String`	`SP_DESTINATION` Search parameter: destination
`static String`	`SP_DISPENSER` Search parameter: dispenser
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_MEDICATION` Search parameter: medication
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PRESCRIPTION` Search parameter: prescription
`static String`	`SP_RECEIVER` Search parameter: receiver
`static String`	`SP_RESPONSIBLEPARTY` Search parameter: responsibleparty
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_TYPE` Search parameter: type
`static String`	`SP_WHENHANDEDOVER` Search parameter: whenhandedover
`static String`	`SP_WHENPREPARED` Search parameter: whenprepared
`protected Enumeration<MedicationDispense.MedicationDispenseStatus>`	`status` A code specifying the state of the set of dispense events.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected MedicationDispense.MedicationDispenseSubstitutionComponent`	`substitution` Indicates whether or not substitution was made as part of the dispense.
`protected CodeableConcept`	`type` Indicates the type of dispensing event that is performed.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`protected DateTimeType`	`whenHandedOver` The time the dispensed product was provided to the patient or their representative.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`WHENHANDEDOVER` Fluent Client search parameter constant for whenhandedover
`protected DateTimeType`	`whenPrepared` The time when the dispensed product was packaged and reviewed.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`WHENPREPARED` Fluent Client search parameter constant for whenprepared

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

MedicationDispense()
Constructor

MedicationDispense(Type medication)
Constructor

Constructors
Constructor and Description
`MedicationDispense()` Constructor
`MedicationDispense(Type medication)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reference`	`addAuthorizingPrescription()`
`MedicationDispense`	`addAuthorizingPrescription(Reference t)`
`MedicationOrder`	`addAuthorizingPrescriptionTarget()`
`Base`	`addChild(String name)`
`MedicationDispense.MedicationDispenseDosageInstructionComponent`	`addDosageInstruction()`
`MedicationDispense`	`addDosageInstruction(MedicationDispense.MedicationDispenseDosageInstructionComponent t)`
`Annotation`	`addNote()`
`MedicationDispense`	`addNote(Annotation t)`
`Reference`	`addReceiver()`
`MedicationDispense`	`addReceiver(Reference t)`
`MedicationDispense`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<Reference>`	`getAuthorizingPrescription()`
`List<MedicationOrder>`	`getAuthorizingPrescriptionTarget()`
`SimpleQuantity`	`getDaysSupply()`
`Reference`	`getDestination()`
`Location`	`getDestinationTarget()`
`Reference`	`getDispenser()`
`Practitioner`	`getDispenserTarget()`
`List<MedicationDispense.MedicationDispenseDosageInstructionComponent>`	`getDosageInstruction()`
`Identifier`	`getIdentifier()`
`Type`	`getMedication()`
`CodeableConcept`	`getMedicationCodeableConcept()`
`Reference`	`getMedicationReference()`
`List<Annotation>`	`getNote()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`SimpleQuantity`	`getQuantity()`
`List<Reference>`	`getReceiver()`
`List<Resource>`	`getReceiverTarget()`
`ResourceType`	`getResourceType()`
`MedicationDispense.MedicationDispenseStatus`	`getStatus()`
`Enumeration<MedicationDispense.MedicationDispenseStatus>`	`getStatusElement()`
`MedicationDispense.MedicationDispenseSubstitutionComponent`	`getSubstitution()`
`CodeableConcept`	`getType()`
`Date`	`getWhenHandedOver()`
`DateTimeType`	`getWhenHandedOverElement()`
`Date`	`getWhenPrepared()`
`DateTimeType`	`getWhenPreparedElement()`
`boolean`	`hasAuthorizingPrescription()`
`boolean`	`hasDaysSupply()`
`boolean`	`hasDestination()`
`boolean`	`hasDispenser()`
`boolean`	`hasDosageInstruction()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMedication()`
`boolean`	`hasMedicationCodeableConcept()`
`boolean`	`hasMedicationReference()`
`boolean`	`hasNote()`
`boolean`	`hasPatient()`
`boolean`	`hasQuantity()`
`boolean`	`hasReceiver()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubstitution()`
`boolean`	`hasType()`
`boolean`	`hasWhenHandedOver()`
`boolean`	`hasWhenHandedOverElement()`
`boolean`	`hasWhenPrepared()`
`boolean`	`hasWhenPreparedElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`MedicationDispense`	`setDaysSupply(SimpleQuantity value)`
`MedicationDispense`	`setDestination(Reference value)`
`MedicationDispense`	`setDestinationTarget(Location value)`
`MedicationDispense`	`setDispenser(Reference value)`
`MedicationDispense`	`setDispenserTarget(Practitioner value)`
`MedicationDispense`	`setIdentifier(Identifier value)`
`MedicationDispense`	`setMedication(Type value)`
`MedicationDispense`	`setPatient(Reference value)`
`MedicationDispense`	`setPatientTarget(Patient value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`MedicationDispense`	`setQuantity(SimpleQuantity value)`
`MedicationDispense`	`setStatus(MedicationDispense.MedicationDispenseStatus value)`
`MedicationDispense`	`setStatusElement(Enumeration<MedicationDispense.MedicationDispenseStatus> value)`
`MedicationDispense`	`setSubstitution(MedicationDispense.MedicationDispenseSubstitutionComponent value)`
`MedicationDispense`	`setType(CodeableConcept value)`
`MedicationDispense`	`setWhenHandedOver(Date value)`
`MedicationDispense`	`setWhenHandedOverElement(DateTimeType value)`
`MedicationDispense`	`setWhenPrepared(Date value)`
`MedicationDispense`	`setWhenPreparedElement(DateTimeType value)`
`protected MedicationDispense`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected Identifier identifier
```
    Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
  - status
```
protected Enumeration<MedicationDispense.MedicationDispenseStatus> status
```
    A code specifying the state of the set of dispense events.
  - medication
```
protected Type medication
```
    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.
  - patient
```
protected Reference patient
```
    A link to a resource representing the person to whom the medication will be given.
  - patientTarget
```
protected Patient patientTarget
```
    The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)
  - dispenser
```
protected Reference dispenser
```
    The individual responsible for dispensing the medication.
  - dispenserTarget
```
protected Practitioner dispenserTarget
```
    The actual object that is the target of the reference (The individual responsible for dispensing the medication.)
  - authorizingPrescription
```
protected List<Reference> authorizingPrescription
```
    Indicates the medication order that is being dispensed against.
  - authorizingPrescriptionTarget
```
protected List<MedicationOrder> authorizingPrescriptionTarget
```
    The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)
  - type
```
protected CodeableConcept type
```
    Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
  - quantity
```
protected SimpleQuantity quantity
```
    The amount of medication that has been dispensed. Includes unit of measure.
  - daysSupply
```
protected SimpleQuantity daysSupply
```
    The amount of medication expressed as a timing amount.
  - whenPrepared
```
protected DateTimeType whenPrepared
```
    The time when the dispensed product was packaged and reviewed.
  - whenHandedOver
```
protected DateTimeType whenHandedOver
```
    The time the dispensed product was provided to the patient or their representative.
  - destination
```
protected Reference destination
```
    Identification of the facility/location where the medication was shipped to, as part of the dispense event.
  - destinationTarget
```
protected Location destinationTarget
```
    The actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
  - receiver
```
protected List<Reference> receiver
```
    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.
  - receiverTarget
```
protected List<Resource> receiverTarget
```
    The actual objects that are the target of the reference (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.)
  - note
```
protected List<Annotation> note
```
    Extra information about the dispense that could not be conveyed in the other attributes.
  - dosageInstruction
```
protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent> dosageInstruction
```
    Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.
  - substitution
```
protected MedicationDispense.MedicationDispenseSubstitutionComponent substitution
```
    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.
  - SP_MEDICATION
```
public static final String SP_MEDICATION
```
    Search parameter: medication
    Description: Return dispenses of this medicine resource
    Type: reference
    Path: MedicationDispense.medicationReference
    
    See Also:
    
    Constant Field Values
  - MEDICATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
```
    Fluent Client search parameter constant for medication
    Description: Return dispenses of this medicine resource
    Type: reference
    Path: MedicationDispense.medicationReference
  - INCLUDE_MEDICATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:medication".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:patient".
  - SP_RECEIVER
```
public static final String SP_RECEIVER
```
    Search parameter: receiver
    Description: Who collected the medication
    Type: reference
    Path: MedicationDispense.receiver
    
    See Also:
    
    Constant Field Values
  - RECEIVER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
```
    Fluent Client search parameter constant for receiver
    Description: Who collected the medication
    Type: reference
    Path: MedicationDispense.receiver
  - INCLUDE_RECEIVER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:receiver".
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: Status of the dispense
    Type: token
    Path: MedicationDispense.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: Status of the dispense
    Type: token
    Path: MedicationDispense.status
  - SP_PRESCRIPTION
```
public static final String SP_PRESCRIPTION
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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_PRESCRIPTION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIPTION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:prescription".
  - SP_RESPONSIBLEPARTY
```
public static final String SP_RESPONSIBLEPARTY
```
    Search parameter: 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 ca.uhn.fhir.rest.gclient.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_RESPONSIBLEPARTY
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSIBLEPARTY
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:responsibleparty".
  - SP_DISPENSER
```
public static final String SP_DISPENSER
```
    Search parameter: dispenser
    Description: Return all dispenses performed by a specific individual
    Type: reference
    Path: MedicationDispense.dispenser
    
    See Also:
    
    Constant Field Values
  - DISPENSER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DISPENSER
```
    Fluent Client search parameter constant for dispenser
    Description: Return all dispenses performed by a specific individual
    Type: reference
    Path: MedicationDispense.dispenser
  - INCLUDE_DISPENSER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_DISPENSER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:dispenser".
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter: code
    Description: Return dispenses of this medicine code
    Type: token
    Path: MedicationDispense.medicationCodeableConcept
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: Return dispenses of this medicine code
    Type: token
    Path: MedicationDispense.medicationCodeableConcept
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: Return all dispenses of a specific type
    Type: token
    Path: MedicationDispense.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: Return all dispenses of a specific type
    Type: token
    Path: MedicationDispense.type
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Return dispenses with this external identifier
    Type: token
    Path: MedicationDispense.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Return dispenses with this external identifier
    Type: token
    Path: MedicationDispense.identifier
  - SP_WHENPREPARED
```
public static final String SP_WHENPREPARED
```
    Search parameter: whenprepared
    Description: Date when medication prepared
    Type: date
    Path: MedicationDispense.whenPrepared
    
    See Also:
    
    Constant Field Values
  - WHENPREPARED
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam WHENPREPARED
```
    Fluent Client search parameter constant for whenprepared
    Description: Date when medication prepared
    Type: date
    Path: MedicationDispense.whenPrepared
  - SP_WHENHANDEDOVER
```
public static final String SP_WHENHANDEDOVER
```
    Search parameter: whenhandedover
    Description: Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)
    Type: date
    Path: MedicationDispense.whenHandedOver
    
    See Also:
    
    Constant Field Values
  - WHENHANDEDOVER
```
public static final ca.uhn.fhir.rest.gclient.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.whenHandedOver
  - SP_DESTINATION
```
public static final String SP_DESTINATION
```
    Search parameter: destination
    Description: Return dispenses that should be sent to a specific destination
    Type: reference
    Path: MedicationDispense.destination
    
    See Also:
    
    Constant Field Values
  - DESTINATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DESTINATION
```
    Fluent Client search parameter constant for destination
    Description: Return dispenses that should be sent to a specific destination
    Type: reference
    Path: MedicationDispense.destination
  - INCLUDE_DESTINATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_DESTINATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:destination".
- Constructor Detail
  - MedicationDispense
```
public MedicationDispense()
```
    Constructor
  - MedicationDispense
```
public MedicationDispense(Type medication)
```
    Constructor
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public MedicationDispense setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
  - getStatusElement
```
public Enumeration<MedicationDispense.MedicationDispenseStatus> getStatusElement()
```
    Returns:
    
    status (A code specifying the state of the set of dispense events.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public MedicationDispense setStatusElement(Enumeration<MedicationDispense.MedicationDispenseStatus> value)
```
    Parameters:
    
    value - status (A code specifying the state of the set of dispense events.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public MedicationDispense.MedicationDispenseStatus getStatus()
```
    Returns:
    
    A code specifying the state of the set of dispense events.
  - setStatus
```
public MedicationDispense setStatus(MedicationDispense.MedicationDispenseStatus value)
```
    Parameters:
    
    value - A code specifying the state of the set of dispense events.
  - getMedication
```
public Type getMedication()
```
    Returns:
    
    medication (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.)
  - getMedicationCodeableConcept
```
public CodeableConcept getMedicationCodeableConcept()
                                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    medication (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMedicationCodeableConcept
```
public boolean hasMedicationCodeableConcept()
```
  - getMedicationReference
```
public Reference getMedicationReference()
                                 throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    medication (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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMedicationReference
```
public boolean hasMedicationReference()
```
  - hasMedication
```
public boolean hasMedication()
```
  - setMedication
```
public MedicationDispense setMedication(Type value)
```
    Parameters:
    
    value - medication (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.)
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (A link to a resource representing the person to whom the medication will be given.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public MedicationDispense setPatient(Reference value)
```
    Parameters:
    
    value - patient (A link to a resource representing the person to whom the medication will be given.)
  - getPatientTarget
```
public Patient getPatientTarget()
```
    Returns:
    
    patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
  - setPatientTarget
```
public MedicationDispense setPatientTarget(Patient value)
```
    Parameters:
    
    value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
  - getDispenser
```
public Reference getDispenser()
```
    Returns:
    
    dispenser (The individual responsible for dispensing the medication.)
  - hasDispenser
```
public boolean hasDispenser()
```
  - setDispenser
```
public MedicationDispense setDispenser(Reference value)
```
    Parameters:
    
    value - dispenser (The individual responsible for dispensing the medication.)
  - getDispenserTarget
```
public Practitioner getDispenserTarget()
```
    Returns:
    
    dispenser The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)
  - setDispenserTarget
```
public MedicationDispense setDispenserTarget(Practitioner value)
```
    Parameters:
    
    value - dispenser The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)
  - getAuthorizingPrescription
```
public List<Reference> getAuthorizingPrescription()
```
    Returns:
    
    authorizingPrescription (Indicates the medication order that is being dispensed against.)
  - hasAuthorizingPrescription
```
public boolean hasAuthorizingPrescription()
```
  - addAuthorizingPrescription
```
public Reference addAuthorizingPrescription()
```
    Returns:
    
    authorizingPrescription (Indicates the medication order that is being dispensed against.)
  - addAuthorizingPrescription
```
public MedicationDispense addAuthorizingPrescription(Reference t)
```
  - getAuthorizingPrescriptionTarget
```
public List<MedicationOrder> getAuthorizingPrescriptionTarget()
```
    Returns:
    
    authorizingPrescription (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)
  - addAuthorizingPrescriptionTarget
```
public MedicationOrder addAuthorizingPrescriptionTarget()
```
    Returns:
    
    authorizingPrescription (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public MedicationDispense setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
  - getQuantity
```
public SimpleQuantity getQuantity()
```
    Returns:
    
    quantity (The amount of medication that has been dispensed. Includes unit of measure.)
  - hasQuantity
```
public boolean hasQuantity()
```
  - setQuantity
```
public MedicationDispense setQuantity(SimpleQuantity value)
```
    Parameters:
    
    value - quantity (The amount of medication that has been dispensed. Includes unit of measure.)
  - getDaysSupply
```
public SimpleQuantity getDaysSupply()
```
    Returns:
    
    daysSupply (The amount of medication expressed as a timing amount.)
  - hasDaysSupply
```
public boolean hasDaysSupply()
```
  - setDaysSupply
```
public MedicationDispense setDaysSupply(SimpleQuantity value)
```
    Parameters:
    
    value - daysSupply (The amount of medication expressed as a timing amount.)
  - getWhenPreparedElement
```
public DateTimeType getWhenPreparedElement()
```
    Returns:
    
    whenPrepared (The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getWhenPrepared" gives direct access to the value
  - hasWhenPreparedElement
```
public boolean hasWhenPreparedElement()
```
  - hasWhenPrepared
```
public boolean hasWhenPrepared()
```
  - setWhenPreparedElement
```
public MedicationDispense setWhenPreparedElement(DateTimeType value)
```
    Parameters:
    
    value - whenPrepared (The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getWhenPrepared" gives direct access to the value
  - getWhenPrepared
```
public Date getWhenPrepared()
```
    Returns:
    
    The time when the dispensed product was packaged and reviewed.
  - setWhenPrepared
```
public MedicationDispense setWhenPrepared(Date value)
```
    Parameters:
    
    value - The time when the dispensed product was packaged and reviewed.
  - getWhenHandedOverElement
```
public DateTimeType getWhenHandedOverElement()
```
    Returns:
    
    whenHandedOver (The time the dispensed product was provided to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
  - hasWhenHandedOverElement
```
public boolean hasWhenHandedOverElement()
```
  - hasWhenHandedOver
```
public boolean hasWhenHandedOver()
```
  - setWhenHandedOverElement
```
public MedicationDispense setWhenHandedOverElement(DateTimeType value)
```
    Parameters:
    
    value - whenHandedOver (The time the dispensed product was provided to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
  - getWhenHandedOver
```
public Date getWhenHandedOver()
```
    Returns:
    
    The time the dispensed product was provided to the patient or their representative.
  - setWhenHandedOver
```
public MedicationDispense setWhenHandedOver(Date value)
```
    Parameters:
    
    value - The time the dispensed product was provided to the patient or their representative.
  - getDestination
```
public Reference getDestination()
```
    Returns:
    
    destination (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
  - hasDestination
```
public boolean hasDestination()
```
  - setDestination
```
public MedicationDispense setDestination(Reference value)
```
    Parameters:
    
    value - destination (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
  - getDestinationTarget
```
public Location getDestinationTarget()
```
    Returns:
    
    destination The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
  - setDestinationTarget
```
public MedicationDispense setDestinationTarget(Location value)
```
    Parameters:
    
    value - destination The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
  - getReceiver
```
public List<Reference> getReceiver()
```
    Returns:
    
    receiver (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.)
  - hasReceiver
```
public boolean hasReceiver()
```
  - addReceiver
```
public Reference addReceiver()
```
    Returns:
    
    receiver (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.)
  - addReceiver
```
public MedicationDispense addReceiver(Reference t)
```
  - getReceiverTarget
```
public List<Resource> getReceiverTarget()
```
    Returns:
    
    receiver (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.)
  - getNote
```
public List<Annotation> getNote()
```
    Returns:
    
    note (Extra information about the dispense that could not be conveyed in the other attributes.)
  - hasNote
```
public boolean hasNote()
```
  - addNote
```
public Annotation addNote()
```
    Returns:
    
    note (Extra information about the dispense that could not be conveyed in the other attributes.)
  - addNote
```
public MedicationDispense addNote(Annotation t)
```
  - getDosageInstruction
```
public List<MedicationDispense.MedicationDispenseDosageInstructionComponent> getDosageInstruction()
```
    Returns:
    
    dosageInstruction (Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.)
  - hasDosageInstruction
```
public boolean hasDosageInstruction()
```
  - addDosageInstruction
```
public MedicationDispense.MedicationDispenseDosageInstructionComponent addDosageInstruction()
```
    Returns:
    
    dosageInstruction (Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.)
  - addDosageInstruction
```
public MedicationDispense addDosageInstruction(MedicationDispense.MedicationDispenseDosageInstructionComponent t)
```
  - getSubstitution
```
public MedicationDispense.MedicationDispenseSubstitutionComponent getSubstitution()
```
    Returns:
    
    substitution (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.)
  - hasSubstitution
```
public boolean hasSubstitution()
```
  - setSubstitution
```
public MedicationDispense setSubstitution(MedicationDispense.MedicationDispenseSubstitutionComponent value)
```
    Parameters:
    
    value - substitution (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.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public MedicationDispense copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected MedicationDispense typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class MedicationDispense

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

status

medication

patient

patientTarget

dispenser

dispenserTarget

authorizingPrescription

authorizingPrescriptionTarget

type

quantity

daysSupply

whenPrepared

whenHandedOver

destination

destinationTarget

receiver

receiverTarget

note

dosageInstruction

substitution

SP_MEDICATION

MEDICATION

INCLUDE_MEDICATION

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_RECEIVER

RECEIVER

INCLUDE_RECEIVER

SP_STATUS

STATUS

SP_PRESCRIPTION

PRESCRIPTION

INCLUDE_PRESCRIPTION

SP_RESPONSIBLEPARTY

RESPONSIBLEPARTY

INCLUDE_RESPONSIBLEPARTY

SP_DISPENSER

DISPENSER

INCLUDE_DISPENSER

SP_CODE

CODE

SP_TYPE

TYPE

SP_IDENTIFIER

IDENTIFIER

SP_WHENPREPARED

WHENPREPARED

SP_WHENHANDEDOVER

WHENHANDEDOVER

SP_DESTINATION

DESTINATION

INCLUDE_DESTINATION

Constructor Detail

MedicationDispense

MedicationDispense

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getStatusElement