post
https://api.ornament.health/thesaurus-api/public/v1.0/diseases
Returns the dictionary of diseases used in Ornament.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request example
curl --location 'https://api.ornament.health/thesaurus-api/public/v1.0/diseases' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{"lang":"EN"}'
Request body
{
"lang": "EN"
}
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | Yes | Language used for disease titles. Example: EN. |
Supported languages: EN, DE, ES, PT, RU.
Response
Returns an object with updated metadata and the list of diseases.
Top-level response schema
| Field | Type | Required | Description |
|---|---|---|---|
needToUpdate | boolean | Yes | Indicates whether the client should refresh its cached diseases dictionary. |
diseases | array of objects | Yes | List of disease definitions. |
digest | string | Yes | Dictionary version hash. Can be used to detect changes. For more details, see the Digest documentation. |
Disease object schema
Each element in the diseases array describes one disease.
| Field | Type | Required | Description |
|---|---|---|---|
diseaseId | integer | Yes | Unique disease identifier. |
title | string | Yes | Disease title in the requested language. |
minProbability | number | Yes | Minimum probability threshold used by the Ornament platform. |
minRawScore | number | Yes | Minimum raw score threshold used by the Ornament platform. |
partId | integer | Yes | Identifier of the related body part or system. |
biomarkers | array of integers | Yes | List of biomarker IDs associated with the disease. |
directBiomarkers | array of integers | Yes | List of biomarker IDs directly associated with the disease (used by the Ornament platform). |
isPaid | integer | Yes | Paid access flag used by the Ornament platform. |
articleId | integer | No | Identifier of an article or content record (Ornament wiki) associated with the disease. |
isDiseaseHealthCondition | boolean | Yes | Indicates whether the entry is treated as a disease health condition in the platform. |
Notes
- This method returns only thesaurus data as used in Ornament.
- It does not return actual user medical data or diagnosed conditions.
- Biomarker IDs in
biomarkersanddirectBiomarkerscan be resolved using the biomarkers thesaurus method. - To check whether the diseases dictionary has changed, you can use the
digestfield. - If you already store a previously received digest, you can use it in the same way as described in the Digest documentation to determine whether a refresh is needed.
Bad request
Not found