Results
Get Results
- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
Users
Introspection
Orders
At-home Phlebotomy
Tests
Results
Health Insurance
Sleep
Meal
Workouts
Profile
Activity
Body
Vitals
Body
Activity
Wellness
Nutrition
Core
Lab Testing
Summary Data
Timeseries Data
Results
Get Results
Return both metadata and raw json test data
GET
/
v3
/
order
/
{order_id}
/
result
x-vital-api-key
string
*
x-vital-api-key
Required
string
API key based authentication
order_id
Order Id ยท string
*
order_id
Required
string
curl --request GET \
--url '{{BASE_URL}}/v3/order/<order_id>/result' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}'
{
"metadata": {
"age": 19,
"dob": "18/08/1993",
"clia_number": "12331231",
"patient": "Bob Smith",
"provider": "Dr. Jack Smith",
"laboratory": "LabCorp",
"date_reported": "2020-01-01",
"date_collected": "2022-02-02",
"specimen_number": "123131",
"date_received": "2022-01-01"
"status": "final",
"interpretation": "abnormal"
},
"results": [
{
"name": "Hemoglobin",
"slug": "hemoglobin",
"unit": "g/dL",
"notes": null,
"value": 18.9, # deprecated
"timestamp": null,
"max_range_value": 17.7,
"min_range_value": 13.0,
"is_above_max_range": true,
"is_below_min_range": false,
"interpretation": "abnormal",
"result": "18.90",
"type": "numeric",
"loinc": "0001-1",
"loinc_slug": "hemoglobin-mass-vol"
},
{
"name": "Sodium",
"slug": "unknown",
"unit": "mmol/L",
"notes": null,
"value": 136, # deprecated
"timestamp": null,
"max_range_value": 144,
"min_range_value": 134,
"is_above_max_range": false,
"is_below_min_range": false,
"interpretation": "normal",
"result": "136",
"type": "numeric",
"loinc": "0001-2",
"loinc_slug": "sodium"
}
]
}
Authorizations
x-vital-api-key
string
headerrequiredAPI key based authentication
Path Parameters
order_id
string
requiredResponse
200 - application/json
metadata
object
requiredmetadata.age
string
requiredmetadata.clia_#
string
metadata.date_collected
string
metadata.date_received
string
metadata.date_reported
string
requiredmetadata.dob
string
requiredmetadata.interpretation
string
metadata.laboratory
string
metadata.patient
string
requiredmetadata.provider
string
metadata.specimen_number
string
requiredmetadata.status
string
default: finalresults
required
results.interpretation
string
default: normalresults.is_above_max_range
boolean
results.is_below_min_range
boolean
results.loinc
string
results.loinc_slug
string
results.max_range_value
number
results.min_range_value
number
results.name
string
requiredresults.notes
string
results.result
string
requiredresults.slug
string
default: results.timestamp
string
results.type
enum<string>
requiredAn enumeration.
Available options:
numeric
, range
, comment
results.unit
string
results.value
number
requiredcurl --request GET \
--url '{{BASE_URL}}/v3/order/<order_id>/result' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}'
{
"metadata": {
"age": 19,
"dob": "18/08/1993",
"clia_number": "12331231",
"patient": "Bob Smith",
"provider": "Dr. Jack Smith",
"laboratory": "LabCorp",
"date_reported": "2020-01-01",
"date_collected": "2022-02-02",
"specimen_number": "123131",
"date_received": "2022-01-01"
"status": "final",
"interpretation": "abnormal"
},
"results": [
{
"name": "Hemoglobin",
"slug": "hemoglobin",
"unit": "g/dL",
"notes": null,
"value": 18.9, # deprecated
"timestamp": null,
"max_range_value": 17.7,
"min_range_value": 13.0,
"is_above_max_range": true,
"is_below_min_range": false,
"interpretation": "abnormal",
"result": "18.90",
"type": "numeric",
"loinc": "0001-1",
"loinc_slug": "hemoglobin-mass-vol"
},
{
"name": "Sodium",
"slug": "unknown",
"unit": "mmol/L",
"notes": null,
"value": 136, # deprecated
"timestamp": null,
"max_range_value": 144,
"min_range_value": 134,
"is_above_max_range": false,
"is_below_min_range": false,
"interpretation": "normal",
"result": "136",
"type": "numeric",
"loinc": "0001-2",
"loinc_slug": "sodium"
}
]
}