Class MedicationRequest

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

      • identifier

        protected List<Identifier> identifier
        This records identifiers associated with this medication request 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. 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 must be tracked through an entire system.
      • definitionTarget

        protected List<Resource> definitionTarget
        The actual objects that are the target of the reference (Protocol or definition followed by this request.)
      • basedOn

        protected List<Reference> basedOn
        A plan or request that is fulfilled in whole or in part by this medication request.
      • basedOnTarget

        protected List<Resource> basedOnTarget
        The actual objects that are the target of the reference (A plan or request that is fulfilled in whole or in part by this medication request.)
      • groupIdentifier

        protected Identifier groupIdentifier
        A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
      • category

        protected CodeableConcept category
        Indicates the type of medication order and where the medication is expected to be consumed or administered.
      • medication

        protected Type medication
        Identifies the medication being requested. 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.
      • subject

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

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

        protected Reference context
        A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
      • contextTarget

        protected Resource contextTarget
        The actual object that is the target of the reference (A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
      • supportingInformation

        protected List<Reference> supportingInformation
        Include additional information (for example, patient height and weight) that supports the ordering of the medication.
      • supportingInformationTarget

        protected List<Resource> supportingInformationTarget
        The actual objects that are the target of the reference (Include additional information (for example, patient height and weight) that supports the ordering of the medication.)
      • authoredOn

        protected DateTimeType authoredOn
        The date (and perhaps time) when the prescription was initially written or authored on.
      • recorder

        protected Reference recorder
        The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
      • recorderTarget

        protected Practitioner recorderTarget
        The actual object that is the target of the reference (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
      • reasonReferenceTarget

        protected List<Resource> reasonReferenceTarget
        The actual objects that are the target of the reference (Condition or observation that supports why the medication was ordered.)
      • note

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

        protected MedicationRequest.MedicationRequestDispenseRequestComponent dispenseRequest
        Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). 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 MedicationRequest.MedicationRequestSubstitutionComponent 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. 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 related order or prescription.
      • priorPrescriptionTarget

        protected MedicationRequest priorPrescriptionTarget
        The actual object that is the target of the reference (A link to a resource representing an earlier order related order or prescription.)
      • detectedIssue

        protected List<Reference> 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

        protected List<DetectedIssue> 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

        protected List<Reference> eventHistory
        Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
      • eventHistoryTarget

        protected List<Provenance> eventHistoryTarget
        The actual objects that are the target of the reference (Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.)
      • SP_REQUESTER

        public static final String SP_REQUESTER
        Search parameter: requester

        Description: Returns prescriptions prescribed by this prescriber
        Type: reference
        Path: MedicationRequest.requester.agent

        See Also:
        Constant Field Values
      • REQUESTER

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

        Description: Returns prescriptions prescribed by this prescriber
        Type: reference
        Path: MedicationRequest.requester.agent

      • INCLUDE_REQUESTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:requester".
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Returns medication request to be administered on a specific date
        Type: date
        Path: MedicationRequest.dosageInstruction.timing.event

        See Also:
        Constant Field Values
      • DATE

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

        Description: Returns medication request to be administered on a specific date
        Type: date
        Path: MedicationRequest.dosageInstruction.timing.event

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

      • SP_INTENDED_DISPENSER

        public static final String SP_INTENDED_DISPENSER
        Search parameter: intended-dispenser

        Description: Returns prescriptions intended to be dispensed by this Organization
        Type: reference
        Path: MedicationRequest.dispenseRequest.performer

        See Also:
        Constant Field Values
      • INTENDED_DISPENSER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INTENDED_DISPENSER
        Fluent Client search parameter constant for intended-dispenser

        Description: Returns prescriptions intended to be dispensed by this Organization
        Type: reference
        Path: MedicationRequest.dispenseRequest.performer

      • INCLUDE_INTENDED_DISPENSER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_INTENDED_DISPENSER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:intended-dispenser".
      • SP_AUTHOREDON

        public static final String SP_AUTHOREDON
        Search parameter: authoredon

        Description: Return prescriptions written on this date
        Type: date
        Path: MedicationRequest.authoredOn

        See Also:
        Constant Field Values
      • AUTHOREDON

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

        Description: Return prescriptions written on this date
        Type: date
        Path: MedicationRequest.authoredOn

      • SP_CODE

        public static final String SP_CODE
        Search parameter: code

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

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: The identity of a patient to list orders for
        Type: reference
        Path: MedicationRequest.subject

        See Also:
        Constant Field Values
      • SUBJECT

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

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

        public static final String SP_MEDICATION
        Search parameter: medication

        Description: Return prescriptions of this medication reference
        Type: reference
        Path: MedicationRequest.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 prescriptions of this medication reference
        Type: reference
        Path: MedicationRequest.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 "MedicationRequest:medication".
      • SP_PRIORITY

        public static final String SP_PRIORITY
        Search parameter: priority

        Description: Returns prescriptions with different priorities
        Type: token
        Path: MedicationRequest.priority

        See Also:
        Constant Field Values
      • PRIORITY

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

        Description: Returns prescriptions with different priorities
        Type: token
        Path: MedicationRequest.priority

      • SP_INTENT

        public static final String SP_INTENT
        Search parameter: intent

        Description: Returns prescriptions with different intents
        Type: token
        Path: MedicationRequest.intent

        See Also:
        Constant Field Values
      • INTENT

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

        Description: Returns prescriptions with different intents
        Type: token
        Path: MedicationRequest.intent

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Returns prescriptions for a specific patient
        Type: reference
        Path: MedicationRequest.subject

        See Also:
        Constant Field Values
      • PATIENT

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

        Description: Returns prescriptions for a specific patient
        Type: reference
        Path: MedicationRequest.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 "MedicationRequest:patient".
      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: Return prescriptions with this encounter or episode of care identifier
        Type: reference
        Path: MedicationRequest.context

        See Also:
        Constant Field Values
      • CONTEXT

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

        Description: Return prescriptions with this encounter or episode of care identifier
        Type: reference
        Path: MedicationRequest.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 "MedicationRequest:context".
      • SP_CATEGORY

        public static final String SP_CATEGORY
        Search parameter: category

        Description: Returns prescriptions with different categories
        Type: token
        Path: MedicationRequest.category

        See Also:
        Constant Field Values
      • CATEGORY

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

        Description: Returns prescriptions with different categories
        Type: token
        Path: MedicationRequest.category

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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