US Meds Implementation Guide (Release 1)

This page is part of the US-Medication FHIR IG (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

Get All Active Medications Orders Example

Storyboard for this example

The following example is based upon the following scenario:

Patient Brian Z uses an App to request all his medications from a single provider, Dr Cayr. This test scenario exercises a mix of routine meds, unusual schedule meds and as-needed meds. All meds are in the outpatient setting only.

Provider A’s (Dr Cayr) medication records for Patient Brian Z

Item Date Script Source Notes
1 9/12/2016 testosterone cypionate 100mg/ml inj 1ml intramuscularly every 3 weeks Reported by Patient Get at doctor’s office every third Friday. Taking for energy level and drive.
2 9/1/2016 testosterone cypionate 100mg/ml inj 1ml intramuscularly Reported by Dr Cryn completed
3 1/15/2016 Zocor (simvastatin) 40mg by mouth once daily Dr. Cayr Order: BMC patient med status: taking
4 7/1/2015 Humulin R (insulin regular, human) U100 10U every AM, 5U every PM, 5U at bedtime. Dr.Cayr Order:BMC patient med status: taking
5 6/12/2015 simvastatin 30mg by mouth once daily Dr. Cayr Order: BMC patient med status: completed

Request:

Get “all medication orders” for a patient by querying MedicationRequest using the patient and status= “active” search parameters.

GET [base]/MedicationRequest?patient=test2&status=active

Response:

A Server returns a search Bundle resource containing all the MedicationRequests with a status of “active” for the patient Brian Z.

  HTTP/1.1 200 OK
  [other headers]
  {
 "resourceType": "Bundle",
  "id": "get-all-active-orders",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2017-03-28T14:06:11.808-04:00"
  },
  "type": "searchset",
  "total": 2,
  ...snip...
  "entry": [
    {
      "fullUrl": "http://wildfhir.aegis.net/fhir3-0-0/MedicationRequest/test2-1",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "test2-1",
    ...snip...
        "status": "active",
        "intent": "order",
        "medicationCodeableConcept": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "104491",
              "display": "Simvastatin 20 MG Oral Tablet [Zocor]",
              "userSelected": false
            }
          ],
          "text": "Zocor (simvastatin) 20mg Tablet"
    ...snip...
    },
    {
      "fullUrl": "http://wildfhir.aegis.net/fhir3-0-0/MedicationRequest/test2-2",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "test2-2",
    ...snip...
        "status": "active",
        "intent": "order",
        "medicationCodeableConcept": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "311036",
              "display": "Humulin R (insulin regular, human) U100  100units/ml inj solution",
              "userSelected": false
            }
          ],
          "text": "Humulin R (insulin regular, human) U100  100units/ml inj solution"
        },
    ...snip...
  ]
}

links to example files: