Přejít na hlavní obsah
POST
Zadej objednávku domácí testovací sady pro profil pacienta. Objednávka domácí testovací sady odešle sadu pro domácí odběr poštou – Aniva ji pošle na doručovací adresu, pacient si doma sám odebere vzorek a pošle ho zpět. Liší se od termínu, což je žilní odběr krve na odběrovém místě. Je potřeba přesně jeden panel. Domácí testovací sada odpovídá 1:1 fyzické sadě – panel je samotná sada – a objednávka se hned po vytvoření zařadí do fronty k balení, takže složení musí být finální hned od začátku. Dokud je objednávka ve stavu pending, můžeš panel ještě vyměnit přes Aktualizovat objednávku domácí testovací sady.

Náhradní sady

Když sada nemůže dodat výsledky – pacient nedokázal naplnit zkumavku, vzorek dorazil s příliš malým množstvím materiálu, laboratoř ho nemohla analyzovat – objednej náhradu odesláním replaces_home_kit_order_id. Náhrada je nová objednávka s novým laboratorním kódem, a to i v případě, že první sada nebyla nikdy aktivována: laboratoř potřebuje novou žádanku a dva vzorky pod jedním kódem od sebe nejde rozlišit. Nahrazovaná objednávka zůstává beze změny – ponechá si svůj stav, vlastní laboratorní kód i všechny výsledky, které už k ní byly přiřazeny. Z toho plynou dvě věci:
  • Panel se dědí. Vynech panel_id a náhrada převezme panel nahrazované objednávky, což odpovídá tomu, co si pacient koupil a jak je krabička označená.
  • Zvolíš si, co se znovu otestuje. Pošli biomarker_ids s markery, které selhaly, a laboratoř znovu otestuje jen ty, takže se v sadě odešlou jen potřebné zkumavky. Když pole vynecháš, znovu se otestuje celý panel.
Markery se znovu testují po skupinách v rámci panelu, ne jeden po druhém. Když uvedeš jeden marker ze skupiny, znovu se otestuje celá skupina, protože nelze zadat laboratorní objednávku, která by vyhodnotila víc, než bylo požadováno. Náhrada pro jeden marker proto může dorazit s více než jedním výsledkem a počet zkumavek může být větší, než by seznam markerů napovídal. Pro jednu sadu může být na cestě vždy jen jedna náhrada.
Pokud máš integraci z doby, kdy tato pole ještě neexistovala, Aniva při vytváření čte také metadata.original_kit_id a metadata.replacement_reason a zpracuje objednávku jako náhradu. Je to jediné místo, kde se metadata interpretují – slouží jen pro zachování této starší integrace a výše uvedená pole mají vždy přednost. Posílej tato pole.
Stav 201 znamená, že objednávka je závazně přijata a bude předána k expedici – pro zabalení a odeslání sady už nemusíš dělat nic dalšího. Vyžaduje scope home_kit_orders_manage. Odešli volitelnou hlavičku Idempotency-Key, aby šlo toto vytvoření bezpečně zopakovat — opakované použití stejného klíče vrátí původní odpověď místo vytvoření dalšího záznamu. Viz Idempotence.

Požadavek

Parametry těla

