Документы
Получить результаты из документа
Получить статус и извлечённые лабораторные показатели загруженного тобой документа
GET
/
api
/
v1
/
documents
/
{id}
/
results
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
Прочитай статус и лабораторные значения документа, загруженного через
Загрузку документа. Ответ имеет ту же структуру, что и
Получение результатов анализов для записи. Все поля смотри в
Результатах.
Ответ возвращается только для документов, загруженных в группу профилей, из которой твой ключ
может читать результаты. Для всех остальных документов возвращается
404: их результаты читай
через запись или заказ набора для домашнего теста, по которому они получены.
Постоянно опрашивать API не нужно. Подпишись на вебхуки
document.results.updated или document.results.completed и вызывай этот эндпоинт при
получении события.
Требуется разрешение results_view для группы профилей, в которую был загружен документ.
Запрос
Параметры пути
Заголовки
Значение
ETag из предыдущего ответа. Если ничего не изменилось, API ответит 304 Not Modified
без тела.Ответ
При успехе API возвращает200 OK с объектом результатов и заголовком ETag.
Одно из значений:
in_progress— Aniva извлекает значения.completed— извлечение завершено.fault— ошибка извлечения.stored— в документе нет значений: он загружен безextract_resultsили не содержит лабораторных результатов. Статусstoredокончательный: вебхукdocument.results.completedне придет.
Извлеченные значения. У каждого значения указано
origin: partner_upload. Если в отчете
несколько дат сдачи образцов, каждое значение получает свое tested_at. Статуса planned не
бывает: загрузка ничего не заказывает.Ответы с ошибками
| Статус | Описание |
|---|---|
304 | Не изменено — значение etag в If-None-Match совпадает. Без тела. |
400 | Неверный формат ID. |
403 | У твоего API-ключа нет разрешения results_view. |
404 | Среди загруженных в твои группы профилей нет документа с таким ID. |
500 | Внутренняя ошибка сервера. |
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}