Přejít na hlavní obsah
PATCH
Uprav doručovací adresu, panel, metadata nebo e-maily o připravených výsledcích u objednávky domácí testovací sady. Uveď jen pole, která chceš změnit. Doručovací adresu a panel můžeš změnit jen ve stavu pending, protože fyzická sada odchází při odeslání. Pole metadata slouží pro tvou vlastní evidenci a můžeš do něj zapisovat po celou dobu existence objednávky. Neexistují endpointy pro přidání ani odebrání panelu: domácí testovací sada má vždy přesně jeden panel (odpovídá 1:1 fyzickému produktu sady), takže jediná smysluplná operace s panelem je jeho výměna tady. Vyžaduje scope home_kit_orders_manage.

Požadavek

Parametry cesty

string
povinné
Jedinečný identifikátor (UUID) objednávky domácí testovací sady, kterou chceš upravit.

Parametry těla

Všechny parametry těla požadavku jsou volitelné — uveď jen pole, která chceš změnit.
object
Adresa pro doručení sady – má jednu ze dvou podob: buď { location_id } s odkazem na známou testovací lokalitu, nebo přímo pole adresy (name, street, city, postal_code, country_code; nepovinně company_name / house_number / address_line_2 / state / phone / email – stejné názvy jako v API lokalit). Uveď přesně jednu variantu – odkaz na lokalitu, 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.
string
UUID panelu, který nahradí stávající panel – protože každá sada má přesně jeden panel, výměna je jediná smysluplná operace. Funguje jen ve stavu pending a jen pro panel, u kterého má Aniva nastavený produkt sady k expedici (jinak vrátí 422); výměna za už přiřazený panel neprovede žádnou změnu.
object
Tvoje vlastní páry klíč/hodnota. Do stávajících metadat se slučují, místo aby je nahradily: vynechané klíče zůstanou zachované, klíč odeslaný s hodnotou null se smaže a prázdný objekt {} vymaže vše. Limity odpovídají Vytvoření objednávky domácí testovací sady a validace platí stylem vše, nebo nic – pokud se zamítne jakýkoli klíč, nezapíše se nic. Nikdy do metadata neukládej osobní ani klinické údaje – nezachází se s nimi jako s údaji pacientů.
string[]
Nahradí seznam až 5 adres, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní výsledky finální. Odesláním [] e-maily vypneš. Lze upravit v každém stavu kromě cancelled. Tvůj klíč potřebuje přístup results_view k danému pacientovi, jinak vrátí 403. Viz E-maily o připravených výsledcích.

Odpověď

Při úspěchu API vrátí 200 OK s upravenou objednávkou domácí testovací sady a jejím vnořeným profilem.
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.
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) a při předání panel_id se přímo nahradí. 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=.

Chybové odpovědi