Upcoming API Change: Removal of value Field in Lab Test Results
Last updated: September 2, 2025
Overview
The value field in our Lab Test Results API has been deprecated for some time and will now be completely removed on September 30th, 2025, at 9:00 AM EST.
To ensure continued functionality, you must update your integration to use the new result and type fields instead of value.
What's Changing
Previous Behavior (Deprecated)
Historically, the API returned lab test results via the value field:
{
"name": "Glucose",
"slug": "glucose",
"value": 5.2,
"unit": "mmol/L"
}However, this approach was limited, as many lab results include ranges or text-based interpretations, not just numbers.
New Behavior (Recommended)
We’ve introduced a new result field and a corresponding type field (ResultType) to support multiple types of lab results:
{
"name": "Glucose",
"slug": "glucose",
"result": "5.2",
"type": "NUMERIC",
"unit": "mmol/L"
}The
resultfield is always a string.The
typefield tells you how to interpret the result.
Supported Result Types
ResultTypeDescriptionExample | |||
| Numeric result |
| Use when the lab provides an exact number. |
| Range-based result |
| Covers values like |
| Textual or categorical result |
| Used when results are descriptive. |
Example JSON Responses
Numeric Result
{
"name": "Cholesterol",
"slug": "cholesterol",
"result": "180",
"type": "NUMERIC",
"unit": "mg/dL"
}Range Result
{
"name": "HIV Antibodies",
"slug": "hiv_antibodies",
"result": "<1.2",
"type": "RANGE",
"notes": "<1.2"
}Comment Result
{
"name": "COVID-19 PCR",
"slug": "covid19_pcr",
"result": "Positive",
"type": "COMMENT",
"notes": "Positive"
}Backwards Compatibility
Until September 30th, 2025, 9:00 AM EST:
The
valuefield will still be returned but will be set to-1for non-numeric results (RANGEorCOMMENT).After the removal date, the
valuefield will no longer be present in the API response.
Status Field Remains Unchanged
The status field is not affected by this change. It continues to indicate whether results are partial or final:
ResultStatus.PARTIAL→ Some biomarkers are available; others pending.ResultStatus.FINAL→ All results are complete and finalized.
Action Required
Update your integration to use
resultandtypeinstead ofvalue.Stop relying on the
valuefield, as it will be removed after September 30th, 2025.Make sure your parsing logic can handle numeric, range, and comment results seamlessly.
Timeline
DateChange | |
Now |
|
Until Sept 30, 2025 |
|
Sept 30, 2025 – 9:00 AM EST |
|
Need Help?
For questions or migration support, contact us at support@junction.com.