Saltar al contenido principal
POST
Crea un nuevo perfil de paciente y asígnalo a un grupo de perfiles. El perfil guarda los datos demográficos usados en citas y pedidos de laboratorio. Requiere el scope create_user. Envía una cabecera opcional Idempotency-Key para que esta creación se pueda reintentar con seguridad: repetir la misma clave devuelve la respuesta original en lugar de crear otra. Consulta Idempotencia.

Solicitud

Parámetros del cuerpo

string
requerido
Nombre del paciente. Debe usar caracteres latinos y tener entre 1 y 100 caracteres.
string
requerido
Apellido del paciente. Debe usar caracteres latinos y tener entre 1 y 100 caracteres. Los laboratorios rechazan pedidos de pacientes sin apellido, por lo que no se puede crear un perfil sin uno.Hay tres valores reservados para generar datos de prueba; consulta Datos de prueba en sandbox.
integer
requerido
Sexo biológico según ISO/IEC 5218. Usa 1 para masculino y 2 para femenino. El laboratorio lo necesita para los intervalos de referencia, por lo que 0 (desconocido) devuelve 400. Obligatorio, salvo que tu grupo de perfiles permita al paciente introducirlo en la página de activación del kit. En ese caso, omítelo. Consulta Dejar que el paciente introduzca fecha de nacimiento y sexo.
string
requerido
Fecha de nacimiento en formato YYYY-MM-DD. Debe ser anterior a hoy y no anterior a 1900. La edad resultante debe estar entre 16 y 100 años. Otros valores devuelven 400. Obligatorio, salvo que tu grupo de perfiles permita al paciente introducirla en la página de activación del kit. En ese caso, omítelo.
string
requerido
Referencia polimórfica (UUID o slug) al grupo de perfiles al que se asigna este perfil. El UUID es el identificador inmutable y no cambia si se renombra el slug; el slug sigue aceptándose para integraciones de marketing y de socios basadas en identificadores legibles. Se recomienda usar el UUID. El grupo de perfiles debe estar dentro del contexto de acceso de tu clave de API. Obligatorio salvo que envíes el campo obsoleto profile_group_slug.
string
obsoleto
Obsoleto: usa profile_group. Slug del grupo de perfiles. Solo letras minúsculas, dígitos, guiones y guiones bajos.
string
Dirección de correo electrónico del perfil. Si se omite, Aniva genera una automáticamente.Proporcionar email también hace que la creación sea segura ante reintentos: una dirección solo puede tener un perfil, así que una solicitud repetida devuelve 409 en lugar de crear un segundo perfil. Las direcciones autogeneradas son únicas por solicitud. Envía email o un Idempotency-Key si tu integración hace reintentos.
string
Número de teléfono en formato E.164 (p. ej., +14155552671).
number
Altura en centímetros.
number
Peso en kilogramos.
string
predeterminado:"en"
Idioma preferido para el 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 predeterminado es en.
boolean
Si este perfil debe recibir correos transaccionales (automáticos): confirmaciones de cita, avisos de resultados disponibles, etc. Sobrescribe el valor por defecto del grupo de perfiles. Es independiente del consentimiento de marketing. Omítelo para usar el valor por defecto.
boolean
Si este perfil acepta recibir correos de marketing (boletines, novedades de producto). Sobrescribe el valor por defecto del grupo de perfiles. Es independiente de los correos transaccionales. Omítelo para usar el valor por defecto del grupo de perfiles. Solo de escritura: no se devuelve en la respuesta del perfil.

Datos de prueba en sandbox

Todas las rutas de lectura que merece la pena probar —Listar citas, Obtener resultados, Descargar documento— están vacías hasta que se realiza una extracción de sangre real días después. Eso dificulta escribir una prueba de integración automatizada. Hay tres valores de last_name reservados para resolverlo. Crea un perfil con uno de ellos y Aniva precargará el estado descrito abajo antes de responder, para que tu siguiente llamada ya lo vea: La coincidencia no distingue entre mayúsculas y minúsculas. Todos los demás campos —incluidos date_of_birth y sex— se guardan y se usan con normalidad, así que los intervalos de referencia que recibes son los reales según la edad y el sexo del perfil que has creado. La cita se reserva en la ubicación Aniva Test, en una franja real reservable dentro de al menos cinco días (o hace cinco días, para los estados pasados). Al generarla no se crea ningún pedido de laboratorio ni se reserva ningún mensajero.
Asigna a los perfiles de prueba una dirección que controles. Los recordatorios de cita de Aniva se rigen por scheduled_at, así que el caso de prueba próximo los enviará a menos que se desactiven en el perfil mediante transactional_emails_enabled: false.
El panel se elige al azar entre los que puede ver tu clave de API, así que su panel_id siempre aparece en tu propio Listar paneles. Los biomarcadores clínicos reciben un valor dentro del intervalo de referencia del biomarcador; los genes reciben un genotipo aleatorio de los datos de referencia de Aniva, junto con las variantes, la significación clínica y los ID rs que se derivan de él.
El panel y los valores se regeneran en cada creación, así que comprueba la estructura en lugar de un panel concreto o números exactos.

Respuesta

Si tiene éxito, la API devuelve 201 Created con el perfil recién creado.
string
requerido
Identificador único del perfil (UUID).
string
Alias o nombre de usuario del perfil. Puede ser null.
string
Nombre. Puede ser null.
string
Apellidos. Puede ser null.
string
Dirección de correo electrónico. Puede ser null.
string
Número de teléfono en formato E.164. Puede ser null.
integer
Sexo biológico según ISO/IEC 5218 (0 = desconocido, 1 = masculino, 2 = femenino). Puede ser null.
string
Fecha de nacimiento en formato YYYY-MM-DD. Puede ser null.
number
Altura en centímetros. Puede ser null.
number
Peso en kilogramos. Puede ser null.
string
Idioma preferido, uno de los 32 códigos anteriores.
boolean
Indica si este perfil recibe correos electrónicos transaccionales (programáticos). null si nunca se ha configurado.
string
Marca de tiempo ISO 8601 de creación del perfil.
string
Marca de tiempo ISO 8601 de la última actualización. null en perfiles recién creados.

Respuestas de error

Un 409 tiene este aspecto: trátalo como “este perfil ya existe” y búscalo con Listar perfiles (?email=) en lugar de reintentar la creación:
Una persona con el mismo nombre, apellidos, sexo y fecha de nacimiento que un perfil que puede ver tu clave recibe un 409 con error_name: "duplicate_profile_error". Usa el profile_id devuelto en lugar de crear un segundo perfil:
Los apellidos de sandbox que generan datos de prueba están exentos.