Vai al contenuto principale
GET
Recupera un singolo appuntamento per un prelievo di sangue tramite il suo UUID, incluso il profilo paziente incorporato. Usa questo endpoint per verificare lo stato dell’appuntamento, confermare i dettagli della prenotazione o recuperare i dati del profilo associato. Richiede lo scope appointments_view o appointments_schedule.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore univoco (UUID) dell’appuntamento da recuperare.

Risposta

In caso di successo, l’API restituisce 200 OK con l’appuntamento e il relativo profilo incorporato.
string
obbligatorio
Identificatore univoco dell’appuntamento (UUID).
string
obbligatorio
UUID del profilo a cui appartiene questo appuntamento.
string
UUID della sede del test in cui avviene il prelievo di sangue.
string
Data e ora programmate dell’appuntamento come istante UTC (ISO 8601 con suffisso Z, es. 2026-05-15T10:30:00Z). Può essere null.
string
obbligatorio
Stato attuale dell’appuntamento. Uno tra pending, confirmed, blood_drawn o cancelled. Il dettaglio di completamento dei risultati di laboratorio si ricava da Ottieni risultati; l’avanzamento più dettagliato delle spedizioni da ciascuna voce nell’array inline shipments (vedi sotto), da consultare su Ottieni spedizione.
string
Motivo in testo libero registrato al momento dell’annullamento dell’appuntamento (es. mancata presentazione, annullamento tardivo, ‘Non riuscito. Ripetizione necessaria’). null a meno che status non sia cancelled.
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.
string
obbligatorio
Come viene effettuato il prelievo di sangue: capillary (dal polpastrello o dalla parte superiore del braccio, in microprovette) o venous (dalla vena, in provette). È il metodo impostato dall’appuntamento, altrimenti il default_draw_method della sua sede. Dopo il prelievo di sangue, è il metodo utilizzato.
string
obbligatorio
Timestamp ISO 8601 della creazione dell’appuntamento.
string
Timestamp ISO 8601 dell’ultimo aggiornamento. Può essere null.
object
obbligatorio
Il profilo del paziente associato a questo appuntamento.
AppointmentPanel[]
obbligatorio
Pannelli attualmente associati a questo appuntamento. Esclude le associazioni annullate. Consulta i dettagli del pannello (nome, biomarcatori) tramite Elenco pannelli.
AppointmentIndividualBiomarker[]
obbligatorio
Biomarcatori singoli collegati a questo appuntamento al di fuori dei pannelli (vedi Aggiungi biomarcatori personalizzati). Confronta ogni biomarker_id con Elenca biomarcatori per i dati di visualizzazione.
AppointmentShipmentLink[]
obbligatorio
Spedizioni collegate a questo appuntamento, a partire dal collegamento più vecchio. Array vuoto quando nessuna spedizione è collegata. Confronta ogni id con Ottieni spedizione per il payload completo della spedizione (stato, numero di tracciamento, aggiornamenti di stato, ecc.).
string[]
obbligatorio
Codici di laboratorio (codici a barre delle provette) registrati per questo appuntamento, in ordine di scansione. Vuoto finché il prelievo di sangue non viene confermato. Un prelievo venoso ha un unico codice stampato su ogni provetta; un prelievo capillare ha un codice per ogni microprovetta. Risultati e documenti in Ottieni risultati fanno riferimento a questi codici tramite lab_code.

Chiamate ripetute

Aniva memorizza la risposta di questo endpoint per 15 minuti per ciascuna chiave API. Una chiamata ripetuta entro questo intervallo riceve la risposta memorizzata finché l’appuntamento non cambia. Dopo una modifica, ricevi una risposta aggiornata. Gli header Cache-Status e Age indicano che la risposta è memorizzata e da quanto tempo lo è. Per conoscere subito una modifica, iscriviti agli eventi webhook appointment.created, appointment.rescheduled e all’evento di ciascuno stato, ad esempio appointment.confirmed. Vedi Letture ripetute.

Risposte di errore