Vai al contenuto principale
GET
Recupera un singolo ordine di kit domiciliare tramite il suo UUID, incluso il profilo del paziente incorporato. Usa questo endpoint per verificare lo stato dell’ordine, controllare l’indirizzo di consegna o ispezionare i pannelli e i biomarcatori associati. Richiede lo scope home_kit_orders_view o home_kit_orders_manage.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore univoco (UUID) dell’ordine di kit domiciliare da recuperare.

Risposta

In caso di successo, l’API restituisce 200 OK con l’ordine di kit domiciliare e il relativo profilo incorporato.
string
obbligatorio
Identificatore univoco dell’ordine di kit domiciliare (UUID).
string
obbligatorio
UUID del profilo a cui appartiene questo ordine di kit domiciliare.
string
obbligatorio
Stato attuale dell’ordine di kit domiciliare. Uno tra pending, dispatched, activated o cancelled. Il dettaglio sul completamento dei risultati di laboratorio deriva da Ottieni risultati.
object
obbligatorio
L’indirizzo a cui spedire il kit — in uno di due formati: { location_id } che fa riferimento a una sede di test nota, oppure i campi dell’indirizzo inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opzionali — lo stesso vocabolario dell’API delle sedi). Fornisci esattamente uno dei due — un riferimento a una sede o un indirizzo inline, non entrambi.
string
Codice campione di laboratorio con cui vengono refertati i risultati — stampato sul kit fisico e letto dal paziente sulla scatola come codice di attivazione. null finché il kit non viene imballato. Di sola lettura.
string
obbligatorio
Timestamp di raccolta segnalato tramite Attiva — quando il paziente ha raccolto il campione. null finché il kit non viene attivato.
string
L’ordine di kit domiciliare sostituito da questo, quando si tratta di un kit sostitutivo. null su un ordine normale. Consulta Crea ordine di kit domiciliare.
string
Motivo per cui è stata inviata la sostituzione. null su un ordine normale.
string[]
obbligatorio
Indirizzi che ricevono ciascuno un’email quando tutti i risultati di laboratorio sono definitivi, in minuscolo. Vuoto se disattivato. Vedi Email di risultati pronti.
object
obbligatorio
Coppie chiave/valore definite dal partner, restituite esattamente come inviate. Sempre presente — {} se non impostato.
string
obbligatorio
Timestamp ISO 8601 della creazione dell’ordine di kit domiciliare.
string
Timestamp ISO 8601 dell’ultimo aggiornamento. Può essere null.
object
obbligatorio
Il profilo del paziente associato a questo ordine di kit domiciliare.
HomeKitOrderPanel[]
obbligatorio
Il pannello associato a questo ordine di kit domiciliare — sempre esattamente uno (un kit domiciliare corrisponde 1:1 a un prodotto kit fisico), sostituibile tramite Aggiorna finché è pending. Consulta i dettagli del pannello (nome, biomarcatori) tramite Elenca pannelli.
HomeKitOrderIndividualBiomarker[]
obbligatorio
Biomarcatori singoli associati a questo ordine di kit domiciliare al di fuori di qualsiasi pannello. Confronta ogni biomarker_id con Elenca biomarcatori con home_kit=true per i dati di visualizzazione.
HomeKitOrderShipmentLink[]
obbligatorio
Pacchi collegati a questo ordine di kit domiciliare, dal collegamento più vecchio in poi — di solito il kit verso il paziente e il campione di ritorno al laboratorio. Vuoto finché la logistica non stampa un’etichetta. Leggi i pacchi completi con Elenca spedizioni e ?home_kit_order_id=.

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 non cambia. 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.created e all’evento di ogni stato, ad esempio home_kit_order.activated. Vedi Letture ripetute.

Risposte di errore