Vai al contenuto principale
GET
Recupera i risultati di laboratorio clinici e genetici per un ordine di kit domiciliare, insieme ai riferimenti ai documenti per i PDF dei referti di laboratorio. Ogni biomarcatore ordinato per il kit appare nella risposta, così puoi monitorare l’intero ordine invece che solo ciò che è già arrivato. I risultati vengono registrati sotto il lab_code dell’ordine — l’ordine al laboratorio viene effettuato all’attivazione, e il laboratorio comunica i marcatori singolarmente man mano che vengono analizzati, quindi un payload parziale è normale e lo status di primo livello resta in_progress fino al referto finale. Leggi status su ogni risultato prima di usare il relativo value:
  • Gli esami ancora in sospeso appaiono con stato planned mentre l’ordine è in_progress. Puoi chiamare questo endpoint prima dell’attivazione — in quel caso ogni marcatore ordinato è planned.
  • I risultati consegnati dal laboratorio ma che non devono essere usati clinicamente appaiono con stato fault o undeliverable e includono un status_reason che spiega il motivo. Un risultato fault ha comunque il proprio value compilato — quel valore è errato. Non presentarlo mai come un esito.
  • I risultati su cui Aniva o il membro ha dubbi appaiono con stato likely_wrong e un status_reason. Il valore non è confermato. Non mostrarlo come un esito senza verifica.
Usa Scarica documento per scaricare i PDF dei referti di laboratorio referenziati nell’array documents. Non hai bisogno di fare polling su questo endpoint. Iscriviti ai webhook home_kit_order.results.updated o home_kit_order.results.completed e chiamalo quando arriva un evento. Il polling funziona comunque come fallback. Richiede lo scope results_view — i risultati di laboratorio e i documenti sono sempre protetti da questo scope, proprio come i risultati dell’appuntamento e Scarica documento — più lo scope home_kit_orders_view o home_kit_orders_manage per accedere all’ordine del kit stesso.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore univoco (UUID) dell’ordine di kit domiciliare di cui recuperare i risultati.

Risposta

In caso di successo, l’API restituisce 200 OK con l’oggetto dei risultati.
string
obbligatorio
Stato complessivo dei risultati. Uno tra:
  • in_progress — alcune richieste sono ancora in laboratorio.
  • completed — ogni richiesta si è chiusa e almeno una ha prodotto un referto.
  • fault — ogni richiesta è fallita senza produrre un referto. Non è dovuto nulla.
object[]
obbligatorio
Una voce per ogni richiesta di laboratorio — un prelievo di sangue su più provette o laboratori ne ha diverse. Lo status di primo livello è completed quando ogni voce si è chiusa e una ha prodotto un referto.
object[]
obbligatorio
Array di risultati di biomarcatori clinici.
object[]
obbligatorio
Array di risultati di biomarcatori genetici.
object[]
obbligatorio
Documenti dei referti di laboratorio. Usa GET /api/v1/documents/{id} per scaricare ogni file.

Chiamate ripetute

Aniva memorizza la risposta di questo endpoint per 60 minuti per ogni chiave API. Una chiamata ripetuta entro questo intervallo riceve la risposta memorizzata finché l’ordine di kit domiciliare e i suoi risultati non cambiano. Dopo una modifica, ricevi una risposta aggiornata. Gli header Cache-Status e Age mostrano che la risposta è memorizzata e quanto è vecchia. Per sapere subito di una modifica, iscriviti agli eventi webhook home_kit_order.results.updated, home_kit_order.results.completed e home_kit_order.results.fault. Vedi Letture ripetute.

Risposte di errore