Salt la conținutul principal
POST
Creează un profil nou de pacient și atribuie-l unui grup de profiluri. Profilul stochează date demografice utilizate în programări și comenzi de laborator. Necesită scope-ul create_user. Trimite un antet opțional Idempotency-Key pentru ca această creare să poată fi reîncercată în siguranță — repetarea aceleiași chei returnează răspunsul inițial în loc să creeze încă una. Vezi Idempotență.

Cerere

Parametri de corp

string
obligatoriu
Prenumele pacientului. Trebuie să folosească caractere latine, între 1 și 100 de caractere.
string
obligatoriu
Numele de familie al pacientului. Trebuie să folosească caractere latine, între 1 și 100 de caractere. Laboratoarele resping comenzile pentru un pacient fără nume de familie, așa că un profil nu poate fi creat fără acesta.Trei valori sunt rezervate pentru a genera date de test — vezi Date de test pentru sandbox.
integer
obligatoriu
Sexul biologic conform ISO/IEC 5218. Folosește 1 pentru masculin, 2 pentru feminin. Laboratorul are nevoie de acesta pentru intervalele de referință, așa că 0 (necunoscut) returnează 400. Obligatoriu, cu excepția cazului în care grupul tău de profiluri îi permite pacientului să îl introducă pe pagina de activare a kitului. În acest caz, omite-l. Vezi Lasă pacientul să introducă data nașterii și sexul.
string
obligatoriu
Data nașterii în format YYYY-MM-DD. Trebuie să fie în trecut și nu înainte de 1900. Vârsta rezultată trebuie să fie între 16 și 100 de ani. Alte valori returnează 400. Obligatoriu, cu excepția cazului în care grupul tău de profiluri îi permite pacientului să o introducă pe pagina de activare a kitului. În acest caz, omite-o.
string
obligatoriu
Referință polimorfică (UUID sau slug) către grupul de profiluri căruia să îi fie atribuit acest profil. UUID-ul este identificatorul imuabil și rămâne valabil la redenumirea slug-ului; slug-ul rămâne acceptat pentru integrările de marketing și ale partenerilor construite pe identificatori lizibili. UUID-ul este preferat. Grupul de profiluri trebuie să se afle în contextul de acces al cheii tale API. Obligatoriu, cu excepția cazului în care trimiți parametrul învechit profile_group_slug.
string
depreciat
Învechit: folosește profile_group. Slug-ul grupului de profiluri. Doar litere mici, cifre, cratime și liniuțe de subliniere.
string
Adresa de e-mail a profilului. Dacă lipsește, Aniva generează automat o adresă de e-mail.Furnizarea email face și crearea sigură la reîncercări: o adresă poate avea un singur profil, astfel încât o cerere repetată returnează 409 în loc de un al doilea profil. Adresele generate automat sunt unice per cerere. Trimite email sau un Idempotency-Key dacă integrarea ta reîncearcă cererile.
string
Număr de telefon în format E.164 (de ex., +14155552671).
number
Înălțimea în centimetri.
number
Greutatea în kilograme.
string
implicit:"en"
Limba preferată pentru profil: 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 sau uk. Valoarea implicită este en.
boolean
Indică dacă acest profil trebuie să primească e-mailuri tranzacționale (programatice) — confirmări de programare, notificări privind disponibilitatea rezultatelor etc. Suprascrie setarea implicită a grupului de profiluri. Distinct de consimțământul de marketing. Omite pentru a folosi setarea implicită.
boolean
Indică dacă acest profil optează pentru e-mailuri de marketing (newslettere, actualizări de produs). Suprascrie setarea implicită a grupului de profiluri. Distinct de e-mailurile tranzacționale. Omite pentru a folosi setarea implicită a grupului de profiluri. Doar scriere: nu este returnat în răspunsul profilului.

Date de test pentru sandbox

Fiecare cale de citire care merită testată — Listează programările, Obține rezultatele, Descarcă document — este goală până când are loc o recoltare de sânge reală câteva zile mai târziu. Acest lucru face ca un test automat de integrare să fie incomod de scris. Trei valori last_name sunt rezervate pentru a rezolva această problemă. Creează un profil cu una dintre ele, iar Aniva prepopulează starea descrisă mai jos înainte de a răspunde, astfel încât următorul tău apel o vede deja: Potrivirea nu ține cont de majuscule și minuscule. Orice alt câmp — inclusiv date_of_birth și sex — este stocat și folosit normal, astfel încât intervalele de referință pe care le primești sunt cele reale, specifice vârstei și sexului, pentru profilul pe care l-ai creat. Programarea este făcută la locația Aniva Test, într-un interval real disponibil peste cel puțin cinci zile (sau cu cinci zile în urmă, pentru stările trecute). Popularea acesteia nu plasează nicio comandă de laborator și nu rezervă niciun curier.
Folosește o adresă pe care o controlezi pentru profilurile de test. Mementourile de programare Aniva se bazează pe scheduled_at, așa că setul de date pentru programări viitoare le va trimite, dacă profilul nu este dezabonat prin transactional_emails_enabled: false.
Panelul este ales aleatoriu dintre cele pe care le poate vedea cheia ta API, așa că panel_id al acestuia se regăsește întotdeauna în propriul tău Listează panelurile. Biomarkerii clinici primesc o valoare din intervalul de referință al biomarkerului; genele primesc un genotip aleatoriu din datele de referință Aniva, de unde rezultă variantele corespunzătoare, semnificația clinică și ID-urile rs.
Panelul și valorile sunt regenerate la fiecare creare, așa că verifică structura, nu un anumit panel sau numere exacte.

Răspuns

În caz de succes, API-ul returnează 201 Created împreună cu profilul nou creat.
string
obligatoriu
Identificator unic al profilului (UUID).
string
Handle-ul profilului sau numele de utilizator. Poate fi null.
string
Prenume. Poate fi null.
string
Nume de familie. Poate fi null.
string
Adresă de e-mail. Poate fi null.
string
Număr de telefon în format E.164. Poate fi null.
integer
Sex biologic conform ISO/IEC 5218 (0 = necunoscut, 1 = masculin, 2 = feminin). Poate fi null.
string
Data nașterii în format YYYY-MM-DD. Poate fi null.
number
Înălțime în centimetri. Poate fi null.
number
Greutate în kilograme. Poate fi null.
string
Limba preferată, unul dintre cele 32 de coduri de mai sus.
boolean
Indică dacă acest profil primește e-mailuri tranzacționale (programatice). null dacă nu a fost setat niciodată.
string
Marcaj temporal ISO 8601 al creării profilului.
string
Marcaj temporal ISO 8601 al ultimei actualizări. null pentru profilurile nou create.

Răspunsuri de eroare

Un răspuns 409 arată astfel — tratează-l ca „acest profil există deja” și caută-l cu Listează profilurile (?email=) în loc să reîncerci crearea:
O persoană cu același prenume, nume de familie, sex și aceeași dată de naștere ca un profil pe care îl poate vedea cheia ta primește 409 cu error_name: "duplicate_profile_error". Folosește profile_id returnat în loc să creezi un al doilea profil:
Numele de familie din sandbox care generează date de test sunt exceptate.