Get a list of medical medications the user has had so far
Returns a list of medical medications
GET https://api.humanapi.co/v1/human/medical/medications
Returns a single medication
GET https://api.humanapi.co/v1/human/medical/medications/{id}
# Returns a json array of medications:
[{
"id": "55a2ff2d197f25c42f2e84b7",
"updatedAt": "2014-12-09T18:06:42.100Z",
"createdAt": "2014-12-09T18:06:42.100Z",
"commonBrandName": "CLARITIN",
"details": {
"dosage": {
"form": "tablet",
"value": "1"
},
"frequency": {
"number": "1",
"unit": "as-needed"
},
"route": "enteral_oral",
"strength": {
"number": "10",
"unit": "mg"
}
},
"dosageInfo": "10 MG tablet",
"genericProductIndicator": "41550030000320",
"instructions": "Take 1 tab by mouth as needed (allergies).",
"name": "loratadine (CLARITIN) 10 MG tablet",
"ndcCode": "0781-5077-01",
"organization": {
"href": "/medical/organizations/53c050ac51c69003200aa998",
"id": "53c050ac51c69003200aa998",
"name": "Cleveland Clinic"
},
"patient": {
"name": "Maxwell Forrest"
},
"productName": "loratadine",
"provider": "Isaias Kingston, MD",
"providerID": "34665",
"source": "emr-1-320",
"status": "Active",
"startDate": "2012-01-26T00:00:00.000Z",
"endDate": "2014-01-26T00:00:00.000Z",
"codes": []
},
{
"id": "55a2fef4197f25c42f2e849f",
"updatedAt": "2014-12-09T18:06:42.100Z"
"createdAt": "2014-12-09T18:06:42.100Z",
"commonBrandName": "LEXAPRO",
"details": {
"dosage": {
"form": "tablet",
"value": "1"
},
"frequency": {
"number": "1",
"unit": "day"
},
"route": "enteral_oral",
"strength": {
"number": "5",
"unit": "mg"
}
},
"dosageInfo": "5 mg tablet",
"genericProductIndicator": "58160034100310",
"instructions": "Take 1 tablet by mouth every day",
"name": "escitalopram (LEXAPRO) 5 mg tablet",
"ndcCode": "0378-3855-77",
"organization": {
"href": "/medical/organizations/53c050ac51c69003200aa998",
"id": "53c050ac51c69003200aa998",
"name": "Cleveland Clinic"
},
"patient": {
"name": "Maxwell Forrest"
},
"productName": "escitalopram",
"provider": "Isaias Kingston, MD",
"providerID": "34665",
"source": "emr-1-320",
"status": "On Hold",
"startDate": "2012-01-26T00:00:00.000Z",
"endDate": "2014-01-26T00:00:00.000Z",
"codes": []
}]
# Get all medications associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/medical/medications"
Response Properties
Property | Type | Description |
---|---|---|
id | String | The id of the resource |
source | String | The name of the originating service |
updatedAt | Date | The time the record was updated on the Human API server |
createdAt | Date | The time the record was created on the Human API server |
instructions | String | (optional) The instructions provided for the medication (e.g. ‘Take 1 tablet by mouth daily.’) |
details | Object | (optional) Parsed dosage and instruction information (see below) |
genericProductIndicator | String | (optional) Generic Product Identifier of the medication |
patient | Object | (optional) Patient information (“name” and other optional attributes) |
name | String | (optional) The name of the medication (e.g. 'Cyanocobalamin (VITAMIN B12 PO)’) |
provider | String | (optional) The name of the provider - if available (e.g. 'Jacob Smith, MD’, 'Outside Provider’, 'Unknown’) |
providerID | String | (optional) The id of the provider |
ndcCode | String | (optional) The National Drug Code of the medication (if provided) |
productName | String | (optional) The product name of the medication - if provided (e.g. 'zolpidem’, 'gabapentin’, 'aspirin’) |
commonBrandName | String | (optional) The common brand name of the medication - if provided (e.g. 'NORCO’, 'XANAX’, 'NEURONTIN’) |
dosageInfo | String | (optional) The dosage information - if provided (e.g. '10 MG tablet’, '100 UNIT/ML injection’, '5mg Tab’) |
pharmacy | Object | (optional) Pharmacy information - if provided (see pharmacy below) |
organization | Object | (optional) See organizations object |
expiration | Date | (optional) The expiration date of the medication - if provided |
refillsRemaining | Number | (optional) The number of refills remaining - if available |
refillsTotal | Number | (optional) The total number of refills - if available |
status | String | (optional) Prescription status for a medication - if available (e.g. 'Active’, 'On Hold’) |
startDate | Date | (optional) Start date of the medication |
endDate | Date | (optional) End date of the medication |
codes | Array[Object] | (optional) See codes |
Pharmacy Object
Property | Type | Description |
---|---|---|
id | String | The id of the resource |
name | String | (optional) The name of the pharmacy |
address | String | (optional) The address of the pharmacy |
phone | String | (optional) The phone number of the pharmacy |
hours | String | (optional) The opening hours of the pharmacy (if provided) |
Details Object
Property | Type | Description |
---|---|---|
dosage | Object | (optional) The 'form’ and 'value’ of a dosage if applicable e.g. "dosage": {"form: "capsule", "value": "3"} |
frequency | Object | (optional) The frequency that the medication should be taken e.g. "frequency": {"number": "1", "unit": "day"} |
route | String | (optional) The route the medication is taken e.g. "route": "enteral_oral" |
strength | Object | (optional) The strength of the dosage e.g. "strength": {"number": "100, "unit": "mg"} |