Přejít na hlavní obsah
GET
Načti seznam objednávek domácích testovacích sad. Objednávka domácí testovací sady zašle poštou sadu pro domácí odběr — Aniva sadu odešle, pacient si doma sám odebere vzorek a pošle ho poštou zpět. Každá objednávka domácí testovací sady obsahuje vložený profil pacienta. Když je zadané profile_id, vrátí všechny objednávky domácích testovacích sad pro daný profil. Když chybí, vrátí všechny dostupné objednávky domácích testovacích sad. Vyžaduje rozsah home_kit_orders_view nebo home_kit_orders_manage.

Požadavek

Parametry dotazu

string
Filtrovat podle UUID profilu. Když je zadané, vrátí se všechny objednávky domácích testovacích sad pro tento profil.
string
Filtrovat podle laboratorního kódu (přesná shoda) — dohledej k fyzické sadě její objednávku podle kódu, který je na ní vytištěný, např. před voláním Aktivovat.

Odpověď

Při úspěchu API vrátí 200 OK s polem objektů objednávek domácích testovacích sad.
string
povinné
Jedinečný identifikátor objednávky domácí testovací sady (UUID).
string
povinné
UUID profilu, ke kterému tato objednávka domácí testovací sady patří.
string
povinné
Aktuální stav objednávky domácí testovací sady. Jedna z hodnot pending, dispatched, activated nebo cancelled. Podrobný stav dokončení laboratorních výsledků zjistíš přes Získat výsledky.
object
povinné
Adresa pro doručení sady — jedna ze dvou podob: buď { location_id } s odkazem na známé testovací místo, nebo přímo vložená pole adresy (name, street, city, postal_code, country_code; nepovinně company_name / house_number / address_line_2 / state / phone / email — stejný slovník jako v locations API). Uveď přesně jednu variantu — odkaz na místo, nebo přímou adresu, ne obojí.
string
Laboratorní kód vzorku, pod kterým se hlásí výsledky — je vytištěný na fyzické sadě a pacient ho přečte z krabičky jako aktivační kód. null, dokud není sada zabalená. Pouze pro čtení.
string
povinné
Časové razítko odběru nahlášené přes Aktivace — kdy pacient odebral vzorek. null, dokud sada není aktivovaná.
string
Objednávka domácí testovací sady, kterou tato nahrazuje, pokud jde o náhradní sadu. null u běžné objednávky. Viz Vytvoření objednávky domácí testovací sady.
string
Důvod odeslání náhradní sady. null u běžné objednávky.
string[]
povinné
Adresy malými písmeny, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní výsledky konečné. Prázdné, když je vypnuto. Viz E-maily o připravených výsledcích.
object
povinné
Páry klíč/hodnota definované partnerem, vrácené beze změny. Vždy přítomné — {}, pokud nejsou nastaveny.
string
povinné
Časové razítko ve formátu ISO 8601, kdy byla objednávka domácí testovací sady vytvořena.
string
Časové razítko ISO 8601 poslední aktualizace. Může být null.
object
povinné
Profil pacienta spojený s touto objednávkou domácí testovací sady.
HomeKitOrderPanel[]
povinné
Panel přiřazený k této objednávce domácí testovací sady — vždy přesně jeden (domácí testovací sada odpovídá 1:1 fyzickému produktu sady), vyměnitelný přes Upravit, dokud je ve stavu pending. Podrobnosti o panelu (název, biomarkery) najdeš přes Seznam panelů.
HomeKitOrderIndividualBiomarker[]
povinné
Samostatné biomarkery přiřazené k této objednávce domácí testovací sady mimo jakýkoli panel. Každé biomarker_id si pro údaje k zobrazení dohledej přes Seznam biomarkerů s home_kit=true.
HomeKitOrderShipmentLink[]
povinné
Zásilky propojené s touto objednávkou domácí testovací sady, od nejstaršího propojení — obvykle sada k pacientovi a vzorek zpět do laboratoře. Prázdné, dokud expedice nevytiskne štítek. Úplné údaje o zásilkách načti přes Seznam zásilek s ?home_kit_order_id=.

Opakovaná volání

Aniva ukládá odpověď tohoto endpointu po dobu 5 minut pro každý API klíč. Opakované volání v tomto čase dostane uloženou odpověď. Hlavičky Cache-Status a Age ukazují, že je odpověď uložená a jak je stará. Pokud se chceš o změně dozvědět hned, přihlas se k odběru webhook událostí home_kit_order.created a událostí pro jednotlivé stavy, například home_kit_order.activated. Viz Opakované čtení.

Chybové odpovědi