Get a list of medical lab results for a user.
Return a list of medical test results:
GET https://api.humanapi.co/v1/human/medical/test_results
Return a single test result:
GET https://api.humanapi.co/v1/human/medical/test_results/{id}
# Returns a json array of test results:
[ {
"allResults": [ ],
"components": [
{
"codes": [],
"high": "8.3",
"low": "5.7",
"name": "Protein Total, Serum",
"unit": "g/dL",
"value": "7.1"
},
{
"codes": [],
"high": "5.0",
"low": "3.4",
"name": "Albumin (Serum)",
"unit": "g/dL",
"value": "4.3"
},
{
"codes": [],
"high": "3.9",
"low": "1.8",
"name": "Globulin Serum",
"unit": "g/dL",
"value": "2.8"
}
],
"codes": [
{
"codeSystem": "2.16.840.1.113883.6.1",
"codeSystemName": "LOINC",
"name": "DIAGNOSIS"
}
],
"createdAt": "2014-10-30T21:02:17.956Z",
"id": "546d44478a6d23e01a72865a",
"name": "LAB TOTAL PROTEIN+ALB",
"orderedBy": "James Kirk, MD",
"organization": {
"href": "/medical/organizations/53c050ac51c69003200aa998",
"id": "53c050ac51c69003200aa998",
"name": "Cleveland Clinic"
},
"patient": {
"name": "Maxwell Forrest"
},
"recipients": [
{
"isPCP": true,
"name": "Jean-Luc Picard, MD",
"objectID": "50006",
"recipTemplate": "WPMessageRecipientTemplateUnknown"
}
],
"resultDateTime": "2010-09-10T04:00:00.000Z",
"source": "emr-1-320",
"status": "Final result",
"updatedAt": "2014-10-20T21:02:17.956Z"
}]
# Get all test results associated with the user
curl -H "Authorization: Bearer demo" "https://api.humanapi.co/v1/human/medical/test_results"
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 |
components | Array[Object] | A list of components of the test (See component below) |
name | String | The name of the test preformed e.g. ‘COMPREHENSIVE METABOLIC PANEL’, 'LIPID PANEL’, 'URINE CULTURE’ |
device | String | (optional) Device name Note: presence of this value is rare |
patient | Object | Patient information (“name” and other optional attributes) |
specimen | String | (optional) Specimen related to the procedure Note: presence of this value is rare |
orderedBy | String | (optional) The name of the ordering physician or entity |
recipients | Array[Object] | (optional) See recipient object Note: presence of this value is rare |
resultDateTime | Date | (optional) The date of the test result |
status | String | (optional) The status of the test result (e.g. 'Final result’, 'Edited’, 'Edited Result - FINAL’) |
allResults | Array[Object] | [Deprecated] Use components instead |
comments | String | (optional) Comments for the test result |
narrative | String | (optional) Narrative for the test result |
impression | String | (optional) Impression for the test result |
transcriptions | String | (optional) Transcriptions for the test result |
organization | Object | See organizations object |
codes | Array[Object] | (optional) See codes |
Component Object
Property | Type | Description |
---|---|---|
name | String | (optional) The name of the test component (e.g. 'Potassium’, 'MCHC’, 'MCV’) |
value | String | (optional) The test result value |
unit | String | (optional) The unit of the value - e.g. 'mg/dL’, ’%’, 'mmol/L’ |
low | String | (optional) The low value for the component |
high | String | (optional) The high value for the component |
refRange | String | (optional) The reference range for the value - if provided (e.g. 'Negative’, ’>60’, ’<150’) |
componentComments | String | (optional) Comments provided for the component |
codes | Array[Object] | (optional) See codes |
Recipient Object
Property | Type | Description |
---|---|---|
objectID | String | The id of the recipient e.g. "856983" |
name | String | (optional) The name of the recipient |
isPCP | Boolean | (optional) Indicates if the provider is the Primary Care Provider of the user e.g. true |
recipTemplate | String | (optional) The recipient template e.g. 'WPMessageRecipientTemplateUnknown’ |