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

Запрос

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

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 показывают, что ответ сохранён и как давно. Чтобы узнавать об изменениях сразу, подпишись на события вебхуков home_kit_order.results.updated, home_kit_order.results.completed и home_kit_order.results.fault. См. Повторные запросы.

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