Vai al contenuto principale
Un profilo è un record che rappresenta un paziente o un utente nel sistema Aniva. Ogni appuntamento, ordine di laboratorio e risultato è associato a un profilo.

Gruppi di profili

Quando crei un profilo, lo assegni a un gruppo di profili tramite il parametro profile_group. Un gruppo di profili organizza i profili nel tuo account partner, associandoli a un programma o a un’integrazione specifica. Il campo profile_group accetta l’UUID immutabile del gruppo oppure il suo slug leggibile. L’UUID è il riferimento permanente — non cambia mai e rimane valido anche se lo slug viene rinominato. Lo slug è pensato per URL leggibili e integrazioni partner. Alla creazione è obbligatorio un valore profile_group (UUID o slug). Il campo legacy profile_group_slug continua a essere accettato come alias deprecato.

Campi

string
obbligatorio
UUID generato automaticamente da Aniva. Usalo per fare riferimento al profilo in altre chiamate API.
string
Nome utente o handle facoltativo per il profilo. Può essere null.
string
Nome del paziente. Solo caratteri latini, da 1 a 100 caratteri. Obbligatorio alla creazione.
string
Cognome del paziente. Solo caratteri latini, da 1 a 100 caratteri. Obbligatorio alla creazione — i laboratori rifiutano gli ordini per un paziente senza cognome. Può essere null sui profili creati prima che diventasse obbligatorio.
string
Indirizzo email del paziente. Se non ne fornisci uno alla creazione, Aniva genera automaticamente un’email segnaposto.
string
Numero di telefono in formato E.164 (es. +14155552671). Può essere null.
integer
Sesso biologico secondo ISO/IEC 5218: 1 = maschio, 2 = femmina. Obbligatorio alla creazione, a meno che il tuo gruppo di profili consenta al paziente di inserirlo (vedi sotto). Il laboratorio ne ha bisogno per gli intervalli di riferimento, quindi una creazione o un aggiornamento con 0 (sconosciuto) restituisce 400. I profili creati prima del 30 settembre 2026 possono ancora restituire 0.
string
Data di nascita in formato YYYY-MM-DD. Obbligatoria alla creazione, a meno che il tuo gruppo di profili consenta al paziente di inserirla (vedi sotto). Deve essere nel passato, non anteriore al 1900, e corrispondere a un’età tra 16 e 100 anni; i valori non plausibili vengono rifiutati con 400. La data di nascita viene inviata al laboratorio con l’ordine e non può essere modificata una volta effettuato l’ordine.
number
Altezza in centimetri. Può essere null.
number
Peso in chilogrammi. Può essere null.
string
Lingua preferita per le comunicazioni rivolte al paziente. Valori accettati: en, de, fi.
boolean
Indica se il profilo riceve email transazionali, come conferme di appuntamento e notifiche di risultati pronti. Distinto dal consenso marketing. Null se non è mai stato impostato.
string
obbligatorio
Timestamp ISO 8601 della creazione del profilo.
string
Timestamp ISO 8601 dell’aggiornamento più recente. Null se il profilo non è mai stato aggiornato.
I campi first_name, last_name, sex, date_of_birth e profile_group sono obbligatori quando crei un profilo. Tutti gli altri campi sono facoltativi. Il campo legacy profile_group_slug è ancora accettato come alias deprecato di profile_group.

Consenti al paziente di inserire data di nascita e sesso

Possiamo attivare un’impostazione per il tuo gruppo di profili. In questo modo puoi creare un profilo senza date_of_birth e sex. Chiedici di attivarla. Senza questa impostazione, una creazione che omette uno dei due campi restituisce 400. Il paziente inserisce entrambi i dati nella pagina di attivazione del kit (anivahealth.com/activate), insieme al codice del kit. La pagina chiede la data di nascita due volte, perché il laboratorio non può modificarla in seguito. Dopodiché, il kit si apre solo con quella data di nascita. Finché il paziente non inserisce entrambi i dati, teniamo in sospeso l’ordine di laboratorio. Usa questa impostazione solo per i kit domiciliari.

Ciclo di vita

I profili seguono un ciclo di vita semplice:
  1. Crea — registra il profilo con i campi anagrafici obbligatori e un profile_group (UUID o slug).
  2. Aggiorna (opzionale) — aggiungi o modifica campi come phone, height o weight.
  3. Associa — collega il profilo agli appuntamenti usando il suo id come profile_id.
Un webhook profile.* ti avvisa quando un profilo appare, cambia o viene eliminato.

Profilo di esempio