Перейти к основному содержанию
GET
Получи клинические и генетические лабораторные результаты по записи вместе со ссылками на PDF-файлы лабораторных отчётов. В ответе отображается каждый биомаркер, заказанный для этой записи, поэтому ты можешь отслеживать весь заказ, а не только уже готовые показатели. Проверяй status каждого результата, прежде чем использовать его value:
  • Анализы, которые ещё не готовы, отображаются со статусом planned, пока запись находится в статусе in_progress.
  • Результаты, которые лаборатория передала, но которые нельзя использовать клинически, имеют статус fault или undeliverable и содержат поле status_reason с объяснением причины. У результата со статусом fault поле value всё равно заполнено — это значение неверное. Никогда не показывай его как результат анализа.
  • Результаты, в которых сомневается Aniva или участник, имеют статус likely_wrong и поле status_reason. Значение не подтверждено. Не показывай его как результат анализа без проверки.
Каждый полученный результат и документ содержит lab_code (штрихкод пробирки), под которым он был зарегистрирован, а массив submissions перечисляет каждое лабораторное направление этого забора крови с его собственным статусом — забор крови с несколькими пробирками или лабораториями завершается направление за направлением. Используй Скачать документ, чтобы загрузить PDF-файлы лабораторных отчётов, указанные в массиве documents. Тебе не нужно опрашивать этот эндпоинт. Подпишись на вебхуки appointment.results.updated или appointment.results.completed и вызывай эндпоинт при получении события. Опрос всё равно работает как запасной вариант. Требуется право доступа results_view.

Запрос

Параметры пути

string
обязательно
Уникальный идентификатор (UUID) записи, для которой нужно получить результаты.

Ответ

При успехе API возвращает 200 OK с объектом результатов.
string
обязательно
Общий статус результатов. Одно из значений:
  • in_progress — часть направлений ещё находится в лаборатории.
  • completed — все направления закрыты, и хотя бы по одному пришёл отчёт.
  • fault — все направления завершились ошибкой без отчёта. Больше ничего не ожидается.
object[]
обязательно
По одному элементу на каждое лабораторное направление — у забора крови с несколькими пробирками или лабораториями их несколько. Верхнеуровневый status становится completed, как только все элементы закрыты и по одному из них пришёл отчёт.
object[]
обязательно
Массив результатов клинических биомаркеров.
object[]
обязательно
Массив результатов генетических биомаркеров.
object[]
обязательно
Документы лабораторных отчётов. Используй GET /api/v1/documents/{id}, чтобы скачать каждый файл.

Повторные вызовы

Aniva хранит ответ этого эндпоинта 60 минут для каждого API-ключа. Повторный запрос в течение этого времени получает сохранённый ответ, пока запись и её результаты не изменились. После изменения ты получишь свежий ответ. Заголовки Cache-Status и Age показывают, что ответ сохранён, и как давно он получен. Чтобы узнавать об изменениях сразу, подпишись на вебхук-события appointment.results.updated, appointment.results.completed и appointment.results.fault. См. Повторные чтения.

Ответы с ошибками