Get a list of medical encounters the user has had so far
Returns a list of medical encounters
GET https://api.humanapi.co/v1/human/medical/encounters
Returns a single encounter
GET https://api.humanapi.co/v1/human/medical/encounters/{id}
# Returns a json array of encounters:
[
{
"codes": [
{
"code": "3",
"codeSystem": "1.2.840.114350.1.13.106.2.7.4.698084.30",
"codeSystemName": "Epic.EncounterType",
"name": "Hospital Encounter"
}
],
"createdAt": "2014-10-19T21:33:19.971Z",
"dateTime": "2014-07-21T17:30:00.000Z",
"diagnoses": [],
"id": "54442e1f8bbb040d5388e842",
"medications": [
{
"canRefill": false,
"codes": [],
"genericProductIndicator": "42200032301810",
"hasPendingRefill": false,
"name": "FLUTICASONE PROPIONATE (NASAL) 50 MCG/ACT NA SUSP",
"ndcCode": "0054-3270-99",
"startDate": "2010-09-17T04:00:00.000Z"
},
{
"canRefill": false,
"codes": [],
"genericProductIndicator": "01200010100315",
"hasPendingRefill": false,
"name": "Amoxicillin 875 MG OR TABS",
"ndcCode": "0093-2264-01",
"startDate": "2010-09-17T04:00:00.000Z"
}
],
"orders": [
{
"codeType": "Custom",
"codes": [],
"expectedDate": "2012-01-19T05:00:00.000Z",
"expireDate": "2013-01-18T05:00:00.000Z",
"name": "LIPID PROFILE",
"procedureCode": "LABLIPID",
"type": "LAB CHEMISTRY"
}
],
"organization": {
"href": "/medical/organizations/54dc427aaa6b4cb7d6203061",
"id": "54dc427aaa6b4cb7d6203061",
"name": "Cleveland Clinic"
},
"patient": {},
"plansOfCare": [],
"prescriptions": [],
"provider": {
"address": "1064 Goosetown Drive\nAsheville, NC 28801",
"departmentName": "Asheville Goosetown Laboratory",
"name": "LAB"
},
"reasons": [
"Ear Problem"
],
"source": "emr-1-320",
"testResults": [],
"updatedAt": "2014-10-19T21:33:19.971Z",
"visitType": "Office Visit",
"vitalSigns": []
}
]
# Get all encounters associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/medical/encounters"
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 |
dateTime | Date | (optional) The date of the encounter |
visitType | String | (optional) The type of visit |
provider | Object | (optional) The provider for the encounter (see provider object) |
prescriptions | Array[Object] | (optional) A list of prescriptions provided during the encounter (see link object) |
diagnoses | Array[Object] | (optional) A list of diagnoses for the encounter (see link object) |
vitals | Object | (optional) Vitals captured during the encounter (e.g. {"temperature" : 95.2 [degF]","weight" : 180 [lb_av]","height" : "69 [in_us]"}) |
vitalSigns | Array[Object] | (optional) A list of vital signs from the encounter (see link object) |
reasons | Array[String] | (optional) A list of reasons for the encounter (e.g. [‘Follow-up’, 'Consult’, 'DYSPHONIA', 'Back Pain’]) |
orders | Array[Object] | (optional) A list of medication orders for the patient (see orders object) |
testResults | Array[Object] | (optional) A list of test results for the patient (see link object) |
plansOfCare | Array[Object] | (optional) A list of plans of care from the encounter (see link object) |
medications | Array[Object] | (optional) A list of medications used by the patient. Objects in array can have some or many of the properties of medications. Common properties are "name", "productName", "startDate", "endDate", "instructions". |
followUpInstructions | String | (optional) Follow-up instructions |
patientInstruction | Object | (optional) Patient information (“name” and other optional attributes) |
organization | Object | (optional) See organizations object |
codes | Array[Object] | (optional) See codes |
Orders Object
Property | Type | Description |
---|---|---|
name | String | (optional) The name of the order |
codeType | String | (optional) The code type of the order (e.g. “CPT( R )”, “Custom”) |
expectedDate | Date | (optional) The date the order is expected |
expireDate | Date | (optional) The date the order expires |
procedureCode | String | (optional) The procedure code of the order |
type | String | (optional) The type of the order (e.g. “Lab”, “Procedures”) |
codes | Array[Object] | (optional) See codes |
Provider Object
Property | Type | Description |
---|---|---|
name | String | (optional) Name of the provider |
departmentName | String | (optional) Name of the provider department |
address | String | (optional) Address of the provider |
Link Object
Property | Type | Description |
---|---|---|
name | String | Name of the data element |
href | String | API path to the full data object |