Class 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:
  • Field Details

    • identifier

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

      protected List<Reference> partOf
      The procedure that trigger the dispense.
    • partOfTarget

      The actual objects that are the target of the reference (The procedure that trigger the dispense.)
    • status

      A code specifying the state of the set of dispense events.
    • statusReason

      protected Type statusReason
      Indicates the reason why a dispense was not performed.
    • category

      Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
    • 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.
    • subject

      protected Reference subject
      A link to a resource representing the person or the group to whom the medication will be given.
    • subjectTarget

      The actual object that is the target of the reference (A link to a resource representing the person or the group to whom the medication will be given.)
    • context

      protected Reference context
      The encounter or episode of care that establishes the context for this event.
    • contextTarget

      The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)
    • supportingInformation

      Additional information that supports the medication being dispensed.
    • supportingInformationTarget

      The actual objects that are the target of the reference (Additional information that supports the medication being dispensed.)
    • performer

      Indicates who or what performed the event.
    • location

      protected Reference location
      The principal physical location where the dispense was performed.
    • locationTarget

      The actual object that is the target of the reference (The principal physical location where the dispense was performed.)
    • authorizingPrescription

      Indicates the medication order that is being dispensed against.
    • 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 Quantity quantity
      The amount of medication that has been dispensed. Includes unit of measure.
    • daysSupply

      protected Quantity daysSupply
      The amount of medication expressed as a timing amount.
    • whenPrepared

      The time when the dispensed product was packaged and reviewed.
    • whenHandedOver

      The time the dispensed product was provided to the patient or their representative.
    • destination

      Identification of the facility/location where the medication was shipped to, as part of the dispense event.
    • 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

      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

      Indicates how the medication is to be used by the patient.
    • 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. If nothing is specified, substitution was not done.
    • detectedIssue

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

      The actual objects that are the target of the reference (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.)
    • eventHistory

      A summary of the events of interest that have occurred, such as when the dispense was verified.
    • eventHistoryTarget

      The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the dispense was verified.)
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

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

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: Returns dispenses performed by a specific individual
      Type: reference
      Path: MedicationDispense.performer.actor

      See Also:
    • PERFORMER

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

      Description: Returns dispenses performed by a specific individual
      Type: reference
      Path: MedicationDispense.performer.actor

    • INCLUDE_PERFORMER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:performer".
    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Returns dispenses of this medicine code
      Type: token
      Path: MedicationDispense.medicationCodeableConcept

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Returns dispenses of this medicine code
      Type: token
      Path: MedicationDispense.medicationCodeableConcept

    • SP_RECEIVER

      public static final String SP_RECEIVER
      Search parameter: receiver

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

      See Also:
    • RECEIVER

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

      Description: The identity of a receiver to list dispenses for
      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_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

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

      See Also:
    • SUBJECT

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

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

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:subject".
    • SP_DESTINATION

      public static final String SP_DESTINATION
      Search parameter: destination

      Description: Returns dispenses that should be sent to a specific destination
      Type: reference
      Path: MedicationDispense.destination

      See Also:
    • DESTINATION

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

      Description: Returns 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".
    • SP_MEDICATION

      public static final String SP_MEDICATION
      Search parameter: medication

      Description: Returns dispenses of this medicine resource
      Type: reference
      Path: MedicationDispense.medicationReference

      See Also:
    • MEDICATION

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

      Description: Returns 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_RESPONSIBLEPARTY

      public static final String SP_RESPONSIBLEPARTY
      Search parameter: responsibleparty

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

      See Also:
    • RESPONSIBLEPARTY

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

      Description: Returns 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_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Returns dispenses of a specific type
      Type: token
      Path: MedicationDispense.type

      See Also:
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: Returns dispenses of a specific type
      Type: token
      Path: MedicationDispense.type

    • SP_WHENHANDEDOVER

      public static final String SP_WHENHANDEDOVER
      Search parameter: whenhandedover

      Description: Returns dispenses handed over on this date
      Type: date
      Path: MedicationDispense.whenHandedOver

      See Also:
    • WHENHANDEDOVER

      public static final ca.uhn.fhir.rest.gclient.DateClientParam WHENHANDEDOVER
      Fluent Client search parameter constant for whenhandedover

      Description: Returns dispenses handed over on this date
      Type: date
      Path: MedicationDispense.whenHandedOver

    • SP_WHENPREPARED

      public static final String SP_WHENPREPARED
      Search parameter: whenprepared

      Description: Returns dispenses prepared on this date
      Type: date
      Path: MedicationDispense.whenPrepared

      See Also:
    • WHENPREPARED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam WHENPREPARED
      Fluent Client search parameter constant for whenprepared

      Description: Returns dispenses prepared on this date
      Type: date
      Path: MedicationDispense.whenPrepared

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

      public static final String SP_PATIENT
      Search parameter: patient

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

      See Also:
    • 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.subject

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

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Returns dispenses with a specific context (episode or episode of care)
      Type: reference
      Path: MedicationDispense.context

      See Also:
    • CONTEXT

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

      Description: Returns dispenses with a specific context (episode or episode of care)
      Type: reference
      Path: MedicationDispense.context

    • INCLUDE_CONTEXT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:context".
    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Returns dispenses with a specified dispense status
      Type: token
      Path: MedicationDispense.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: Returns dispenses with a specified dispense status
      Type: token
      Path: MedicationDispense.status

  • Constructor Details

  • Method Details