Перейти до основного вмісту
GET
Отримай одне замовлення набору для домашнього тесту за його UUID разом із вбудованим профілем пацієнта. Використовуй цей ендпоїнт, щоб перевірити статус замовлення, переглянути адресу доставки або оглянути додані панелі й біомаркери. Потрібен дозвіл home_kit_orders_view або home_kit_orders_manage.

Запит

Параметри шляху

string
обов'язково
Унікальний ідентифікатор (UUID) замовлення набору для домашнього тесту, яке потрібно отримати.

Відповідь

У разі успіху API повертає 200 OK із замовленням набору для домашнього тесту та його вбудованим профілем.
string
обов'язково
Унікальний ідентифікатор замовлення набору для домашнього тесту (UUID).
string
обов'язково
UUID профілю, якому належить це замовлення набору для домашнього тесту.
string
обов'язково
Поточний статус замовлення набору для домашнього тесту. Одне зі значень: pending, dispatched, activated або cancelled. Детальний стан готовності лабораторних результатів визначається через Отримати результати.
object
обов'язково
Адреса для надсилання набору поштою — один із двох форматів: або { location_id } із посиланням на відому локацію тестування, або вбудовані поля адреси (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email необов’язкові — ті самі поля, що й у API локацій). Укажи рівно один варіант — посилання на локацію або вбудовану адресу, не обидва.
string
Код зразка в лабораторії, за яким формуються результати — надрукований на фізичному наборі, саме його пацієнт зчитує з коробки як код активації. null, доки набір не спаковано. Лише для читання.
string
обов'язково
Часова мітка забору, передана через Активувати — коли пацієнт зібрав зразок. null, доки набір не активовано.
string
Замовлення набору для домашнього тесту, яке замінює це замовлення, якщо це набір на заміну. null для звичайного замовлення. Див. Створити замовлення набору для домашнього тесту.
string
Причина відправлення заміни. null для звичайного замовлення.
string[]
обов'язково
Електронні адреси в нижньому регістрі, на кожну з яких надходить один лист, коли всі лабораторні результати стають остаточними. Порожньо, якщо вимкнено. Див. Листи про готовність результатів.
object
обов'язково
Визначені партнером пари ключ/значення, що повертаються без змін. Завжди присутнє — {}, якщо не задано.
string
обов'язково
Часова мітка ISO 8601 створення замовлення набору для домашнього тесту.
string
Часова мітка ISO 8601 останнього оновлення. Може бути null.
object
обов'язково
Профіль пацієнта, пов’язаний із цим замовленням набору для домашнього тесту.
HomeKitOrderPanel[]
обов'язково
Панель, додана до цього замовлення набору для домашнього тесту — завжди рівно одна (набір для домашнього тесту відповідає фізичному набору 1:1); її можна замінити через Оновити, поки статус pending. Переглянь деталі панелі (назву, біомаркери) через Список панелей.
HomeKitOrderIndividualBiomarker[]
обов'язково
Окремі біомаркери, додані до цього замовлення набору для домашнього тесту поза панеллю. Звір кожен biomarker_id у Списку біомаркерів із home_kit=true, щоб отримати дані для відображення.
HomeKitOrderShipmentLink[]
обов'язково
Посилки, пов’язані з цим замовленням набору для домашнього тесту, від найдавнішої — зазвичай це набір до пацієнта та зразок назад до лабораторії. Порожній, доки склад не роздрукує етикетку. Переглянь повні дані посилок через Список відправлень із ?home_kit_order_id=.

Повторні виклики

Aniva зберігає відповідь цього ендпоїнта протягом 60 хвилин для кожного API-ключа. Повторний виклик у цей час отримує збережену відповідь, доки замовлення набору для домашнього тесту не змінилося. Після зміни ти отримаєш свіжу відповідь. Заголовки Cache-Status і Age показують, що відповідь збережена і як давно її збережено. Щоб дізнаватися про зміни одразу, підпишись на події вебхуків home_kit_order.created і подію для кожного статусу, наприклад home_kit_order.activated. Див. Повторні читання.

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