Returns Ornament thesaurus data for human parts and condition-specific groupings
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Request example
curl --location 'https://sandbox-api.ornament.health/thesaurus-api/public/v1.0/health-advisor/human-parts?lang=EN' \
--header 'Authorization: ••••••'
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| lang | string | Yes | Language used for titles. Example: EN. |
Supported languages: EN, DE, ES, PT, RU.
Response
Returns an object with:
common: standard human-part dictionariesconditions: condition-specific dictionaries and records
Top-level response schema
| Field | Type | Required | Description |
|---|---|---|---|
| common | array of objects | Yes | List of common human-part definitions used by the health advisor. |
| conditions | array of objects | Yes | List of condition-specific health-advisor definitions. |
Common human-part object schema
Each element in the common array describes one body part / system.
| Field | Type | Required | Description |
|---|---|---|---|
| partId | integer | Yes | Unique identifier of the body part / system. |
| title | string | Yes | Human-part title in the requested language. |
| language | string | Yes | Language of the title. |
| circleRadius | integer | Yes | UI-related radius value used by the Ornament platform. |
| biomarkers | array of integers | Yes | List of biomarker IDs related to this part. |
| doctorTitle | string | Yes | Specialist title associated with the part. |
| biomarkersDetails | array of objects | Yes | Detailed biomarker metadata for the part. |
| isUnsupported | boolean | Yes | Indicates whether this part is unsupported in the Ornament platform. |
biomarkersDetails object schema
biomarkersDetails object schemaEach element in biomarkersDetails describes one biomarker linked to a part.
| Field | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Biomarker ID. |
| isVisible | boolean | Yes | Indicates whether the biomarker is shown in the platform UI. |
| isSpecific | boolean | Yes | Indicates whether the biomarker is treated as specific for the part. |
Condition object schema
Condition object schemaEach element in the conditions array describes one condition-specific configuration.
| Field | Type | Required | Description |
|---|---|---|---|
| partId | integer | Yes | Unique identifier of the condition group. |
| title | string | Yes | Condition title. |
| biomarkerGroups | array of objects | Yes | Optional biomarker group definitions used inside the condition. |
| biomarkersDetails | array of objects | Yes | Detailed biomarker metadata for the condition. |
| records | array of objects | Yes | Record definitions associated with the condition. |
Note
Human parts and conditions are two different kinds of dictionary entities.
A human part is a general body system or anatomical area used as a stable category in the health advisor.
Examples from the response are Blood, Hormones, Liver, Cardiovascular system, Urogenital system, Immunity, Digestion, Nerves, and Respiratory system.
A condition is a specialized workflow/configuration layer for a particular health context (ex. Post-COVID)
Response example
{
"common": [
{
"partId": 40,
"title": "Blood",
"language": "EN",
"circleRadius": 80,
"biomarkers": [2, 4, 5],
"doctorTitle": "hematologist",
"biomarkersDetails": [
{
"id": 5413,
"isVisible": true,
"isSpecific": false
},
{
"id": 190,
"isVisible": true,
"isSpecific": true
}
],
"isUnsupported": false
}
],
"conditions": [
{
"partId": 53,
"title": "Post-COVID",
"biomarkerGroups": [
{
"id": "groupA",
"title": "Group A"
}
],
"biomarkersDetails": [
{
"id": 228,
"isVisible": true,
"isSpecific": false,
"groups": ["groupX", "groupZ", "groupA"]
}
],
"records": [
{
"recordTypeId": 1,
"recordTypeTitle": "started_at",
"subtype": "param",
"required": true,
"title": "Disease start day"
}
]
}
]
}
Note
- This method returns only Ornament thesaurus / configuration data used by the health advisor.
It does not return actual user medical data. - Biomarker IDs in biomarkers, biomarkersDetails, and condition groupings can be resolved via the biomarkers thesaurus method.
- CircleRadius, doctorTitle, visibility flags, specificity flags, biomarker groups, and records are platform metadata used by Ornament health-advisor logic and UI.
Bad request
Not found