Class MedicationOrder

  • 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 MedicationOrder
    extends DomainResource
    An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.
      • medication

        protected Type medication
        Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an 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.)
      • encounter

        protected Reference encounter
        A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)
      • prescriber

        protected Reference prescriber
        The healthcare professional responsible for authorizing the prescription.
      • prescriberTarget

        protected Practitioner prescriberTarget
        The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)
      • reasonReferenceTarget

        protected List<Condition> reasonReferenceTarget
        The actual objects that are the target of the reference (Condition that supports why the prescription is being written.)
      • dateEnded

        protected DateTimeType dateEnded
        The date (and perhaps time) when the prescription was stopped.
      • note

        protected List<Annotation> note
        Extra information about the prescription that could not be conveyed by the other attributes.
      • dispenseRequest

        protected MedicationOrder.MedicationOrderDispenseRequestComponent dispenseRequest
        Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
      • substitution

        protected MedicationOrder.MedicationOrderSubstitutionComponent substitution
        Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
      • priorPrescription

        protected Reference priorPrescription
        A link to a resource representing an earlier order or prescription that this order supersedes.
      • priorPrescriptionTarget

        protected MedicationOrder priorPrescriptionTarget
        The actual object that is the target of the reference (A link to a resource representing an earlier order or prescription that this order supersedes.)
      • SP_MEDICATION

        public static final String SP_MEDICATION
        Search parameter: medication

        Description: Return administrations of this medication reference
        Type: reference
        Path: MedicationOrder.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 administrations of this medication reference
        Type: reference
        Path: MedicationOrder.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 "MedicationOrder:medication".
      • SP_DATEWRITTEN

        public static final String SP_DATEWRITTEN
        Search parameter: datewritten

        Description: Return prescriptions written on this date
        Type: date
        Path: MedicationOrder.dateWritten

        See Also:
        Constant Field Values
      • DATEWRITTEN

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

        Description: Return prescriptions written on this date
        Type: date
        Path: MedicationOrder.dateWritten

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The identity of a patient to list orders for
        Type: reference
        Path: MedicationOrder.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 orders for
        Type: reference
        Path: MedicationOrder.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 "MedicationOrder:patient".
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: Status of the prescription
        Type: token
        Path: MedicationOrder.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 prescription
        Type: token
        Path: MedicationOrder.status

      • SP_PRESCRIBER

        public static final String SP_PRESCRIBER
        Search parameter: prescriber

        Description: Who ordered the medication(s)
        Type: reference
        Path: MedicationOrder.prescriber

        See Also:
        Constant Field Values
      • PRESCRIBER

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

        Description: Who ordered the medication(s)
        Type: reference
        Path: MedicationOrder.prescriber

      • INCLUDE_PRESCRIBER

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

        public static final String SP_CODE
        Search parameter: code

        Description: Return administrations of this medication code
        Type: token
        Path: MedicationOrder.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 administrations of this medication code
        Type: token
        Path: MedicationOrder.medicationCodeableConcept

      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: Return prescriptions with this encounter identifier
        Type: reference
        Path: MedicationOrder.encounter

        See Also:
        Constant Field Values
      • ENCOUNTER

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

        Description: Return prescriptions with this encounter identifier
        Type: reference
        Path: MedicationOrder.encounter

      • INCLUDE_ENCOUNTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationOrder:encounter".
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Return prescriptions with this external identifier
        Type: token
        Path: MedicationOrder.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 prescriptions with this external identifier
        Type: token
        Path: MedicationOrder.identifier