Przejdź do głównej treści
GET
Pobierz listę zamówień domowych zestawów testowych. Zamówienie domowego zestawu testowego wysyła zestaw do samodzielnego badania w domu — Aniva wysyła zestaw, pacjent samodzielnie pobiera próbkę w domu i odsyła ją pocztą. Każde zamówienie domowego zestawu testowego zawiera osadzony profil pacjenta. Gdy podasz profile_id, zwraca wszystkie zamówienia domowych zestawów testowych dla tego profilu. Gdy go pominiesz, zwraca wszystkie dostępne zamówienia domowych zestawów testowych. Wymaga zakresu home_kit_orders_view lub home_kit_orders_manage.

Żądanie

Parametry zapytania

string
Filtruj według UUID profilu. Po podaniu zwracane są wszystkie zamówienia domowych zestawów testowych dla tego profilu.
string
Filtruj według kodu laboratoryjnego (dokładne dopasowanie) — powiąż fizyczny zestaw z jego zamówieniem na podstawie kodu wydrukowanego na zestawie, np. przed wywołaniem Aktywuj.

Odpowiedź

W razie powodzenia API zwraca 200 OK z tablicą obiektów zamówień domowych zestawów testowych.
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. Szczegółowy stan realizacji wyników laboratoryjnych pochodzi z Pobierz wyniki.
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 produktowi zestawu), możliwy do zmiany przez Zaktualizuj, dopóki ma status pending. Szczegóły panelu (nazwa, biomarkery) sprawdzisz w Wyświetl panele.
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=.

Powtarzane wywołania

Aniva przechowuje odpowiedź tego punktu końcowego przez 5 minut dla każdego klucza API. Ponowne wywołanie w tym czasie zwraca zapisaną odpowiedź. Nagłówki Cache-Status i Age pokazują, że odpowiedź jest zapisana i jaki jest jej wiek. Aby dowiedzieć się o zmianie od razu, zasubskrybuj zdarzenia webhooka home_kit_order.created oraz zdarzenie dla każdego statusu, na przykład home_kit_order.activated. Zobacz Powtarzane odczyty.

Odpowiedzi z błędami