Przejdź do głównej treści
PATCH
Zaktualizuj adres dostawy, panel, metadane lub e-maile o gotowych wynikach dla zamówienia domowego zestawu testowego. Podaj tylko pola, które chcesz zmienić. Adres dostawy i panel możesz zmienić tylko wtedy, gdy zamówienie ma status pending, ponieważ fizyczny zestaw jest wysyłany w momencie nadania. Pole metadata służy do twojej własnej ewidencji i możesz je edytować przez cały cykl życia zamówienia. Nie ma endpointów do dodawania ani usuwania paneli: domowy zestaw testowy zawiera dokładnie jeden panel (odpowiada 1:1 fizycznemu zestawowi), więc jedyną sensowną operacją na panelu jest zamiana wykonywana tutaj. Wymaga zakresu home_kit_orders_manage.

Żądanie

Parametry ścieżki

string
wymagane
Unikalny identyfikator (UUID) zamówienia domowego zestawu testowego do aktualizacji.

Parametry treści

Wszystkie parametry w treści żądania są opcjonalne — podaj tylko pola, które chcesz zmienić.
object
Adres do wysyłki zestawu — w jednej z dwóch form: albo { location_id } wskazujące znaną lokalizację badań, albo pola adresu wpisane bezpośrednio (name, street, city, postal_code, country_code; opcjonalnie company_name / house_number / address_line_2 / state / phone / email — takie samo nazewnictwo jak w API lokalizacji). Podaj dokładnie jedną z tych opcji — odwołanie do lokalizacji albo pełny adres, nie obie.
Packstation lub Postfiliale (tylko Niemcy): ustaw street na Packstation lub Postfiliale, house_number na trzycyfrowy numer punktu, a address_line_2 na numer DHL Postnummer odbiorcy (6–10 cyfr, spacje dozwolone). Bez numeru Postnummer przesyłki nie można nadać. Postfach nie jest obsługiwany.
string
UUID panelu, który ma zastąpić obecny — przy dokładnie jednym panelu na zestaw zamiana jest jedyną sensowną operacją. Działa tylko wtedy, gdy zamówienie ma status pending, i tylko dla panelu skonfigurowanego przez Aniva z produktem zestawu do realizacji (w przeciwnym razie 422); zamiana na już przypisany panel nie wprowadza żadnych zmian.
object
Twoje własne pary klucz–wartość. Są łączone z istniejącymi metadanymi zamiast je zastępować: pominięte klucze zostają zachowane, klucz wysłany z wartością null jest usuwany, a pusty obiekt {} czyści wszystko. Limity są takie same jak w Utwórz zamówienie domowego zestawu testowego, a walidacja działa na zasadzie wszystko albo nic — jeśli którykolwiek klucz zostanie odrzucony, nic nie zostanie zapisane. Nigdy nie umieszczaj danych osobowych ani klinicznych w metadata — to pole nie jest traktowane jako dane pacjenta.
string[]
Zastępuje listę maksymalnie 5 adresów, z których każdy otrzyma jeden e-mail, gdy wszystkie wyniki laboratoryjne będą ostateczne. Wyślij [], aby wyłączyć powiadomienia. Pole można edytować w każdym statusie oprócz cancelled. Twój klucz musi mieć dostęp results_view do pacjenta — w przeciwnym razie zwróci 403. Zobacz E-maile o gotowych wynikach.

Odpowiedź

W przypadku powodzenia API zwraca 200 OK ze zaktualizowanym zamówieniem domowego zestawu testowego i jego osadzonym profilem.
string
wymagane
Unikalny identyfikator zamówienia domowego zestawu testowego (UUID).
string
wymagane
UUID profilu, do którego należy to zamówienie domowego zestawu testowego.
string
wymagane
Bieżący status zamówienia domowego zestawu testowego. Jedna z wartości: pending, dispatched, activated lub cancelled.
object
wymagane
Adres, na który ma zostać wysłany zestaw — w jednej z dwóch postaci: albo { location_id } wskazujące znaną lokalizację badań, albo pola adresu wpisane bezpośrednio (name, street, city, postal_code, country_code; pola company_name / house_number / address_line_2 / state / phone / email są opcjonalne — takie samo nazewnictwo jak w API lokalizacji). Podaj dokładnie jedną opcję — odniesienie do lokalizacji albo adres wpisany bezpośrednio, nie obie naraz.
string
Kod próbki w laboratorium, pod którym raportowane są wyniki — wydrukowany na fizycznym zestawie i odczytywany przez pacjenta z pudełka jako kod aktywacyjny. null do czasu spakowania zestawu. Tylko do odczytu.
string
wymagane
Znacznik czasu pobrania zgłoszony przez Aktywuj — moment, w którym pacjent pobrał próbkę. null do czasu aktywacji zestawu.
string
Zamówienie domowego zestawu testowego, które to zamówienie zastępuje, gdy jest to zestaw zastępczy. null w przypadku zwykłego zamówienia. Zobacz Utwórz zamówienie domowego zestawu testowego.
string
Powód wysłania zestawu zastępczego. null w przypadku zwykłego zamówienia.
string[]
wymagane
Adresy zapisane małymi literami, z których każdy otrzymuje jednego e-maila, gdy wszystkie wyniki laboratoryjne będą ostateczne. Puste, gdy wyłączone. Zobacz E-maile o gotowych wynikach.
object
wymagane
Pary klucz/wartość zdefiniowane przez partnera, zwracane w niezmienionej postaci. Pole jest zawsze obecne — {}, gdy nie ustawiono żadnych wartości.
string
wymagane
Znacznik czasu ISO 8601 utworzenia zamówienia domowego zestawu testowego.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość null.
object
wymagane
Profil pacjenta powiązany z tym zamówieniem domowego zestawu testowego.
HomeKitOrderPanel[]
wymagane
Panel przypisany do tego zamówienia domowego zestawu testowego — zawsze dokładnie jeden (domowy zestaw testowy odpowiada 1:1 fizycznemu zestawowi), zastępowany w miejscu po podaniu panel_id. Szczegóły panelu (nazwę, biomarkery) sprawdzisz przez Lista paneli.
HomeKitOrderIndividualBiomarker[]
wymagane
Pojedyncze biomarkery przypisane do tego zamówienia domowego zestawu testowego poza panelem. Dopasuj każde biomarker_id do danych z Wyświetl biomarkery z parametrem home_kit=true, aby uzyskać dane do wyświetlenia.
HomeKitOrderShipmentLink[]
wymagane
Przesyłki powiązane z tym zamówieniem domowego zestawu testowego, od najstarszego powiązania — zazwyczaj zestaw do pacjenta i próbka z powrotem do laboratorium. Lista jest pusta, dopóki dział realizacji nie wydrukuje etykiety. Pełne dane przesyłek odczytasz przez Wyświetl przesyłki z ?home_kit_order_id=.

Odpowiedzi z błędami