Vai al contenuto principale
POST
Crea un nuovo profilo paziente e assegnalo a un gruppo di profili. Il profilo contiene i dati anagrafici usati per appuntamenti e ordini di laboratorio. Richiede lo scope create_user. Invia un header opzionale Idempotency-Key per poter ripetere questa creazione in sicurezza — ripetere la stessa chiave restituisce la risposta originale invece di crearne una seconda. Vedi Idempotenza.

Richiesta

Parametri del body

string
obbligatorio
Nome del paziente. Deve usare caratteri latini, tra 1 e 100 caratteri.
string
obbligatorio
Cognome del paziente. Deve usare caratteri latini, tra 1 e 100 caratteri. I laboratori rifiutano gli ordini per un paziente senza cognome, quindi non è possibile creare un profilo senza cognome.Tre valori sono riservati per generare dati di test — vedi Dati di test sandbox.
integer
obbligatorio
Sesso biologico secondo ISO/IEC 5218. Usa 1 per maschio, 2 per femmina. Il laboratorio ne ha bisogno per gli intervalli di riferimento, quindi 0 (sconosciuto) restituisce 400. Obbligatorio, a meno che il tuo gruppo di profili non consenta al paziente di inserirlo nella pagina di attivazione del kit. In quel caso omettilo. Vedi Consenti al paziente di inserire data di nascita e sesso.
string
obbligatorio
Data di nascita nel formato YYYY-MM-DD. Deve essere nel passato e non prima del 1900. L’età corrispondente deve essere compresa tra 16 e 100 anni. Altri valori restituiscono 400. Obbligatoria, a meno che il tuo gruppo di profili non consenta al paziente di inserirla nella pagina di attivazione del kit. In quel caso omettila.
string
obbligatorio
Riferimento polimorfico (UUID o slug) al gruppo di profili a cui assegnare questo profilo. L’UUID è l’identificatore immutabile e resta valido anche se lo slug viene rinominato; lo slug resta accettato per integrazioni di marketing e dei partner basate su identificatori leggibili. L’UUID è preferibile. Il gruppo di profili deve rientrare nel contesto di accesso della tua chiave API. Obbligatorio, a meno che tu non invii il campo deprecato profile_group_slug.
string
deprecato
Deprecato: usa profile_group. Slug del gruppo di profili. Solo lettere minuscole, cifre, trattini e underscore.
string
Indirizzo email del profilo. Se omesso, Aniva genera automaticamente un indirizzo email.Fornire email rende la creazione anche sicura in caso di nuovi tentativi: un indirizzo può avere un solo profilo, quindi una richiesta ripetuta restituisce 409 invece di un secondo profilo. Gli indirizzi generati automaticamente sono univoci per richiesta. Invia email o un Idempotency-Key se la tua integrazione riprova.
string
Numero di telefono in formato E.164 (ad es. +14155552671).
number
Altezza in centimetri.
number
Peso in chilogrammi.
string
predefinito:"en"
Lingua preferita per il profilo: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr o uk. Il valore predefinito è en.
boolean
Indica se questo profilo deve ricevere email transazionali (automatiche) — conferme degli appuntamenti, notifiche di risultati pronti, ecc. Sovrascrive il valore predefinito del gruppo di profili. Distinto dal consenso al marketing. Ometti per usare il valore predefinito.
boolean
Indica se questo profilo acconsente alle email di marketing (newsletter, aggiornamenti di prodotto). Sovrascrive il valore predefinito del gruppo di profili. Distinto dalle email transazionali. Ometti per usare il valore predefinito del gruppo di profili. Solo in scrittura: non viene restituito nella risposta del profilo.

Dati di test sandbox

Ogni percorso di lettura utile da testare — Elenca appuntamenti, Ottieni risultati, Scarica documento — è vuoto finché non avviene un vero prelievo di sangue giorni dopo. Questo rende scomodo scrivere un test di integrazione automatizzato. Tre valori di last_name sono riservati per risolvere questo problema. Crea un profilo con uno di questi valori e Aniva precompila lo stato descritto di seguito prima di rispondere, così la tua chiamata successiva lo vede già: La corrispondenza non fa distinzione tra maiuscole e minuscole. Ogni altro campo — inclusi date_of_birth e sex — viene salvato e usato normalmente, quindi gli intervalli di riferimento che ricevi sono quelli reali specifici per età e sesso del profilo che hai creato. L’appuntamento viene prenotato nella sede Aniva Test, in uno slot reale prenotabile tra almeno cinque giorni (o cinque giorni fa, per gli stati passati). Generarlo non invia alcun ordine di laboratorio e non prenota alcun corriere.
Assegna ai profili di test un indirizzo che controlli. I promemoria degli appuntamenti di Aniva si basano su scheduled_at, quindi la fixture futura li invierà a meno che non vengano disattivati sul profilo con transactional_emails_enabled: false.
Il pannello viene scelto casualmente tra quelli visibili alla tua chiave API, quindi il suo panel_id trova sempre riscontro nel tuo Elenca pannelli. I biomarcatori clinici ricevono un valore compreso nell’intervallo di riferimento del biomarcatore; i geni ricevono un genotipo casuale dai dati di riferimento di Aniva, con le relative varianti, la significatività clinica e gli ID rs che ne derivano.
Il pannello e i valori vengono rigenerati a ogni creazione, quindi verifica la struttura invece di un pannello specifico o di numeri esatti.

Risposta

In caso di successo, l’API restituisce 201 Created con il profilo appena creato.
string
obbligatorio
Identificativo univoco del profilo (UUID).
string
Handle o nome utente del profilo. Può essere null.
string
Nome. Può essere null.
string
Cognome. Può essere null.
string
Indirizzo email. Può essere null.
string
Numero di telefono in formato E.164. Può essere null.
integer
Sesso biologico secondo ISO/IEC 5218 (0 = sconosciuto, 1 = maschio, 2 = femmina). Può essere null.
string
Data di nascita in formato YYYY-MM-DD. Può essere null.
number
Altezza in centimetri. Può essere null.
number
Peso in chilogrammi. Può essere null.
string
Lingua preferita, uno dei 32 codici sopra.
boolean
Indica se questo profilo riceve email transazionali (programmatiche). null se non è mai stato impostato.
string
Timestamp ISO 8601 della creazione del profilo.
string
Timestamp ISO 8601 dell’ultimo aggiornamento. null per i profili appena creati.

Risposte di errore

Un 409 ha questo aspetto — interpretalo come “questo profilo esiste già” e cercalo con Elenca profili (?email=) invece di riprovare la creazione:
Una persona con lo stesso nome, cognome, sesso e data di nascita di un profilo visibile alla tua chiave riceve un 409 con error_name: "duplicate_profile_error". Usa il profile_id restituito invece di creare un secondo profilo:
I cognomi sandbox che generano i dati di test sono esclusi.