Salt la conținutul principal
GET
Obține rezultatele de laborator clinice și genetice pentru o comandă de kit de testare la domiciliu, împreună cu referințele de document pentru PDF-urile rapoartelor de laborator. Fiecare biomarker comandat pentru kit apare în răspuns, astfel încât să poți urmări întreaga comandă, nu doar ce a sosit deja. Rezultatele sunt înregistrate sub codul lab_code al comenzii — comanda de laborator este plasată la activare, iar laboratorul raportează markerii individual pe măsură ce sunt analizați, deci un payload parțial este normal, iar status la nivel principal rămâne in_progress până la raportul final. Citește status la fiecare rezultat înainte de a-i folosi value:
  • Testele încă în așteptare apar cu statusul planned cât timp comanda este in_progress. Poți apela acest endpoint înainte de activare — fiecare marker comandat este atunci planned.
  • Rezultatele livrate de laborator, dar care nu trebuie folosite clinic, apar cu statusul fault sau undeliverable și au un status_reason care explică motivul. Un rezultat fault are în continuare value completat — acea valoare este greșită. Nu o prezenta niciodată ca o constatare.
  • Rezultatele de care Aniva sau membrul se îndoiește apar cu statusul likely_wrong și un status_reason. Valoarea nu este confirmată. Nu o afișa ca o constatare fără verificare.
Folosește Descarcă documentul pentru a descărca rapoartele de laborator în format PDF menționate în array-ul documents. Nu trebuie să faci polling pe acest endpoint. Abonează-te la webhook-urile home_kit_order.results.updated sau home_kit_order.results.completed și apelează-l când sosește un eveniment. Polling-ul funcționează în continuare ca variantă de rezervă. Necesită scope-ul results_view — rezultatele de laborator și documentele sunt întotdeauna restricționate prin acesta, la fel ca rezultatele programărilor și Descărcare document — plus scope-ul home_kit_orders_view sau home_kit_orders_manage pentru a accesa comanda de kit în sine.

Cerere

Parametri de cale

string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu pentru care obții rezultatele.

Răspuns

La succes, API-ul returnează 200 OK cu obiectul de rezultate.
string
obligatoriu
Statusul general al rezultatelor. Una dintre valorile:
  • in_progress — unele solicitări sunt încă la laborator.
  • completed — fiecare solicitare s-a închis și cel puțin una a trimis un raport.
  • fault — fiecare solicitare a eșuat fără să trimită un raport. Nu se datorează nimic.
object[]
obligatoriu
Câte o intrare pentru fiecare solicitare de laborator — o recoltare de sânge care implică mai multe eprubete sau laboratoare are mai multe. Câmpul status de nivel superior este completed odată ce fiecare intrare s-a închis și una a trimis un raport.
object[]
obligatoriu
Listă de rezultate ale biomarkerilor clinici.
object[]
obligatoriu
Listă de rezultate ale biomarkerilor genetici.
object[]
obligatoriu
Documentele raportului de laborator. Folosește GET /api/v1/documents/{id} pentru a descărca fiecare fișier.

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 și rezultatele ei rămân neschimbate. 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.results.updated, home_kit_order.results.completed și home_kit_order.results.fault. Vezi Citiri repetate.

Răspunsuri de eroare