Saltar al contingut principal
POST
Crea un nou perfil de pacient i assigna’l a un grup de perfils. El perfil conté dades demogràfiques utilitzades en cites i comandes de laboratori. Requereix l’àmbit create_user. Envia una capçalera opcional Idempotency-Key perquè aquesta creació es pugui reintentar amb seguretat — repetir la mateixa clau retorna la resposta original en lloc de crear-ne una segona. Consulta Idempotència.

Sol·licitud

Paràmetres del cos

string
requerit
Nom del pacient. Ha d’utilitzar caràcters llatins, entre 1 i 100 caràcters.
string
requerit
Cognom del pacient. Ha d’utilitzar caràcters llatins, entre 1 i 100 caràcters. Els laboratoris rebutgen les comandes d’un pacient sense cognom, de manera que no es pot crear un perfil sense cognom.Hi ha tres valors reservats per generar dades de prova — consulta Dades de prova del sandbox.
integer
requerit
Sexe biològic segons la norma ISO/IEC 5218. Fes servir 1 per a masculí, 2 per a femení. El laboratori el necessita per als intervals de referència, així que 0 (desconegut) retorna 400. Obligatori, tret que el teu grup de perfils permeti que el pacient l’introdueixi a la pàgina d’activació del kit. En aquest cas, omet-lo. Consulta Permet que el pacient introdueixi la data de naixement i el sexe.
string
requerit
Data de naixement en format YYYY-MM-DD. Ha de ser en el passat i no anterior a 1900. L’edat resultant ha d’estar entre 16 i 100 anys. Qualsevol altre valor retorna 400. Obligatòria, tret que el teu grup de perfils permeti que el pacient l’introdueixi a la pàgina d’activació del kit. En aquest cas, omet-la.
string
requerit
Referència polimòrfica (UUID o slug) al grup de perfils al qual s’assignarà aquest perfil. L’UUID és l’identificador immutable i es manté si es canvia el nom del slug; el slug continua sent acceptat per a màrqueting i integracions de socis basades en identificadors llegibles. Es recomana l’UUID. El grup de perfils ha d’estar dins del context d’accés de la teva clau API. Obligatori tret que enviïs el camp obsolet profile_group_slug.
string
obsolet
Obsolet: fes servir profile_group. Slug del grup de perfils. Només lletres minúscules, dígits, guions i guions baixos.
string
Adreça electrònica del perfil. Si s’omet, Aniva genera automàticament una adreça electrònica.Indicar email també fa que la creació sigui segura davant reintents: una adreça només pot tenir un perfil, de manera que una sol·licitud repetida retorna 409 en lloc d’un segon perfil. Les adreces generades automàticament són úniques per sol·licitud. Envia email o una Idempotency-Key si la teva integració fa reintents.
string
Número de telèfon en format E.164 (p. ex., +14155552671).
number
Alçada en centímetres.
number
Pes en quilograms.
string
predeterminat:"en"
Idioma preferit per al perfil: 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. El valor per defecte és en.
boolean
Si aquest perfil ha de rebre correus transaccionals (programàtics) — confirmacions de cita, avisos de resultats disponibles, etc. Sobreescriu el valor per defecte del grup de perfils. Independent del consentiment de màrqueting. Omet-lo per fer servir el valor per defecte.
boolean
Si aquest perfil accepta rebre correus de màrqueting (butlletins, novetats del producte). Sobreescriu el valor per defecte del grup de perfils. Independent dels correus transaccionals. Omet-lo per fer servir el valor per defecte del grup de perfils. Només d’escriptura: no es retorna a la resposta del perfil.

Dades de prova del sandbox

Cada ruta de lectura que val la pena provar — Llistar cites, Obtenir resultats, Descarregar document — és buida fins que té lloc una extracció de sang real dies més tard. Això fa que escriure una prova d’integració automatitzada sigui incòmode. Hi ha tres valors de last_name reservats per resoldre-ho. Crea un perfil amb un d’aquests valors i Aniva emplena prèviament l’estat descrit a continuació abans de respondre, de manera que la teva següent crida ja el veu: La coincidència no distingeix entre majúscules i minúscules. Tots els altres camps — inclosos date_of_birth i sex — es desen i s’utilitzen amb normalitat, de manera que els intervals de referència que reps són els reals segons l’edat i el sexe per al perfil que has creat. La cita es reserva a la ubicació Aniva Test, en una franja reservable real d’almenys cinc dies a partir d’ara (o de fa cinc dies, per als estats passats). Generar-la no envia cap petició de laboratori ni reserva cap missatger.
Assigna als perfils de prova una adreça que controlis. Els recordatoris de cita d’Aniva es basen en scheduled_at, així que l’escenari de cita futura n’enviarà tret que el perfil els desactivi amb transactional_emails_enabled: false.
El panell es tria a l’atzar entre els que la teva clau API pot veure, de manera que el seu panel_id sempre es correspon amb el teu Llista els panells. Els biomarcadors clínics reben un valor dins de l’interval de referència del biomarcador; els gens reben un genotip aleatori de les dades de referència d’Aniva, amb les variants corresponents, la significació clínica i els identificadors rs que se’n deriven.
El panell i els valors es regeneren en cada creació, així que comprova l’estructura en lloc d’un panell concret o d’uns nombres exactes.

Resposta

En cas d’èxit, l’API retorna 201 Created amb el perfil acabat de crear.
string
requerit
Identificador únic del perfil (UUID).
string
Àlies del perfil o nom d’usuari. Pot ser null.
string
Nom. Pot ser null.
string
Cognom. Pot ser null.
string
Adreça electrònica. Pot ser null.
string
Número de telèfon en format E.164. Pot ser null.
integer
Sexe biològic segons la norma ISO/IEC 5218 (0 = desconegut, 1 = masculí, 2 = femení). Pot ser null.
string
Data de naixement en format YYYY-MM-DD. Pot ser null.
number
Alçada en centímetres. Pot ser null.
number
Pes en quilograms. Pot ser null.
string
Idioma preferit, un dels 32 codis anteriors.
boolean
Indica si aquest perfil rep correus electrònics transaccionals (programàtics). És null si no s’ha definit mai.
string
Marca de temps ISO 8601 de quan es va crear el perfil.
string
Marca de temps ISO 8601 de l’última actualització. És null per als perfils acabats de crear.

Respostes d’error

Un 409 té aquest aspecte — tracta’l com “aquest perfil ja existeix” i cerca’l amb Llista els perfils (?email=) en lloc de tornar a intentar la creació:
Una persona amb el mateix nom, cognom, sexe i data de naixement que un perfil que la teva clau pot veure rep un 409 amb error_name: "duplicate_profile_error". Fes servir el profile_id retornat en lloc de crear un segon perfil:
Els cognoms de sandbox que generen dades de prova n’estan exempts.