string
povinné
UUID profilu pacienta, pro který se má objednávka domácí testovací sady vytvořit.
string
povinné
UUID panelu z katalogu k objednání. Přesně jeden – domácí testovací sada odpovídá 1:1 fyzické sadě, takže panel je samotná sada. ID panelů poskytuje Aniva pro tvůj partnerský účet; viz Seznam panelů. U náhrady je pole volitelné a výchozí hodnotou je panel nahrazované objednávky.
string
UUID objednávky domácí testovací sady, kterou tato nahrazuje. Jeho odesláním se z objednávky stane náhradní sada – viz Náhradní sady výše. Objednávka musí patřit ke stejnému profilu a nesmí už pro ni být na cestě jiná náhrada.
string
Důvod, proč je náhrada potřeba, v jedné větě (například Zu wenig Material, HbA1c nicht auswertbar). Povinné při odeslání replaces_home_kit_order_id, jinak se ignoruje. Maximálně 500 znaků.
integer[]
U náhrady markery, které laboratoř znovu otestuje – obvykle ty, které první sada nedokázala dodat. Každý musí být součástí toho, co požadovala nahrazovaná objednávka; ověř si je přes Seznam biomarkerů s parametrem home_kit=true. Vynech pole, pokud chceš znovu otestovat celý panel. Přijímá se jen spolu s replaces_home_kit_order_id a ne spolu s jiným panel_id. Nevyžaduje žádný další scope: opakované otestování markerů, které už pacient zaplatil, není individuální výběr.
object
Tvoje vlastní dvojice klíč/hodnota, které se při každém čtení vrací beze změny a Aniva je nikdy neinterpretuje. Použij je pro vlastní referenci objednávky, ať můžeš data spárovat bez ukládání našich ID. Maximálně 20 klíčů; klíče odpovídají [A-Za-z0-9_-] a mají nejvýše 40 znaků; hodnoty jsou řetězec, číslo nebo boolean, u řetězců nejvýše 500 znaků; celkem nejvýše 16 384 bajtů po serializaci. Klíče začínající na aniva_ jsou vyhrazené. Nikdy do metadata nedávej osobní ani klinické údaje – nezpracovávají se jako data pacienta.
string[]
Až 5 adres, z nichž každá dostane jeden e-mail, jakmile budou všechny laboratorní výsledky konečné. E-mail odkazuje na stránku s výsledky v administračním panelu Aniva. Tvůj klíč potřebuje oprávnění results_view k pacientovi, jinak 403. Vynech ho, pokud chceš použít výchozí adresy nastavené pro skupinu pacienta. Prázdný seznam e-maily vypne. Viz E-maily o připravených výsledcích.
object
povinné
Adresa pro doručení sady – má jednu ze dvou podob: buď { location_id } s odkazem na známé odběrové místo, nebo přímo uvedená pole adresy (name, street, city, postal_code, country_code; volitelně company_name / house_number / address_line_2 / state / phone / email – stejná struktura polí jako v API odběrových míst). Uveď přesně jednu z možností – odkaz na odběrové místo, nebo přímou adresu, ne obojí.
Packstation nebo Postfiliale (pouze Německo): nastav street na Packstation nebo Postfiliale, house_number na trojmístné číslo stanice a address_line_2 na DHL Postnummer příjemce (6–10 číslic, mezery jsou povoleny). Bez Postnummer nelze zásilku objednat. Postfach není podporován.

Odpověď

Při úspěchu API vrátí 201 Created s novou objednávkou domácí testovací sady.
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. Nově vytvořená objednávka začíná ve stavu pending.
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í.
object
povinné
Zadané dvojice klíč/hodnota. Vždy přítomné – pokud žádné nenastavíš, obsahuje {}.
string
Objednávka domácí testovací sady, kterou tato nahrazuje. U běžné objednávky má hodnotu null.
string
Zadaný důvod. U běžné objednávky má hodnotu null.
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.
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 Aktivovat. Do aktivace sady má hodnotu null.
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 – ten zadaný jako panel_id, s časovým razítkem vytvoření objednávky. Vždy přesně jeden. Podrobnosti panelu (název, biomarkery) najdeš přes Seznam panelů.
HomeKitOrderIndividualBiomarker[]
povinné
Biomarkery přiřazené mimo panel. Při běžném vytvoření je seznam prázdný – domácí testovací sady se objednávají podle panelu a pozdější úprava tohoto seznamu vyžaduje scope oprávnění home_kit_orders_individual_biomarker_selection. U náhrady obsahuje odeslaná biomarker_ids, tedy markery, které laboratoř znovu otestuje.
HomeKitOrderShipmentLink[]
povinné
Zásilky propojené s touto objednávkou domácí testovací sady, seřazené od nejstaršího propojení. Při vytvoření vždy prázdné – kompletní údaje o zásilkách načteš přes Seznam zásilek s parametrem ?home_kit_order_id=.

Chybové odpovědi