Перейти до основного вмісту
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. Див. Повторні читання.

Відповіді з помилками