Salt la conținutul principal
GET
Obține o singură comandă de kit de testare la domiciliu după UUID-ul ei, inclusiv profilul integrat al pacientului. Folosește acest endpoint pentru a verifica statusul comenzii, a consulta adresa de livrare sau a inspecta panelurile și biomarkerii atașați. Necesită scope-ul home_kit_orders_view sau home_kit_orders_manage.

Cerere

Parametri de cale

string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu de obținut.

Răspuns

În caz de succes, API-ul returnează 200 OK cu comanda de kit de testare la domiciliu și profilul ei integrat.
string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu.
string
obligatoriu
UUID-ul profilului căruia îi aparține această comandă de kit de testare la domiciliu.
string
obligatoriu
Statusul actual al comenzii de kit de testare la domiciliu. Una dintre valorile pending, dispatched, activated sau cancelled. Gradul de finalizare a rezultatelor de laborator se obține din Obținere rezultate.
object
obligatoriu
Adresa la care se trimite kitul — în una dintre două forme: fie { location_id } cu referire la o locație de testare cunoscută, fie câmpurile de adresă inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opționale — același vocabular ca în API-ul de locații). Furnizează exact una dintre ele — o referință de locație sau o adresă inline, nu ambele.
string
Codul de probă de laborator sub care sunt raportate rezultatele — tipărit pe kitul fizic, pe care pacientul îl citește de pe cutie ca cod de activare. null până când kitul este ambalat. Doar citire.
string
obligatoriu
Marcajul temporal al recoltării raportat prin Activează — momentul în care pacientul și-a recoltat proba. null până când kitul este activat.
string
Comanda de kit de testare la domiciliu pe care o înlocuiește aceasta, când este un kit de înlocuire. null pentru o comandă obișnuită. Vezi Creează comandă de kit de testare la domiciliu.
string
Motivul pentru care a fost trimis kitul de înlocuire. null pentru o comandă obișnuită.
string[]
obligatoriu
Adresele care primesc fiecare câte un e-mail când toate rezultatele de laborator sunt finale, cu litere mici. Gol când este dezactivat. Vezi E-mailuri pentru rezultate gata.
object
obligatoriu
Perechi cheie/valoare definite de partener, returnate exact așa cum au fost trimise. Întotdeauna prezent — {} când nu este setat.
string
obligatoriu
Marcajul temporal ISO 8601 al momentului în care a fost creată comanda de kit de testare la domiciliu.
string
Timestamp ISO 8601 al ultimei actualizări. Poate fi null.
object
obligatoriu
Profilul pacientului asociat acestei comenzi de kit de testare la domiciliu.
HomeKitOrderPanel[]
obligatoriu
Panelul atașat acestei comenzi de kit de testare la domiciliu — întotdeauna exact unul (un kit de testare la domiciliu corespunde 1:1 unui produs fizic de tip kit), care poate fi schimbat prin Actualizare cât timp este pending. Consultă detaliile panelului (nume, biomarkeri) prin Listare paneluri.
HomeKitOrderIndividualBiomarker[]
obligatoriu
Biomarkeri individuali atașați acestei comenzi de kit de testare la domiciliu, în afara oricărui panel. Corelează fiecare biomarker_id cu Listare biomarkeri folosind home_kit=true pentru datele de afișare.
HomeKitOrderShipmentLink[]
obligatoriu
Coletele asociate acestei comenzi de kit de testare la domiciliu, începând cu cea mai veche asociere — de obicei kitul către pacient și proba înapoi la laborator. Gol până când centrul de expediere tipărește o etichetă. Citește coletele complete cu Listare expedieri și ?home_kit_order_id=.

Apeluri repetate

Aniva stochează răspunsul acestui endpoint timp de 60 de minute pentru fiecare cheie API. Un apel repetat în acest interval primește răspunsul stocat cât timp comanda de kit de testare la domiciliu rămâne neschimbată. După o modificare, primești un răspuns nou. Antetele Cache-Status și Age arată că răspunsul este stocat și ce vechime are. Pentru a afla imediat despre o modificare, abonează-te la evenimentele webhook home_kit_order.created și la evenimentul fiecărui status, de exemplu home_kit_order.activated. Vezi Citiri repetate.

Răspunsuri de eroare