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 |
prescriptionNumber | String | (optional) Code that is assigned to the medication to help identify it |
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 |
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"} |