Health Conditions Explainer

HTTP Method: POST

Parameters

Name	Type	Required	Description
code	string	Yes	The text code of the condition type for which an explanation is requested.
human_part_id	integer	Yes	The identifier of the body part for which the condition was identified (see reference).
locale	string	Yes	Two-letter language code for the explanation. Supported values: `EN`, `DE`, `PT`, `ES`, `RU`.

Request Body Example

{
  "code": "SUGGESTION_GOOD_NO_SPECIFIC_LITTLE_DATA",
  "human_part_id": 43,
  "locale": "EN"
}

Response Structure

The response is a JSON file containing explainer object.

An explainer object describes:

What the condition type means as applied to a specific body part.
Recommendations for what the patient could do about it.

Objects

Attribute	Type	Description
code	string	The text code of the condition type for which an explanation is provided.
explainer	object	Nested object containing the extended explanation.

explainer object

Attribute	Type	Description
humanPartId	integer	Identifier of the body part to which the explanation refers (see reference).
title	string	Title of the explanation in the requested language.
message	string	Extended explanation in the requested language.

Sample Response

{
  "code": "SUGGESTION_WEAK_SPECIFIC_BAD_DISEASE",
  "explainer": {
    "humanPartId": 42,
    "title": "Results deviate significantly from reference values",
    "message": "The test results suggest abnormalities in liver functions. See a hepatologist to find out what’s causing the abnormalities."
  }
}