Package ca.uhn.fhir.model.dstu2.resource

Class MedicationDispense

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
    public class MedicationDispense
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR MedicationDispense Resource (clinical.medication)

    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

    See Also:
    Serialized Form

    • Field Detail

      • SP_DESTINATION

        public static final String SP_DESTINATION
        Search parameter constant for 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

      • SP_DISPENSER

        public static final String SP_DISPENSER
        Search parameter constant for 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

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for 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_MEDICATION

        public static final String SP_MEDICATION
        Search parameter constant for 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

      • SP_CODE

        public static final String SP_CODE
        Search parameter constant for 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_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 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

      • 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 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

      • 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 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

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter constant for 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_TYPE

        public static final String SP_TYPE
        Search parameter constant for 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_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.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_WHENPREPARED

        public static final String SP_WHENPREPARED
        Search parameter constant for 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

      • RECEIVER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
        Fluent Client search parameter constant for receiver

        Description:
        Type: reference
        Path: MedicationDispense.receiver

      • 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".

      • 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".

      • 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".

      • 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".

      • 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".

      • 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".

      • 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".

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase

      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

      • getIdentifier

        public IdentifierDt getIdentifier()
        Gets the value(s) for identifier (id). 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 (id)

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

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<MedicationDispenseStatusEnum> getStatusElement()
        Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

        Definition: A code specifying the state of the set of dispense events.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

        Definition: A code specifying the state of the set of dispense events.

      • getPatient

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (who.focus). 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.

      • getDispenser

        public ResourceReferenceDt getDispenser()
        Gets the value(s) for dispenser (who.actor). creating it if it does not exist. Will not return null.

        Definition: The individual responsible for dispensing the medication

      • getAuthorizingPrescription

        public List<ResourceReferenceDt> getAuthorizingPrescription()
        Gets the value(s) for authorizingPrescription (). creating it if it does not exist. Will not return null.

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

      • getType

        public CodeableConceptDt getType()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

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

      • setType

        public MedicationDispense setType​(CodeableConceptDt theValue)
        Sets the value(s) for type ()

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

      • getQuantity

        public SimpleQuantityDt getQuantity()
        Gets the value(s) for quantity (). creating it if it does not exist. Will not return null.

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

      • getDaysSupply

        public SimpleQuantityDt getDaysSupply()
        Gets the value(s) for daysSupply (). creating it if it does not exist. Will not return null.

        Definition: The amount of medication expressed as a timing amount.

      • getMedication

        public ca.uhn.fhir.model.api.IDatatype getMedication()
        Gets the value(s) for medication[x] (). 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 setMedication​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for medication[x] ()

        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.

      • getWhenPreparedElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getWhenPreparedElement()
        Gets the value(s) for whenPrepared (). creating it if it does not exist. Will not return null.

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

      • getWhenPrepared

        public Date getWhenPrepared()
        Gets the value(s) for whenPrepared (). creating it if it does not exist. This method may return null.

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

      • setWhenPrepared

        public MedicationDispense setWhenPrepared​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for whenPrepared ()

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

      • setWhenPrepared

        public MedicationDispense setWhenPrepared​(Date theDate,
                                          ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for whenPrepared ()

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

      • getWhenHandedOverElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getWhenHandedOverElement()
        Gets the value(s) for whenHandedOver (). 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.

      • getWhenHandedOver

        public Date getWhenHandedOver()
        Gets the value(s) for whenHandedOver (). creating it if it does not exist. This method may return null.

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

      • setWhenHandedOver

        public MedicationDispense setWhenHandedOver​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for whenHandedOver ()

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

      • setWhenHandedOver

        public MedicationDispense setWhenHandedOver​(Date theDate,
                                            ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for whenHandedOver ()

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

      • getDestination

        public ResourceReferenceDt getDestination()
        Gets the value(s) for destination (). 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.

      • getReceiver

        public List<ResourceReferenceDt> getReceiver()
        Gets the value(s) for receiver (). 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 caregiver, but some cases exist where it can be a healthcare professional

      • setReceiver

        public MedicationDispense setReceiver​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for receiver ()

        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

      • addReceiver

        public ResourceReferenceDt addReceiver()
        Adds and returns a new value for receiver ()

        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

      • getNoteElement

        public ca.uhn.fhir.model.primitive.StringDt getNoteElement()
        Gets the value(s) for note (). creating it if it does not exist. Will not return null.

        Definition: Extra information about the dispense that could not be conveyed in the other attributes.

      • getNote

        public String getNote()
        Gets the value(s) for note (). creating it if it does not exist. This method may return null.

        Definition: Extra information about the dispense that could not be conveyed in the other attributes.

      • setNote

        public MedicationDispense setNote​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for note ()

        Definition: Extra information about the dispense that could not be conveyed in the other attributes.

      • setNote

        public MedicationDispense setNote​(String theString)
        Sets the value for note ()

        Definition: Extra information about the dispense that could not be conveyed in the other attributes.

      • getSubstitution

        public MedicationDispense.Substitution getSubstitution()
        Gets the value(s) for substitution (). 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 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.

      • setSubstitution

        public MedicationDispense setSubstitution​(MedicationDispense.Substitution theValue)
        Sets the value(s) for substitution ()

        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.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource

      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource