This endpoint returns the list of biomarkers, whose values have been recorded for a specific user profile (PID), and their reference values.
Sample Response
{
"total": 143,
"biomarkers": [
{
"id": 21,
"categoryId": 10,
"isUnitless": false,
"status": "N",
"entries": [
{
"seid": "c7bdd15d-596c-475c-8e6c-e21ac98d0d4e",
"sid": "b9efa122-ed77-4335-b324-60b49f786d16",
"value": "18210.0",
"originalValue": "18.21",
"date": 1614733200,
"originalUnitId": 9
}
]
}
"refs": {
"215": {
"common":
[
0.1476,
0.8116
],
"optimal": [],
"paidOptimal":
[
0.4021,
0.8116
]
}
}
}
Converting Biomarker Values Between Different Measurement Units
In laboratory reports, biomarker values can come in various measurement units (“units”). Ornament provides a directory of measurement units, which can be accessed here. Each measurement unit has its own ID.
For each biomarker, Ornament uses a specific measurement unit as a default. Therefore, it is necessary to convert the biomarker value from its original measurement unit into the default one.
In the description of every biomarker, there is an attribute called unitsFactor[unitID,unitsFactorValue]. unitID is the ID of a measurement unit, and unitsFactorValue is the factor by which the biomarker’s original value must be multiplied to convert it into the default value, using the system’s default measurement unit.
Here is a sample submission entry:
{
"seid": "c7bdd15d-596c-475c-8e6c-e21ac98d0d4e",
"sid": "b9efa122-ed77-4335-b324-60b49f786d16",
"value": "18210.0",
"originalValue": "18.21",
"date": 1614733200,
"originalUnitId": 9,
}
OriginalUnitID and originalValue refer to the biomarker’s value as received from the lab report.
value (i.e., the default value) is calculated by multiplying originalValue by the unitsFactor corresponding to originalUnitId (in this case, unitsFactor[9, 1000]):
originalValue × unitsFactor(unitId) = value
To convert the default value back into originalValue, divide value by the unitsFactor for the original unit:
value ÷ unitsFactor(unitId) = originalValue
{
"id": 1,
"title": "ALT",
"synonyms": [
{
"title": "Alanine aminotransferase",
"language": "EN"
},
{
"title": "GPT",
"language": "EN"
},
{
"title": "Glutamic Pyruvate Transaminase",
"language": "EN"
}
],
"possibleValueMax": 1500.0,
"possibleValueMin": 0.0,
"isAllowAutounit": true,
"biomaterialId": 2,
"displayCategoryId": 16,
"pregnancyCorrelation": 0,
"sortOrder": 3896,
"isPaid": true,
"articleId": 1,
"unitsFactors": [
[
10,
60000000.0
],
[
13,
60.0
],
[
8,
1.0
],
[
127,
0.06
],
[
128,
0.06
],
[
129,
60.0
],
[
130,
1000.0
],
[
131,
0.0166667
],
[
132,
16.6667
],
[
52,
1.0
]
],
"isUnitless": false
},