Package com.ibm.fhir.model.resource

Class MedicationDispense

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
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.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getPartOf

        public List<Reference> getPartOf()
        The procedure that trigger the dispense.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getStatusReason

        public Element getStatusReason()
        Indicates the reason why a dispense was not performed.
        Returns:
        An immutable object of type CodeableConcept or Reference that may be null.

      • getCategory

        public CodeableConcept getCategory()
        Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getMedication

        public Element getMedication()
        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.
        Returns:
        An immutable object of type CodeableConcept or Reference that is non-null.

      • getSubject

        public Reference getSubject()
        A link to a resource representing the person or the group to whom the medication will be given.
        Returns:
        An immutable object of type Reference that may be null.

      • getContext

        public Reference getContext()
        The encounter or episode of care that establishes the context for this event.
        Returns:
        An immutable object of type Reference that may be null.

      • getSupportingInformation

        public List<Reference> getSupportingInformation()
        Additional information that supports the medication being dispensed.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getLocation

        public Reference getLocation()
        The principal physical location where the dispense was performed.
        Returns:
        An immutable object of type Reference that may be null.

      • getAuthorizingPrescription

        public List<Reference> getAuthorizingPrescription()
        Indicates the medication order that is being dispensed against.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getType

        public CodeableConcept getType()
        Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getQuantity

        public SimpleQuantity getQuantity()
        The amount of medication that has been dispensed. Includes unit of measure.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getDaysSupply

        public SimpleQuantity getDaysSupply()
        The amount of medication expressed as a timing amount.
        Returns:
        An immutable object of type SimpleQuantity that may be null.

      • getWhenPrepared

        public DateTime getWhenPrepared()
        The time when the dispensed product was packaged and reviewed.
        Returns:
        An immutable object of type DateTime that may be null.

      • getWhenHandedOver

        public DateTime getWhenHandedOver()
        The time the dispensed product was provided to the patient or their representative.
        Returns:
        An immutable object of type DateTime that may be null.

      • getDestination

        public Reference getDestination()
        Identification of the facility/location where the medication was shipped to, as part of the dispense event.
        Returns:
        An immutable object of type Reference that may be null.

      • getReceiver

        public List<Reference> getReceiver()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getNote

        public List<Annotation> getNote()
        Extra information about the dispense that could not be conveyed in the other attributes.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getDosageInstruction

        public List<Dosage> getDosageInstruction()
        Indicates how the medication is to be used by the patient.
        Returns:
        An unmodifiable list containing immutable objects of type Dosage that may be empty.

      • getSubstitution

        public MedicationDispense.Substitution getSubstitution()
        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. If nothing is specified, substitution was not done.
        Returns:
        An immutable object of type MedicationDispense.Substitution that may be null.

      • getDetectedIssue

        public List<Reference> getDetectedIssue()
        Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getEventHistory

        public List<Reference> getEventHistory()
        A summary of the events of interest that have occurred, such as when the dispense was verified.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object