API Reference

Recognition Results

Biomarkers Data

The results are represented with a set set of Biomarkers and their reference values, that can be used for evaluation. For more information about the Biomarkers, see this section.

You can get the List of Biomarkers by the profile ID (PID) with the following request, and specify a time rage (dateFrom and dateTo) in the body.

{
  "notPermanentSubmissionsDateRange": {
    "dateFrom": "2024-01-10",
    "dateTo": "2024-04-10"
  }
}

The response contains data divided into three sections:

  • total - the number of biomarkers whose data are contained in the request;
  • biomarkers - an array of objects (0:N) of biomarkers. It also includes arrays of their values (entries - an array of objects (1:N) of biomarker values).
  • refs - a set of reference values for the obtained list of biomarkers. For each biomarker, there can be one or two ranges of reference values: normal (always) and optimal (may be absent).

Here is an example of the response with the list of Biomarkers and their details.

{
    "total": <number of biomarkers in the response>,
    "biomarkers": [
        {
            "id": <biomarker ID>,
            "categoryId": <biomarker category ID>,
            "status": "<biomarker status>",
            "entries": [
                {
                    "seid": "<UUID of the submission line>",
                    "sid": "<UUID of the submission>",
                    "value": "<biomarker value in internal units of measurement>",
                    "originalValue": "<biomarker value>",
                    "date": <UNIX timestamp of the submission date>,
                    "originalUnitId": <biomarker measurement unit ID>
                }
            ]
        },
        ],
    "refs": {
        "<biomarker ID>": {
            "common": [
                <float lower bound>,
                <float upper bound>
            ],
            "optimal": [
                <float lower bound>,
                <float upper bound>
            ],
            "paidOptimal": [
                <float lower bound>,
                <float upper bound>
            ]
        }
    }
}

You can also get the Biomarker by ID when necessary.

Getting the Biomarker Names

To obtain biomarker names, you can download them from the Thesaurus using the following API call.

To obtain the biomarker name in the desired language, include the lang field in the request body with one of the following values: RU, EN, PT, BR, or ES.

Submissions Data

You can retrieve the list of previously submitted files and their details with the following request.

The response contains data divided into three sections:

  • total - the number of submissions whose data are in the request;
  • submissions - an array of objects (0:1) of submissions. It also includes arrays of their values (lines).
  • refs - a set of reference values for the biomarkers in the obtained list of submissions. For each biomarker, you can have one or two ranges of reference values: normal (always) and optimal (may be absent).

Here is an example of the response with the list of Submissions and their details.

{
    "total": <number of submissions in the response>,
    "submissions": [
        {
            "pid": "<UUID of the profile>",
            "sid": "<UUID of the submission>",
            "date": <UNIX timestamp of the submission date>,
            "hasDate": true,
            "isDeleted": false,
            "originImagesetId": <ID of the original Imageset>,
            "entries": [
                {
                    "seid": "<UUID of the submission line>",
                    "value": "<Biomarker value in internal units of measurement>",
                    "rowOrder": <Sequential number of the line>,
                    "biomarkerId": <Biomarker ID>,
                    "originalValue": "<Biomarker value>",
                    "originalUnitId": <Biomarker measurement unit ID>
                }
            ],
            "mcdDiseases": [],
            "medicines": []
        }
    ],
    "refs": {
        "<Biomarker ID>": {
            "common": [
                <float lower bound>,
                <float upper bound>
            ],
            "optimal": [
                <float lower bound>,
                <float upper bound>
            ],
            "paidOptimal": [
                <float lower bound>,
                <float upper bound>
            ]
        }
    }
}

You can also get the Submission by ID when necessary.

Health Condition Data

The response contains data about Health Condition that is divided into three sections:

Scores: Each score entry provides insights into specific health metrics, including a unique identifier (scoreId), effective date, the actual score value, and statistical data related to the score.

Scores play a crucial role in assessing the patient's health condition based on lab results and biomarkers. Healthcare professionals can leverage these scores to monitor trends over time, identify abnormalities, and make informed clinical decisions. The statistical data accompanying each score provides valuable insights into the sample size, missed data points, and the impact of the score on affected and unaffected individuals.

Score Traces: Score traces offer a detailed view of the biomarkers associated with each score. They include identifiers for both the score and the biomarker, along with additional attributes such as whether the biomarker is considered an actual score and its expiration date.

Score traces offer granular insights into the specific biomarkers contributing to each score. By examining biomarker data, healthcare professionals can pinpoint underlying health issues, track disease progression, and tailor treatment plans accordingly.

Diseases: provides information related to probable diseases or health conditions associated with the patient.

You can get the Health Condition data by PID .