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": "Sex Horm Binding Glob, Serum",
"slug": "sex-horm-binding-glob-serum",
"value": 30.4,
"result": "30.4",
"type": "numeric",
"unit": "nmol/L",
"timestamp": "2024-10-31T09:08:00+00:00",
"notes": "Final",
"min_range_value": 24.6,
"max_range_value": 122,
"is_above_max_range": false,
"is_below_min_range": false,
"interpretation": "normal",
"loinc": "13967-5",
"loinc_slug": "sex-hormone-binding-globulin-moles-vol",
"provider_id": "082016",
"source_markers": [
{
"marker_id": 229,
"name": "Testosterone Free, Profile I",
"slug": "testosterone-free-profile-i",
"provider_id": "140226"
}
]
}
]
}
Return both metadata and raw json test data
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": "Sex Horm Binding Glob, Serum",
"slug": "sex-horm-binding-glob-serum",
"value": 30.4,
"result": "30.4",
"type": "numeric",
"unit": "nmol/L",
"timestamp": "2024-10-31T09:08:00+00:00",
"notes": "Final",
"min_range_value": 24.6,
"max_range_value": 122,
"is_above_max_range": false,
"is_below_min_range": false,
"interpretation": "normal",
"loinc": "13967-5",
"loinc_slug": "sex-hormone-binding-globulin-moles-vol",
"provider_id": "082016",
"source_markers": [
{
"marker_id": 229,
"name": "Testosterone Free, Profile I",
"slug": "testosterone-free-profile-i",
"provider_id": "140226"
}
]
}
]
}
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": "Sex Horm Binding Glob, Serum",
"slug": "sex-horm-binding-glob-serum",
"value": 30.4,
"result": "30.4",
"type": "numeric",
"unit": "nmol/L",
"timestamp": "2024-10-31T09:08:00+00:00",
"notes": "Final",
"min_range_value": 24.6,
"max_range_value": 122,
"is_above_max_range": false,
"is_below_min_range": false,
"interpretation": "normal",
"loinc": "13967-5",
"loinc_slug": "sex-hormone-binding-globulin-moles-vol",
"provider_id": "082016",
"source_markers": [
{
"marker_id": 229,
"name": "Testosterone Free, Profile I",
"slug": "testosterone-free-profile-i",
"provider_id": "140226"
}
]
}
]
}
Vital Team API Key
Successful Response
Show child attributes
{
"age": 19,
"clia_number": "12331231",
"date_collected": "2022-02-02",
"date_received": "2022-01-01",
"date_reported": "2020-01-01",
"dob": "18/08/1993",
"interpretation": "normal",
"laboratory": "Quest Diagnostics",
"patient": "Bob Smith",
"provider": "Dr. Jack Smith",
"specimen_number": "123131",
"status": "final"
}Represent the schema for an individual biomarker result.
Show child attributes
ℹ️ This enum is non-exhaustive.
numeric, range, comment Deprecated: Use 'result' (string) and type (enum) instead.
{
"interpretation": "normal",
"is_above_max_range": false,
"is_below_min_range": false,
"loinc": "742-7",
"loinc_slug": "monocytes-auto-bld-vol",
"max_range_value": 0.9,
"min_range_value": 0.1,
"name": "Monocytes(Absolute)",
"notes": "Final",
"result": "0.4",
"slug": "monocytes-absolute",
"timestamp": "2023-11-01T08:28:00+00:00",
"type": "numeric",
"unit": "x10E3/uL",
"value": 0.4
}Show child attributes
ℹ️ This enum is non-exhaustive.
quantity_not_sufficient_failure, collection_process_failure, drop_off_failure, internal_lab_failure, order_entry_failure, non_failure, unknown_failure, patient_condition_failure, missing_result_calc_failure, missing_demo_aoe_calc_failure, insufficient_volume Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?