Перейти до основного вмісту
PATCH
Онови адресу доставки, панель, метадані або адреси для листів про готовність результатів у замовленні набору для домашнього тесту. Вказуй лише ті поля, які хочеш змінити. Адресу доставки та панель можна змінити лише поки замовлення має статус pending, оскільки фізичний набір надсилається під час відправлення. metadata — це твої власні службові дані, і їх можна змінювати протягом усього життєвого циклу замовлення. Ендпоїнтів для додавання чи видалення панелі немає: набір для домашнього тесту містить рівно одну панель (вона відповідає фізичному продукту набору 1:1), тож єдина доречна операція з панеллю — це заміна, яку ти виконуєш тут. Потребує області доступу home_kit_orders_manage.

Запит

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

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

Параметри тіла запиту

Усі параметри тіла запиту необов’язкові — передай лише ті поля, які хочеш змінити.
object
Адреса для надсилання набору — в одному з двох форматів: або { location_id } із посиланням на відому локацію тестування, або вбудовані поля адреси (name, street, city, postal_code, country_code; необов’язкові: company_name / house_number / address_line_2 / state / phone / email — ті самі назви полів, що й у locations API). Передай рівно один варіант — посилання на локацію або вбудовану адресу, не обидва.
Packstation або Postfiliale (лише для Німеччини): вкажи в street значення Packstation або Postfiliale, у house_number — тризначний номер станції, а в address_line_2 — DHL Postnummer отримувача (6–10 цифр, пробіли дозволені). Без Postnummer посилку неможливо оформити. Postfach не підтримується.
string
UUID панелі, яку потрібно прив’язати замість поточної — оскільки на один набір припадає рівно одна панель, заміна є єдиною доречною операцією. Доступно лише поки замовлення має статус pending і лише для панелі, для якої Aniva налаштувала продукт набору для відправлення (інакше 422); заміна на вже прив’язану панель нічого не змінює.
object
Твої власні пари ключ/значення. Об’єднуються з наявними метаданими, а не замінюють їх: пропущені ключі зберігаються, ключ зі значенням null видаляється, а порожній об’єкт {} очищає все. Обмеження такі самі, як у Створити замовлення набору для домашнього тесту, а валідація працює за принципом усе або нічого — якщо відхилено бодай один ключ, нічого не записується. Ніколи не додавай персональні чи клінічні дані в metadata — вони не обробляються як дані пацієнта.
string[]
Замінює список до 5 адрес, на кожну з яких надходить один лист, коли всі лабораторні результати готові остаточно. Передай [], щоб вимкнути листи. Можна змінювати в будь-якому статусі, крім cancelled. Твій ключ повинен мати доступ results_view до пацієнта, інакше повернеться 403. Див. Листи про готовність результатів.

Відповідь

У разі успіху 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), замінюється на місці, коли ти передаєш panel_id. Деталі панелі (назву, біомаркери) можна переглянути через Список панелей.
HomeKitOrderIndividualBiomarker[]
обов'язково
Окремі біомаркери, додані до цього замовлення набору для домашнього тесту поза панеллю. Звір кожен biomarker_id у Списку біомаркерів із home_kit=true, щоб отримати дані для відображення.
HomeKitOrderShipmentLink[]
обов'язково
Посилки, пов’язані з цим замовленням набору для домашнього тесту, від найдавнішої — зазвичай це набір до пацієнта та зразок назад до лабораторії. Порожній, доки склад не роздрукує етикетку. Переглянь повні дані посилок через Список відправлень із ?home_kit_order_id=.

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