Medication API v1
The HealtheIntent Medication API allows systems to interact with medication data in HealtheIntent.
Notes:
- Cerner must enable this API for your tenant before you can use it. To get started, log a service record (SR) in eService to the solution of HealtheIntent Medication or contact your Cerner representative.
- The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.
URL: https://cernerdemo.api.us-1.healtheintent.com/medication/v1
Medication
Medications are pharmacy orders, statements from patients about their medication use, and medications inferred from claims. Medications can include inpatient medication orders dispensed by hospital pharmacies and community prescriptions dispensed by retail pharmacies. Medications also include over-the-counter medications (for example, aspirin) and dietary supplements.
Retrieve a Single Medication
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications/f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications/f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"additionalInstructions": "take half to one hour before food",
"aliases": [
{
"system": "system_value",
"value": "medication_alias"
}
],
"asNeeded": true,
"category": {
"codings": [
{
"code": "community",
"display": "Community",
"system": "2.16.840.1.113883.4.642.1.1120"
}
],
"sourceCodings": [
{
"code": "community",
"display": "Community",
"system": "2.16.840.1.113883.4.642.1.1120"
}
],
"text": "Community",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"sourceCodings": [
{
"code": "12345",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "myehrvendor:medicationdrug"
}
],
"text": "acetaminophen 500 mg ORAL TABLET",
"concepts": [
{
"contextId": "13A955381FD04E238BEC48D851F04FF9",
"alias": "D03364"
}
]
},
"dispenseRequest": {
"numberOfRepeatsAllowed": 4,
"quantity": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "TABLET"
},
"value": "30"
}
},
"dosages": [
{
"sequence": 1,
"text": "1 tab PO QD",
"additionalInstructions": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "311501008",
"display": "Half to one hour before food"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "311501008",
"display": "Half to one hour before food"
}
],
"text": "Half to one hour before food"
},
"patientInstruction": "Take 1-2 tablets once daily at bedtime as needed for restless legs.",
"timing": {
"repeat": {
"bounds": {
"duration": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
},
"period": {
"startDate": "1997-07-16",
"endDate": "1998-08-24"
}
},
"count": 30,
"duration": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
}
},
"timingSchedule": "This data type allows many different expressions of the event timing. For example, every eight hours, three times a day, half an hour before breakfast for 10 days from 23-Dec 2011, 15 Oct 2013 through 17 Oct 2013, and 1 Nov 2013\"."
},
"asNeeded": {
"takenOnlyAsNeeded": true,
"precondition": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "122003",
"display": "Choroidal hemorrhage"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "122003",
"display": "Choroidal hemorrhage"
}
],
"text": "Choroidal hemorrhage"
}
},
"route": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "26643006",
"display": "Oral use"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "26643006",
"display": "Oral use"
}
],
"text": "Oral use"
},
"dose": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
},
"rate": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
}
}
],
"encounter": {
"id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
},
"end": "2018-05-13",
"frequency": {
"codings": [
{
"code": "229797004",
"display": "Once daily",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "696530",
"display": "Daily",
"system": "urn:cerner:coding:codingsystem:codeset:4003"
}
],
"text": "Daily",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"id": "f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8",
"ingredients": [
{
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"concepts": [],
"sourceCodings": [
{
"code": "12345",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "myehrvendor:medicationdrug"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dose": {
"strength": {
"unit": {
"codings": [
{
"code": "258684004",
"display": "mg",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "258684004",
"display": "mg",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "mg"
},
"value": "500"
},
"quantity": {
"value": "1"
},
"volume": {
"unit": {
"codings": [
{
"code": "385055001",
"display": "Tablet",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "385055001",
"display": "Tablet",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Tablet"
},
"value": "1"
}
},
"referenceDrug": {
"brandType": "GENERIC",
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dosageForm": {
"codings": [
{
"code": "C42998",
"display": "Tablet",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "Tablet"
},
"route": {
"codings": [
{
"code": "C38288",
"display": "ORAL",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "ORAL"
},
"strength": {}
}
}
],
"intendedAdministrator": "SELF",
"intendedDispenser": "RETAIL_PHARMACY",
"notes": [
{
"author": {
"aliases": [
{
"system": "2.16.840.1.113883.4.814",
"type": "DEA",
"value": "AD0869837"
}
],
"name": {
"family": [
"Brizendine"
],
"formatted": "Brizendine, Margaret",
"given": [
"Margaret"
],
"prefix": "Dr.",
"suffix": "Jr."
}
},
"date": "2018-04-30",
"text": "patient is non-compliant"
}
],
"prescriber": {
"aliases": [
{
"system": "2.16.840.1.113883.4.6",
"type": "NPI",
"value": "1831176692"
}
],
"name": {
"family": [
"Johnson"
],
"formatted": "Johnson, Analisa",
"given": [
"Analisa"
],
"prefix": "Dr.",
"suffix": "Jr."
}
},
"provenances": [
{
"entities": [
{
"role": {
"sourceCodings": [
{
"code": "source",
"system": "2.16.840.1.113883.4.642.4.437",
"display": "Source"
}
],
"codings": [
{
"code": "source",
"system": "2.16.840.1.113883.4.642.4.437",
"display": "Source"
}
],
"text": "Source"
},
"what": {
"documentReference": {
"id": "581433f4-b179-3df4-9bb2-9768ef76493c"
}
}
}
],
"agents": [
{
"type": {
"sourceCodings": [
{
"code": "author",
"system": "2.16.840.1.113883.4.642.4.1131",
"display": "Author"
}
],
"codings": [
{
"code": "author",
"system": "2.16.840.1.113883.4.642.4.1131",
"display": "Author"
}
],
"text": "Author"
},
"who": {
"organization": {
"name": "Rockcreek Clinic",
"aliases": [
{
"value": "151579",
"type": "EXTERNAL",
"system": "1.2.3.4.5.6.7.8.9.10.1"
}
]
}
}
}
],
"recordedOn": "2011-07-26T23:53:00.000Z"
}
],
"referenceDrug": {
"brandType": "GENERIC",
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dosageForm": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "Tablet"
},
"route": {
"codings": [
{
"code": "C38288",
"display": "ORAL",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "ORAL"
},
"strength": {}
},
"route": {
"codings": [
{
"code": "738956005",
"display": "Oral",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "738956005",
"display": "Oral",
"system": "urn:oid:2.16.840.1.113883.6.96"
}
],
"text": "Oral",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"sigDirections": "500 mg, 1 tab, Route: oral, Drug form: Tab, Daily, Start date: 04/13/18 9:00:00, Duration: 30 day, Stop date: 05/13/18 9:00:00.",
"sourceIdentifier": {
"dataPartitionId": "2e07f958-82fe-470b-871d-3f7227800a63",
"id": "12345"
},
"start": "2018-04-13",
"status": {
"codings": [
{
"code": "55561003",
"display": "Active",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "2550",
"display": "Ordered",
"system": "urn:cerner:coding:codingsystem:codeset:6004"
}
],
"text": "Ordered",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"substitutionAllowed": true
}
GET /populations/{populationId}/patients/{patientId}/medications/{medicationId}
Retrieves a single medication for a given patient.
Parameters
Parameter |
In |
Type |
Required |
Default |
Description |
Accepted Values |
patientId |
path |
string |
true |
N/A |
The ID of the patient. |
- |
populationId |
path |
string |
true |
N/A |
The ID of the population. |
- |
medicationId |
path |
string |
true |
N/A |
The unique ID of the medication for the patient. |
- |
Response Statuses
Retrieve a List of Medications
Example Request:
require 'httparty' # Using HTTParty 0.16.2
require 'json'
headers = {
'Authorization' => '<auth_header>',
'Accept' => 'application/json'
}
result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"additionalInstructions": "take half to one hour before food",
"aliases": [
{
"system": "system_value",
"value": "medication_alias"
}
],
"asNeeded": true,
"category": {
"codings": [
{
"code": "community",
"display": "Community",
"system": "2.16.840.1.113883.4.642.1.1120"
}
],
"sourceCodings": [
{
"code": "community",
"display": "Community",
"system": "2.16.840.1.113883.4.642.1.1120"
}
],
"text": "Community",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"sourceCodings": [
{
"code": "12345",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "myehrvendor:medicationdrug"
}
],
"text": "acetaminophen 500 mg ORAL TABLET",
"concepts": [
{
"contextId": "13A955381FD04E238BEC48D851F04FF9",
"alias": "D03364"
}
]
},
"dispenseRequest": {
"numberOfRepeatsAllowed": 4,
"quantity": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "TABLET"
},
"value": "30"
}
},
"dosages": [
{
"sequence": 1,
"text": "1 tab PO QD",
"additionalInstructions": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "311501008",
"display": "Half to one hour before food"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "311501008",
"display": "Half to one hour before food"
}
],
"text": "Half to one hour before food"
},
"patientInstruction": "Take 1-2 tablets once daily at bedtime as needed for restless legs.",
"timing": {
"repeat": {
"bounds": {
"duration": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
},
"period": {
"startDate": "1997-07-16",
"endDate": "1998-08-24"
}
},
"count": 30,
"duration": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
}
},
"timingSchedule": "This data type allows many different expressions of the event timing. For example, every eight hours, three times a day, half an hour before breakfast for 10 days from 23-Dec 2011, 15 Oct 2013 through 17 Oct 2013, and 1 Nov 2013\"."
},
"asNeeded": {
"takenOnlyAsNeeded": true,
"precondition": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "122003",
"display": "Choroidal hemorrhage"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "122003",
"display": "Choroidal hemorrhage"
}
],
"text": "Choroidal hemorrhage"
}
},
"route": {
"sourceCodings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "26643006",
"display": "Oral use"
}
],
"codings": [
{
"system": "2.16.840.1.113883.6.96",
"code": "26643006",
"display": "Oral use"
}
],
"text": "Oral use"
},
"dose": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
},
"rate": {
"unit": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"sourceCodings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1.2"
}
],
"text": "TABLET"
},
"value": "1"
}
}
],
"encounter": {
"id": "9828e369-1716-4f87-b4fb-3e0c61793bc8"
},
"end": "2018-05-13",
"frequency": {
"codings": [
{
"code": "229797004",
"display": "Once daily",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "696530",
"display": "Daily",
"system": "urn:cerner:coding:codingsystem:codeset:4003"
}
],
"text": "Daily",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"id": "f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8",
"ingredients": [
{
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"concepts": [],
"sourceCodings": [
{
"code": "12345",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "myehrvendor:medicationdrug"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dose": {
"strength": {
"unit": {
"codings": [
{
"code": "258684004",
"display": "mg",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "258684004",
"display": "mg",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "mg"
},
"value": "500"
},
"quantity": {
"value": "1"
},
"volume": {
"unit": {
"codings": [
{
"code": "385055001",
"display": "Tablet",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "385055001",
"display": "Tablet",
"system": "2.16.840.1.113883.6.96"
}
],
"text": "Tablet"
},
"value": "1"
}
},
"referenceDrug": {
"brandType": "GENERIC",
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dosageForm": {
"codings": [
{
"code": "C42998",
"display": "Tablet",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "Tablet"
},
"route": {
"codings": [
{
"code": "C38288",
"display": "ORAL",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "ORAL"
},
"strength": {}
}
}
],
"intendedAdministrator": "SELF",
"intendedDispenser": "RETAIL_PHARMACY",
"notes": [
{
"author": {
"aliases": [
{
"system": "2.16.840.1.113883.4.814",
"type": "DEA",
"value": "AD0869837"
}
],
"name": {
"family": [
"Brizendine"
],
"formatted": "Brizendine, Margaret",
"given": [
"Margaret"
],
"prefix": "Dr.",
"suffix": "Jr."
}
},
"date": "2018-04-30",
"text": "patient is non-compliant"
}
],
"prescriber": {
"aliases": [
{
"system": "2.16.840.1.113883.4.6",
"type": "NPI",
"value": "1831176692"
}
],
"name": {
"family": [
"Johnson"
],
"formatted": "Johnson, Analisa",
"given": [
"Analisa"
],
"prefix": "Dr.",
"suffix": "Jr."
}
},
"provenances": [
{
"entities": [
{
"role": {
"sourceCodings": [
{
"code": "source",
"system": "2.16.840.1.113883.4.642.4.437",
"display": "Source"
}
],
"codings": [
{
"code": "source",
"system": "2.16.840.1.113883.4.642.4.437",
"display": "Source"
}
],
"text": "Source"
},
"what": {
"documentReference": {
"id": "581433f4-b179-3df4-9bb2-9768ef76493c"
}
}
}
],
"agents": [
{
"type": {
"sourceCodings": [
{
"code": "author",
"system": "2.16.840.1.113883.4.642.4.1131",
"display": "Author"
}
],
"codings": [
{
"code": "author",
"system": "2.16.840.1.113883.4.642.4.1131",
"display": "Author"
}
],
"text": "Author"
},
"who": {
"organization": {
"name": "Rockcreek Clinic",
"aliases": [
{
"value": "151579",
"type": "EXTERNAL",
"system": "1.2.3.4.5.6.7.8.9.10.1"
}
]
}
}
}
],
"recordedOn": "2011-07-26T23:53:00.000Z"
}
],
"referenceDrug": {
"brandType": "GENERIC",
"code": {
"codings": [
{
"code": "00005310141",
"display": "acetaminophen 500 mg ORAL TABLET",
"system": "2.16.840.1.113883.6.69"
}
],
"text": "acetaminophen 500 mg ORAL TABLET"
},
"dosageForm": {
"codings": [
{
"code": "C42998",
"display": "TABLET",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "Tablet"
},
"route": {
"codings": [
{
"code": "C38288",
"display": "ORAL",
"system": "2.16.840.1.113883.3.26.1.1"
}
],
"text": "ORAL"
},
"strength": {}
},
"route": {
"codings": [
{
"code": "738956005",
"display": "Oral",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "738956005",
"display": "Oral",
"system": "urn:oid:2.16.840.1.113883.6.96"
}
],
"text": "Oral",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"sigDirections": "500 mg, 1 tab, Route: oral, Drug form: Tab, Daily, Start date: 04/13/18 9:00:00, Duration: 30 day, Stop date: 05/13/18 9:00:00.",
"sourceIdentifier": {
"dataPartitionId": "2e07f958-82fe-470b-871d-3f7227800a63",
"id": "12345"
},
"start": "2018-04-13",
"status": {
"codings": [
{
"code": "55561003",
"display": "Active",
"system": "2.16.840.1.113883.6.96"
}
],
"sourceCodings": [
{
"code": "2550",
"display": "Ordered",
"system": "urn:cerner:coding:codingsystem:codeset:6004"
}
],
"text": "Ordered",
"concepts": [
{
"contextId": "2A8180EF0FB44CC6898F19243F9A3DAC",
"alias": "PAP_TEST_PROC"
}
]
},
"substitutionAllowed": true
}
],
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications?limit=20",
"nextLink": "https://cernerdemo.api.us-1.healtheintent.com/medication/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/medications?cursor=f09385c8e68530e2227097cffb70e464437b6faf560ee3a8ffca84369291e2b8&limit=20"
}
GET /populations/{populationId}/patients/{patientId}/medications
Retrieves a list of the medications for a given patient.
Parameters
Parameter |
In |
Type |
Required |
Default |
Description |
Accepted Values |
patientId |
path |
string |
true |
N/A |
The ID of the patient. |
- |
populationId |
path |
string |
true |
N/A |
The ID of the population. |
- |
cursor |
query |
string |
false |
N/A |
The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. |
- |
limit |
query |
integer(int32) |
false |
20 |
The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. |
- |
code:coding |
query |
array[string] |
false |
N/A |
Filters the list based on the code coding field. |
- |
code:concept |
query |
array[string] |
false |
N/A |
Filters the list based on the code concept field. |
- |
code:sourceCoding |
query |
array[string] |
false |
N/A |
Filters the list based on the code sourceCoding field. |
- |
code:text |
query |
array[string] |
false |
N/A |
Filters the list based on the code text field. |
- |
status |
query |
array[string] |
false |
N/A |
Filters the list based on the status field. |
MISSING, ACTIVE_SUBSET_QUAL, ACTIVE_OUTPATIENT_PHARMACY_MEDICATION_QUAL, INACTIVE_SUBSET_QUAL, PENDING_ON_HOLD_SUBSET_QUAL, IN_ERROR_NEVER_ACTIVE_SUBSET_QUAL, ERROR_ENTRY_DELETED_QUAL |
Response Statuses
Schema Definitions
Alias
Name |
Type |
Required |
Description |
Accepted Values |
system |
string |
false |
The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. |
- |
value |
string |
false |
The ID issued by the assigning authority. The formatting may vary by alias type. |
- |
Dosage
Name |
Type |
Required |
Description |
Accepted Values |
sequence |
integer(int32) |
false |
The order of dosage instructions. This order is applicable to tapered dosings. |
- |
text |
string |
false |
Free text dosage instructions. For example, the sig line. |
- |
additionalInstructions |
[CodeableConcept] |
false |
Supplemental instructions for the patient on how to take the medication or warnings for the patient about the medication. |
- |
patientInstruction |
string |
false |
Instructions that are understood by the patient or consumer. |
- |
timing |
Timing |
false |
When the medication should be administered. |
- |
asNeeded |
AsNeeded |
false |
Provides a choice of representations for indicating whether the medication is taken only when needed. Only one element is valued. |
- |
route |
CodeableConcept |
false |
How the drug should enter the body, for example, topical or oral. |
- |
dose |
Quantity |
false |
The amount of medication per dose. The dose and rate collectively represent the ordered amount of medication administered. |
- |
rate |
Quantity |
false |
The amount of medication or substance per unit of time, such as how many pills are taken per administration event. For example, if the order was to take two tablets daily for 30 days, then the dose quantity is two. Note: This refers to the quantity of the specified medication, not the quantity of active ingredients. |
- |
MedicationOpenApi_V1_Dose
Name |
Type |
Required |
Description |
Accepted Values |
strength |
MedicationOpenApi_V1_Quantity |
false |
The dose strength of the medication ingredient. The dose strength can differ from the reference drug’s strength, which describes the strength of the drug itself. For example, a patient who is instructed to take two 20 mg tablets implies a reference drug strength of 20 mg, whereas the dose strength is 40 mg. |
- |
quantity |
MedicationOpenApi_V1_Quantity |
false |
The quantity of the medication ingredient, such as one tablet. |
- |
volume |
MedicationOpenApi_V1_Quantity |
false |
The volume of the medication ingredient, such as 500 mL. |
- |
MedicationOpenApi_V1_Quantity
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept
Name |
Type |
Required |
Description |
Accepted Values |
codings |
[Code] |
true |
A list of codified values from standard code systems recognized by HealtheIntent. |
- |
sourceCodings |
[Code] |
true |
The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. |
- |
concepts |
[LongitudinalRecordPublicApi_Entities_V1_Common_Concept] |
false |
The list of ontological concepts derived from the codified values from standard code systems recognized by HealtheIntent. |
- |
text |
string |
false |
This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. |
- |
Code
Name |
Type |
Required |
Description |
Accepted Values |
code |
string |
true |
The unique ID of the code. |
- |
display |
string |
false |
A human-readable representation of the code. |
- |
system |
string |
true |
The ID of the coding system that gives meaning to the code. |
- |
LongitudinalRecordPublicApi_Entities_V1_Common_Concept
Name |
Type |
Required |
Description |
Accepted Values |
alias |
string |
true |
The unique ID of the concept in a context. |
- |
contextId |
string |
true |
The unique ID of the context. IDs are all uppercase and do not include dashes. |
- |
MedicationOpenApi_V1_Ingredient
Name |
Type |
Required |
Description |
Accepted Values |
code |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
The identification of an ingredient in the medication that should be taken. The ingredient code can have varying degrees of specificity, ranging from being noncodified free text, a simple codified generic ingredient, a codified brand name, to a pre-coordinated code that conveys the ingredient or brand name with its strength and dose form. For simple medications that are comprised of a single ingredient or product, the ingredient code is the same as the medication code. However, for complex, multi-ingredient medications, the ingredient code differs from the medication code. For example, the medication code for a total parenteral nutrition (TPN) order indicates TPN, whereas the ingredient codes might include dextrose, potassium, magnesium, zinc, calcium, lipids, and multivitamins. |
- |
dose |
MedicationOpenApi_V1_Dose |
false |
The quantity, strength, and volume of the administered drug dose. |
- |
referenceDrug |
MedicationOpenApi_V1_ReferenceDrug |
false |
A standardized drug used as a baseline measurement for similar drugs. |
- |
MedicationOpenApi_V1_ReferenceDrug
Name |
Type |
Required |
Description |
Accepted Values |
brandType |
string |
false |
Designates whether the drug is a brand-name or generic product. The designation is based on internal editorial rules and cost algorithms that are used to determine whether a multi-source drug is generic. |
BRAND, GENERIC |
code |
MedicationOpenApi_V1_Codings |
true |
The identification of the drug, often expressed using the National Drug Code (NDC) system. |
- |
dosageForm |
MedicationOpenApi_V1_Codings |
false |
The form of the medication in which it is marketed for use. |
- |
route |
MedicationOpenApi_V1_Codings |
false |
How the medication should enter the body, such as oral or topical. |
- |
strength |
MedicationOpenApi_V1_QuantityLite |
false |
The strength of this drug. This strength can differ from the ingredient’s dose strength, which defines the intended dose per administration event. For example, a patient who is instructed to take two 20 mg tablets implies a reference drug strength of 20 mg, whereas the dose strength is 40 mg. This element is currently not populated at this time. |
- |
MedicationOpenApi_V1_Codings
Name |
Type |
Required |
Description |
Accepted Values |
codings |
[Code] |
true |
Identification of the drug often expressed using the NDC code system. |
- |
text |
string |
false |
The date the medication was ended or set to stop. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. |
- |
MedicationOpenApi_V1_QuantityLite
Name |
Type |
Required |
Description |
Accepted Values |
unit |
Code |
false |
The unit of measure associated with the dose quantity. |
- |
value |
string |
false |
The numerical value of the dose quantity. |
- |
MedicationOpenApi_V1_Medication
Name |
Type |
Required |
Description |
Accepted Values |
additionalInstructions |
string |
false |
The supplemental instructions to the patient on how to take the medication (for example, “with meals” or “take half to one hour before food”) or warnings for the patient about the medication (for example, “may cause drowsiness” or “avoid exposure of skin to direct sunlight or sunlamps”). |
- |
aliases |
[Alias] |
false |
The identifiers associated with the medication that are defined by business processes. The identifiers can be used to reference the medication as they remain constant as the medication is updated. |
- |
asNeeded |
boolean |
false |
A boolean value to indicate whether the medication is only taken when needed within a specific dosing schedule. |
- |
category |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
Indicates where the medication is expected to be consumed or administered. |
- |
code |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
The identification of the medication that should be taken. The medication code can have varying degrees of specificity, ranging from being noncodified free text, a simple codified generic ingredient, a codified brand name, a pre-coordinated code that conveys the ingredient or brand name with its strength and dose form, to a HealtheIntent ontological concept. |
- |
dispenseRequest |
MedicationOpenApi_V1_DispenseRequest |
false |
Represents the specific details for the dispense or supply part of the medication request. |
- |
dosages |
[Dosage] |
false |
How the medication is taken or should be taken. |
- |
shippingInformations |
[ShippingInformation] |
false |
A list of shipping information pertaining to the delivery of the dispensed medication to a patient from an outpatient facility or retail pharmacy. |
- |
encounter |
MedicationOpenApi_V1_Encounter |
false |
The encounter associated with the medication. |
- |
end |
string |
false |
The date the medication was ended or set to stop. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. |
- |
frequency |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
The frequency, expected schedule, or timing of medication administration events. |
- |
id |
string |
true |
The unique ID of the medication record. |
- |
ingredients |
[MedicationOpenApi_V1_Ingredient] |
true |
The ingredients of the medication. |
- |
intendedAdministrator |
string |
false |
The intended administrator for the medication. The intendedAdministrator field can be used to distinguish between the administrator types. By using the intendedAdministrator field with the intendedDispenser field, you can infer certain information. For example, an inpatient medication would be dispensed from a hospital pharmacy and administered by a provider. |
PROVIDER, SELF |
intendedDispenser |
string |
false |
The intended dispenser for the medication. The intendedDispenser field can be used to distinguish among the dispense types for the medication. By using the intendedDispenser field with the intendedAdministrator field, you can infer certain information. For example, an inpatient medication would be dispensed from a hospital pharmacy and administered by a provider. |
HOSPITAL_PHARMACY, INPATIENT_FLOOR_STOCK, OFFICE, OTC, RETAIL_PHARMACY, UNKNOWN |
notes |
[ProviderNote] |
true |
The notes or comments associated with the medication. This can be used to understand why a decision was made or specific instructions regarding the medication. |
- |
prescriber |
Provider |
false |
The ordering or prescribing provider for the medication. |
- |
provenances |
[LongitudinalRecordPublicApi_Entities_V1_Common_Provenance] |
true |
The record-keeping assertions about the context in which the information in this medication was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source Consolidated Clinical Document Architecture (C-CDA) document from which this medication was derived, if applicable). |
- |
referenceDrug |
MedicationOpenApi_V1_ReferenceDrug |
false |
A standardized drug used as a baseline measurement for similar drugs. |
- |
route |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
How the medication should enter the body, such as oral or topical. |
- |
sigDirections |
string |
false |
Textual description of the dosage instructions, such as the dose per administration event, route, frequency, start date, and duration. |
- |
sourceIdentifier |
SourceIdentifier |
false |
An ID that uniquely identifies this medication for a patient in a data partition. |
- |
start |
string |
false |
The date the medication was started or set to start. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. |
- |
status |
LongitudinalRecordPublicApi_Entities_V1_Common_CodeableConcept |
false |
The current status of the medication order or medication use, such as active, completed, discontinued, or on-hold. |
- |
substitutionAllowed |
boolean |
false |
Boolean to indicate whether or not substitution can be done as part of the dispense. |
- |
MedicationOpenApi_V1_DispenseRequest
Name |
Type |
Required |
Description |
Accepted Values |
numberOfRepeatsAllowed |
integer(int32) |
false |
The number of refills authorized. |
- |
quantity |
MedicationOpenApi_V1_Quantity |
false |
The amount of medication requested to be supplied per dispense. |
- |
MedicationOpenApi_V1_Encounter
Name |
Type |
Required |
Description |
Accepted Values |
id |
string |
false |
The unique ID of the encounter. |
- |
ProviderNote
Name |
Type |
Required |
Description |
Accepted Values |
date |
string |
false |
The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. |
- |
text |
string |
true |
The textual content of the note or comment. |
- |
author |
Provider |
false |
The individual who recorded the note or comment. |
- |
type |
CodeableConcept |
false |
The type of the note or comment. |
- |
Provider
Name |
Type |
Required |
Description |
Accepted Values |
aliases |
[ProviderAlias] |
false |
A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. |
- |
name |
ProviderName |
false |
The attributes of the provider name. |
- |
ProviderAlias
Name |
Type |
Required |
Description |
Accepted Values |
system |
string |
false |
The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. |
- |
value |
string |
false |
The unique ID of the provider in the context of the system or assigning authority. |
- |
type |
string |
true |
The type of alias. |
DEA, EXTERNAL, NPI, SL, TAX, UPIN |
ProviderName
Name |
Type |
Required |
Description |
Accepted Values |
prefix |
string |
false |
The parts that come before the name such as Dr., Mr., or Mrs. |
- |
given |
[string] |
true |
A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. |
- |
family |
[string] |
true |
A list of family (last) name portions of the person’s name. Some people have multiple family names. |
- |
suffix |
string |
false |
The parts that come after the name such as MD, III, or Jr. |
- |
formatted |
string |
false |
The person’s fully-formatted name. |
- |
CodeableConcept
Name |
Type |
Required |
Description |
Accepted Values |
codings |
[Code] |
true |
A list of codified values from standard code systems recognized by HealtheIntent. |
- |
sourceCodings |
[Code] |
true |
The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. |
- |
concepts |
[Concept] |
false |
The list of ontological concepts derived from the codified values from standard code systems recognized by HealtheIntent. |
- |
text |
string |
false |
This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. |
- |
Concept
Name |
Type |
Required |
Description |
Accepted Values |
alias |
string |
true |
The unique ID of the concept in a context. |
- |
contextId |
string |
true |
The unique ID of the context. IDs are in all caps and do not include dashes. |
- |
LongitudinalRecordPublicApi_Entities_V1_Common_Provenance
LongitudinalRecordPublicApi_Entities_V1_Common_ProvenanceEntity
LongitudinalRecordPublicApi_Entities_V1_Common_ProvenanceEntityIdentity
LongitudinalRecordPublicApi_Entities_V1_Common_DocumentReferenceId
Name |
Type |
Required |
Description |
Accepted Values |
id |
string |
false |
The unique ID of the document reference. |
- |
LongitudinalRecordPublicApi_Entities_V1_Common_ProvenanceAgent
LongitudinalRecordPublicApi_Entities_V1_Common_ProvenanceAgentEntity
LongitudinalRecordPublicApi_Entities_V1_Common_Organization
LongitudinalRecordPublicApi_Entities_V1_Common_OrganizationAlias
Name |
Type |
Required |
Description |
Accepted Values |
value |
string |
true |
The unique ID of the alias. |
- |
type |
string |
true |
The type of organization alias, such as NPI. |
NPI, TAX, EXTERNAL, NABP, HL7_OID |
system |
string |
false |
The authority responsible for assigning the alias value. Alias values may be unique within this system namespace but not across systems. |
- |
SourceIdentifier
Name |
Type |
Required |
Description |
Accepted Values |
dataPartitionId |
string |
false |
The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. |
- |
id |
string |
false |
An ID that uniquely identifies this entity for a patient in the data partition. |
- |
Error
Name |
Type |
Required |
Description |
Accepted Values |
code |
integer(int32) |
true |
The HTTP response status code that represents the error. |
- |
message |
string |
true |
A human-readable description of the error. |
- |
errorDetails |
[ErrorDetail] |
false |
A list of additional error details. |
- |
ErrorDetail
Name |
Type |
Required |
Description |
Accepted Values |
domain |
string |
false |
A subsystem or context where an error occurred. |
- |
reason |
string |
false |
A codified value that represents the specific error that caused the current error status. |
- |
message |
string |
false |
A human-readable description of an error. |
- |
locationType |
string |
false |
The location or type of the field that caused an error. |
query, header, path, formData, body |
location |
string |
false |
The name of the field that caused an error. |
- |
Medications
Name |
Type |
Required |
Description |
Accepted Values |
items |
[MedicationOpenApi_V1_Medication] |
true |
[MedicationOpenApi_V1_Medication model] |
- |
firstLink |
string |
true |
The first page of results. |
- |
nextLink |
string |
false |
The next page of results. |
- |