Home
FHIR® API actions
Medication
Retrieve a patient's medication list

Retrieve a patient's medication list

If you want to access a patient’s prescribed medications—as documented by a specific organization—you can use this API action to retrieve a list. Typically, you can use this for:

  • tracking a patient’s current medications; or
  • reminding patients to take current medications at the appropriate time.

With this API action, you can retrieve information like medication type, dose, status, timing, frequency, quantity, and more.

Supported systems

You can use this API action with the Redox FHIR® API.

Your connection's system can return results with their own FHIR® or query-based API.

Things you need to know

Action steps

Prerequisites

The following actions must be completed before attempting the steps below.

Steps

Retrieve a patient's prescribed medications

This table has notes about how to use parameters for this action step specifically, but it's not exhaustive. Refer to the MedicationRequest resource schema for more details.

Parameter
Required
Notes
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying. If you don't have a patient identifier, you can find one by searching for a patient with demographics.
intent
N
When using MedicationRequest, you can use both patient identifier and intent to refine your search. If using intent, you can search with any of these values: proposal, plan, order, original-order, reflex-order, filler-order, instance-order, option.

The response contains one or more medications for an individual patient. In FHIR® responses, you can find the total number of included medications in the total array.

MedicationRequest/_search
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/MedicationRequest/_search' \
--request POST \
--header 'Authorization: Bearer ${API_TOKEN}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'patient=Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7' \
--data-urlencode 'intent=order'
{
  "id": "e23a63fb-f611-4492-88c5-8b293b2fa1b5",
  "type": "searchset",
  "entry": [
    {
      "search": {
        "mode": "match",
        "score": 1
      },
      "resource": {
        "id": "9d1810d9-64c8-45ea-8443-e73a3681eb32",
        "meta": {
          "lastUpdated": "2022-10-06T18:58:36.668Z"
        },
        "intent": "order",
        "status": "active",
        "subject": {
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
        },
        "recorder": {
          "reference": "Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832"
        },
        "contained": [
          {
            "id": "364afc13-9969-491d-8d42-6bfebbb35429",
            "name": "Fake Pharmacy",
            "type": [
              {
                "text": "Pharmacy",
                "coding": [
                  {
                    "code": "PHARM",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                    "display": "Pharmacy"
                  }
                ]
              }
            ],
            "active": true,
            "address": [
              {
                "city": "Madison",
                "line": [
                  "123 Fake Street"
                ],
                "state": "WI",
                "postalCode": 53703
              }
            ],
            "identifier": [
              {
                "value": "1234567",
                "system": "urn:redox:redox-fhir-sandbox:NCPDP"
              }
            ],
            "resourceType": "Organization"
          }
        ],
        "encounter": {
          "reference": "Encounter/f221f862-7a5a-499c-bc1c-d3028b9acb5a"
        },
        "requester": {
          "reference": "Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832"
        },
        "identifier": [
          {
            "value": "30c6f13a-01f0-4012-b913-2572ccfc02e4",
            "system": "urn:redox:redox-fhir-sandbox:MedOrderID",
            "extension": [
              {
                "url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
                "valueString": "RedoxAPI"
              }
            ]
          }
        ],
        "resourceType": "MedicationRequest",
        "dispenseRequest": {
          "performer": {
            "reference": "#364afc13-9969-491d-8d42-6bfebbb35429"
          }
        },
        "dosageInstruction": [
          {
            "route": {
              "text": "Oral",
              "coding": [
                {
                  "code": "C38288",
                  "system": "urn:oid:2.16.840.1.113883.3.26.1.1"
                }
              ]
            },
            "timing": {
              "repeat": {
                "period": 8,
                "frequency": 1,
                "periodUnit": "h",
                "boundsPeriod": {
                  "start": "2022-09-12T16:10:35.874Z"
                }
              }
            },
            "doseAndRate": [
              {
                "doseQuantity": {
                  "unit": "mg",
                  "value": 4
                }
              }
            ]
          }
        ],
        "medicationCodeableConcept": {
          "text": "Ondansetron 4 Mg Po Tbdp",
          "coding": [
            {
              "code": "104894",
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm"
            }
          ]
        }
      }
    }
  ],
  "total": 1,
  "resourceType": "Bundle"
}

Retrieve a patient's administered medications during an inpatient visit

This table has notes about how to use parameters for this action step specifically, but it's not exhaustive. Refer to the MedicationAdministration resource schema for more details.

Parameter
Required
Notes
patient.identifier
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying. If you don't have a patient identifier, you can find one by searching for a patient with demographics.

The response contains one or more medications for an individual patient. In FHIR® responses, you can find the total number of included medications in the total array.

MedicationAdministration/_search
curl 'https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/MedicationAdministration/_search' \
--request POST \
--header 'Authorization: Bearer ${API_TOKEN}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'patient=Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7'
{
  "id": "7dd5520f-a778-4aea-aafb-91b0f4eab868",
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "resource": {
        "resourceType": "MedicationAdministration",
        "id": "4eccd037-4f1e-408d-a29b-e722f31608de",
        "subject": {
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
        },
        "identifier": [
          {
            "value": "83927393",
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
            "extension": [
              {
                "url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
                "valueString": "RedoxAPI"
              }
            ]
          }
        ],
        "status": "completed",
        "medicationCodeableConcept": {
          "coding": [
            {
              "code": "573621",
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "display": "Albuterol 0.09 MG/ACTUAT inhalant solution"
            }
          ]
        },
        "context": {
          "reference": "Encounter/e222f44d-428f-446f-8481-e8aeae326ab7"
        },
        "effectiveDateTime": "2022-08-10T04:00:00.000Z",
        "dosage": {
          "dose": {
            "unit": "mg/actuat",
            "value": 0.09
          },
          "route": {
            "text": "RESPIRATORY (INHALATION)",
            "coding": [
              {
                "code": "C38216",
                "system": "urn:oid:2.16.840.1.113883.3.26.1.1"
              }
            ]
          },
          "rateQuantity": {
            "unit": "ml/min",
            "value": 90
          }
        },
        "meta": {
          "lastUpdated": "2022-12-01T22:03:47.989Z"
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ],
  "total": 1
}