Vai al contenuto principale
PATCH
Aggiorna l’indirizzo di consegna, il pannello, i metadati o le email di notifica dei risultati pronti di un ordine del kit domiciliare. Includi solo i campi che vuoi modificare. L’indirizzo di consegna e il pannello possono essere modificati solo finché l’ordine è pending, perché il kit fisico viene spedito al momento dell’invio. metadata è per la tua gestione interna e rimane modificabile per tutta la durata dell’ordine. Non esistono endpoint per aggiungere o rimuovere pannelli: un kit domiciliare include esattamente un pannello (corrisponde 1:1 a un prodotto kit fisico), quindi l’unica operazione sensata sul pannello è la sostituzione che fai qui. Richiede lo scope home_kit_orders_manage.

Richiesta

Parametri di percorso

string
obbligatorio
Identificativo univoco (UUID) dell’ordine del kit domiciliare da aggiornare.

Parametri del body

Tutti i parametri del body sono facoltativi — includi solo i campi che vuoi modificare.
object
L’indirizzo a cui spedire il kit — in una delle due forme: { location_id }, che fa riferimento a una sede di test nota, oppure i campi indirizzo inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email facoltativi — lo stesso schema dell’API delle sedi). Fornisci esattamente una delle due opzioni — un riferimento a una sede o un indirizzo inline, non entrambi.
Packstation o Postfiliale (solo Germania): imposta street su Packstation o Postfiliale, house_number sul numero a tre cifre della stazione e address_line_2 sul DHL Postnummer del destinatario (6–10 cifre, spazi consentiti). Senza il Postnummer, il pacco non può essere prenotato. Una Postfach non è supportata.
string
UUID del pannello da associare al posto di quello attuale — con esattamente un pannello per kit, la sostituzione è l’unica operazione sensata. È consentita solo finché l’ordine è pending e solo con un pannello che Aniva ha configurato con un prodotto kit di evasione (altrimenti 422); la sostituzione con il pannello già associato non ha effetto.
object
Le tue coppie chiave/valore. Vengono unite ai metadati esistenti invece di sostituirli: le chiavi omesse vengono mantenute, una chiave inviata con valore null viene eliminata e un oggetto vuoto {} cancella tutto. I limiti corrispondono a quelli di Crea ordine kit domiciliare e la validazione è tutto o niente — se una chiave viene rifiutata, non viene salvato nulla. Non inserire mai dati personali o clinici in metadata — non vengono trattati come dati del paziente.
string[]
Sostituisce l’elenco di massimo 5 indirizzi che ricevono ciascuno un’email quando tutti i risultati di laboratorio sono definitivi. Invia [] per disattivare le email. Modificabile in qualsiasi stato tranne cancelled. La tua chiave deve avere accesso results_view al paziente, altrimenti 403. Vedi Email di risultati pronti.

Risposta

In caso di successo, l’API restituisce 200 OK con l’ordine del kit domiciliare aggiornato 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 del kit domiciliare. Uno tra pending, dispatched, activated o cancelled.
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 del kit domiciliare — sempre esattamente uno (un kit domiciliare corrisponde 1:1 a un prodotto kit fisico), sostituito sul posto quando passi panel_id. 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=.

Risposte di errore