MedicationRequest _search

post/MedicationRequest/_search
Page View

This resource contains a list of a patient’s current prescribed medications, as documented by one organization. What this doesn’t contain: any details about how much a patient has taken of what they were prescribed.

You can review or retrieve a list of current medications for a patient. 

_search

Query for a list of current medications for a patient.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.
  • patient

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/MedicationRequest/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'intent=string' \
8
--data-urlencode 'status=string' \
9
--data-urlencode 'recorder=string' \
10
--data-urlencode 'authoredon=string' \
11
--data-urlencode 'requester=string' \
12
--data-urlencode 'encounter=string' \
13
--data-urlencode 'encounter.identifier=string'

Request Body Schema

  • patient
    Array of string

    Returns prescriptions for a specific patient

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • intent
    Array of string

    Returns prescriptions with different intents

  • status
    Array of string

    Status of the prescription

  • recorder
    Array of string

    Person who entered the request

  • authoredon
    Array of string

    When request was initially authored

  • requester
    Array of string

    Person who prescribed this medication

  • encounter
    Array of string

    Encounter during which the medication was prescribed

  • encounter.identifier
    Array of string

    Identifier(s) by which this encounter is known

Response fields and example

Example payload generated from schema
1
{
2
"resourceType": "Bundle",
3
"type": "searchset",
4
"total": 1,
5
"entry": [
6
{
7
"resource": {
8
"resourceType": "MedicationRequest",
9
"id": "RedoxClinicalSummaryMedicationRequestCodeExample",
10
"identifier": [
11
{
12
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
"value": "865492246"
14
}
15
],
16
"subject": {
17
"reference": "Patient/RedoxPatientExampleTimothy"
18
},
19
"intent": "order",
20
"encounter": {
21
"reference": "Encounter/RedoxEncompassingEncounterExample"
22
},
23
"medicationCodeableConcept": {
24
"coding": [
25
{
26
"code": "104894",
27
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
28
"display": "Ondansetron 4 Mg Po Tbdp"
29
}
30
],
31
"text": "Ondansetron 4 Mg Po Tbdp"
32
},
33
"dispenseRequest": {
34
"quantity": {
35
"value": 30,
36
"unit": "tablet"
37
},
38
"numberOfRepeatsAllowed": 0,
39
"validityPeriod": {
40
"start": "2019-04-01T00:00:00.000Z",
41
"end": "2019-05-31T00:00:00.000Z"
42
},
43
"performer": {
44
"reference": "Organization/RedoxOrganizationPharmacyExample"
45
}
46
},
47
"status": "active",
48
"priority": "routine",
49
"reasonCode": [
50
{
51
"coding": [
52
{
53
"code": "422587007",
54
"system": "http://snomed.info/sct"
55
}
56
],
57
"text": "Nausea"
58
}
59
],
60
"authoredOn": "2019-04-01T17:04:16.605Z",
61
"requester": {
62
"reference": "Practitioner/RedoxPractitionerExampleMedicationRequest"
63
},
64
"recorder": {
65
"reference": "Practitioner/RedoxPractitionerExampleMedicationRequest"
66
},
67
"dosageInstruction": [
68
{
69
"text": "one tablet every morning",
70
"asNeededBoolean": false,
71
"route": {
72
"coding": [
73
{
74
"code": "C38288",
75
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
76
"display": "Oral"
77
}
78
]
79
},
80
"doseAndRate": [
81
{
82
"doseQuantity": {
83
"value": 4,
84
"unit": "mg"
85
}
86
}
87
],
88
"timing": {
89
"repeat": {
90
"when": [
91
"MORN"
92
],
93
"boundsPeriod": {
94
"start": "2013-11-11T05:00:00.000Z"
95
}
96
}
97
}
98
}
99
]
100
},
101
"search": {
102
"mode": "match"
103
}
104
}
105
]
106
}

    Response to a MedicationRequest search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of MedicationRequest or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A record of a medication that has been prescribed/ordered.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MedicationRequest
      • status
        required, string

        A code specifying the current state of the order. Generally, this will be active or completed state.

        Possible Values: active, on-hold, cancelled, completed, entered-in-error, stopped, draft, unknown
      • _status
        required, object

        This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

        • extension
          Array of OriginalText or Other

          May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

            See http://hl7.org/fhir/StructureDefinition/originalText for more information

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/StructureDefinition/originalText
          • valueString
            required, string

            The original text

      • intent
        required, string

        Whether the request is a proposal, plan, or an original order.

        Possible Values: proposal, plan, order, original-order, reflex-order, filler-order, instance-order, option
      • subject
        required, object

        A link to a resource representing the person or set of individuals to whom the medication will be given.

        Must be a resource of type Patient.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • requester
        required, object

        The individual, organization, or device that initiated the request and has responsibility for its activation.

        The requester will usually be a reference to a Practitioner resource or a PractitionerRole resource containing the practitioner and additional information. In rare instances, the requester may only be an identifier for the resource, such as an NPI.

        Must reference one of the following types of resources:

        • Practitioner
        • Organization
        • PractitionerRole
        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

        • identifier
          object

          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

          • extension
            Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • url
              required, string

              Source of the definition for the extension code - a logical name or a URL.

            • valueBoolean
              boolean

              A single value for the extension.

          • use
            string

            The purpose of this identifier.

            Possible Values: usual, official, temp, secondary, old (If known)
          • system
            string

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          • value
            string

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • medicationCodeableConcept
        required, object

        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.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • identifier
        Array of object

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

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

          • valueBoolean
            boolean

            A single value for the extension.

        • use
          string

          The purpose of this identifier.

          Possible Values: usual, official, temp, secondary, old (If known)
        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • priority
        string

        Indicates how quickly the Medication Request should be addressed with respect to other requests.

        Possible Values: routine, urgent, asap, stat
      • encounter
        object

        The Encounter during which this [x] was created or to which the creation of this record is tightly associated.

        Must be a resource of type Encounter.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • recorder
        object

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

        Must be a resource of type Practitioner.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • reasonCode
        Array of object

        The reason or the indication for ordering or not ordering the medication.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • system
            string

            The identification of the code system that defines the meaning of the symbol in the code.

          • code
            string

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

        • text
          string

          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • dosageInstruction
        Array of object

        Indicates how the medication is to be used by the patient.

        • text
          string

          Free text dosage instructions e.g. SIG.

        • timing
          object

          When medication should be administered.

          • repeat
            object

            A set of rules that describe when the event is scheduled.

            • frequency
              number

              The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency.

            • frequencyMax
              number

              If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.

            • period
              number

              Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length.

            • _period
              object

              This element contains extensions for period. Depending on the extensions present it could be used in place of period or contain additional information about period. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

                May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

                  See http://hl7.org/fhir/StructureDefinition/originalText for more information

                • url
                  required, string

                  Source of the definition for the extension code - a logical name or a URL.

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • periodMax
              number

              If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days.

            • _periodMax
              object

              This element contains extensions for periodMax. Depending on the extensions present it could be used in place of periodMax or contain additional information about periodMax. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

                May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

                  See http://hl7.org/fhir/StructureDefinition/originalText for more information

                • url
                  required, string

                  Source of the definition for the extension code - a logical name or a URL.

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • periodUnit
              string

              The units of time for the period in UCUM units.

              Possible Values: s, min, h, d, wk, mo, a - unit of time (UCUM)
            • _periodUnit
              object

              This element contains extensions for periodUnit. Depending on the extensions present it could be used in place of periodUnit or contain additional information about periodUnit. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

                May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

                  See http://hl7.org/fhir/StructureDefinition/originalText for more information

                • url
                  required, string

                  Source of the definition for the extension code - a logical name or a URL.

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • when
              Array of string

              An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur.

            • _when
              object

              This element contains extensions for when. Depending on the extensions present it could be used in place of when or contain additional information about when. See the extension element for more details on the possible extensions being sent.

              • extension
                Array of OriginalText or Other

                May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

                  See http://hl7.org/fhir/StructureDefinition/originalText for more information

                • url
                  required, string

                  Source of the definition for the extension code - a logical name or a URL.

                  Value: http://hl7.org/fhir/StructureDefinition/originalText
                • valueString
                  required, string

                  The original text

            • boundsPeriod
              object

              Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.

              • start
                string

                The start of the period. The boundary is inclusive.

              • end
                string

                The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

        • route
          object

          How drug should enter body.

          • coding
            Array of object

            A reference to a code defined by a terminology system.

            • system
              string

              The identification of the code system that defines the meaning of the symbol in the code.

            • code
              string

              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          • text
            string

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

        • doseAndRate
          Array of object

          The amount of medication administered.

          • doseQuantity
            object

            Amount of medication per dose.

            • value
              number

              The value of the measured amount. The value includes an implicit precision in the presentation of the value.

            • system
              string

              The identification of the system that provides the coded form of the unit.

            • code
              string

              A computer processable form of the unit in some unit representation system.

      • dispenseRequest
        object

        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.

        • validityPeriod
          object

          This indicates the validity period of a prescription (stale dating the Prescription).

          • start
            string

            The start of the period. The boundary is inclusive.

          • end
            string

            The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

        • numberOfRepeatsAllowed
          number

          An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.

        • quantity
          object

          The amount that is to be dispensed for one fill.

          • value
            number

            The value of the measured amount. The value includes an implicit precision in the presentation of the value.

          • system
            string

            The identification of the system that provides the coded form of the unit.

          • code
            string

            A computer processable form of the unit in some unit representation system.

        • performer
          object

          Indicates the intended dispensing Organization specified by the prescriber.

          Must be a resource of type Organization.

          • reference
            string

            A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the MedicationRequest as matching the search parameters

        Value: match