Saltar al contenido principal
GET
Obtén una lista de citas de extracción de sangre. Cada cita incluye el perfil del paciente integrado. Los filtros se combinan:
  • date devuelve las citas de un día natural. El día corresponde al día local de la ubicación de cada cita, por lo que una extracción de sangre a las 23:30 en Berlín cuenta con su fecha de Berlín.
  • location_id devuelve las citas de una ubicación de pruebas.
  • profile_id sin date devuelve todas las citas de ese perfil, sin restricción temporal.
  • Sin profile_id ni date, se aplica la ventana temporal predeterminada: de los últimos 2 meses hasta dentro de 1 mes.
Requiere el scope appointments_view o appointments_schedule.

Solicitud

Parámetros de consulta

string
Filtra por UUID de perfil. Cuando se proporciona, se devuelven todas las citas de este perfil sin importar la fecha programada. Cuando se omite, se aplica la ventana temporal predeterminada.
string
Filtra por UUID de ubicación de pruebas.
string
Día natural en formato YYYY-MM-DD, en la zona horaria de la ubicación de cada cita. Sustituye la ventana temporal predeterminada. Los resultados se ordenan por scheduled_at, primero los más tempranos.

Respuesta

Si tiene éxito, la API devuelve 200 OK con un array de objetos de cita.
string
requerido
Identificador único de la cita (UUID).
string
requerido
UUID del perfil al que pertenece esta cita.
string
UUID del centro de análisis donde se realiza la extracción de sangre.
string
Fecha y hora programadas de la cita como instante UTC (ISO 8601 con sufijo Z, p. ej., 2026-05-15T10:30:00Z). Puede ser null.
string
requerido
Estado actual de la cita. Puede ser pending, confirmed, blood_drawn o cancelled. El grado de avance de los resultados de laboratorio se obtiene en Obtener resultados; el progreso detallado de los envíos, a partir de cada entrada del array shipments integrado (ver más abajo) consultándolo en Obtener envío.
string
Motivo en texto libre registrado al cancelar la cita (p. ej., no presentado, cancelación tardía, ‘Fallida. Repetición necesaria’). null salvo que status sea cancelled.
string[]
requerido
Direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos, en minúsculas. Vacío cuando está desactivado. Consulta Correos de resultados listos.
string
requerido
Cómo se realiza la extracción de sangre: capillary (en la yema del dedo o en la parte superior del brazo, en microtubos) o venous (de la vena, en tubos). Es el método definido en la cita o, en su defecto, el default_draw_method de su ubicación. Después de la extracción de sangre, es el método que se utilizó.
string
requerido
Marca de tiempo ISO 8601 de cuándo se creó la cita.
string
Marca de tiempo ISO 8601 de la última actualización. Puede ser null.
object
requerido
El perfil del paciente asociado a esta cita.
AppointmentPanel[]
requerido
Paneles asociados actualmente a esta cita. Excluye las asociaciones canceladas. Consulta los detalles del panel (nombre, biomarcadores) mediante Listar paneles.
AppointmentIndividualBiomarker[]
requerido
Biomarcadores a la carta asociados a esta cita fuera de cualquier panel (consulta Añadir biomarcadores personalizados). Contrasta cada biomarker_id con Listar biomarcadores para obtener los datos de visualización.
AppointmentShipmentLink[]
requerido
Envíos vinculados a esta cita, del vínculo más antiguo al más reciente. Array vacío cuando no hay envíos vinculados. Cruza cada id con Obtener envío para ver los datos completos del envío (estado, número de seguimiento, actualizaciones de estado, etc.).
string[]
requerido
Códigos de laboratorio (códigos de barras de los tubos) registrados para esta cita, en orden de escaneo. Vacío hasta que se confirme la extracción de sangre. Una extracción venosa lleva un único código impreso en todos los tubos; una extracción capilar lleva un código por microtubo. Los resultados y documentos de Obtener resultados hacen referencia a estos códigos mediante lab_code.

Llamadas repetidas

Aniva almacena la respuesta de este endpoint durante 5 minutos para cada clave de API. Una llamada repetida dentro de este plazo obtiene la respuesta almacenada. Las cabeceras Cache-Status y Age indican que la respuesta está almacenada y cuál es su antigüedad. Para enterarte de un cambio al instante, suscríbete a los eventos de webhook appointment.created, appointment.rescheduled y al evento de cada estado, por ejemplo appointment.confirmed. Consulta Lecturas repetidas.

Respuestas de error