Saltar al contingut principal
GET
Obtén una llista de cites d’extracció de sang. Cada cita inclou el perfil del pacient incrustat. Els filtres es combinen:
  • date retorna les cites d’un dia natural. El dia és el dia local de la ubicació de cada cita, així que una extracció de sang a les 23:30 a Berlín compta en la seva data de Berlín.
  • location_id retorna les cites d’una ubicació d’anàlisi.
  • profile_id sense date retorna totes les cites d’aquest perfil, sense restricció de temps.
  • Sense profile_id ni date, s’aplica l’interval de temps predeterminat: dels darrers 2 mesos fins a 1 mes endavant.
Requereix l’àmbit appointments_view o appointments_schedule.

Sol·licitud

Paràmetres de consulta

string
Filtra per UUID de perfil. Si s’indica, es retornen totes les cites d’aquest perfil independentment de la data programada. Si s’omet, s’aplica l’interval de temps predeterminat.
string
Filtra per UUID de la ubicació d’anàlisi.
string
Dia natural en format YYYY-MM-DD, en la zona horària de la ubicació de cada cita. Substitueix l’interval de temps predeterminat. Els resultats s’ordenen per scheduled_at, primer els de data anterior.

Resposta

Si té èxit, l’API retorna 200 OK amb una matriu d’objectes de cita.
string
requerit
Identificador únic de la cita (UUID).
string
requerit
UUID del perfil al qual pertany aquesta cita.
string
UUID de la ubicació de proves on es fa l’extracció de sang.
string
Data i hora programades de la cita com a instant UTC (ISO 8601 amb el sufix Z, p. ex., 2026-05-15T10:30:00Z). Pot ser null.
string
requerit
Estat actual de la cita. Pot ser pending, confirmed, blood_drawn o cancelled. El detall de compleció dels resultats de laboratori s’obté mitjançant Obtén els resultats; el progrés detallat de l’enviament, a partir de cada entrada de la matriu shipments inclosa aquí (més avall) seguida a Obtén l’enviament.
string
Motiu en text lliure registrat en cancel·lar la cita (p. ex., absència, cancel·lació tardana, «Error. Cal repetir»). null llevat que status sigui cancelled.
string[]
requerit
Adreces que reben un correu electrònic cadascuna quan tots els resultats del laboratori són definitius, en minúscules. Buit quan està desactivat. Consulta Correus electrònics de resultats a punt.
string
requerit
Com es fa l’extracció de sang: capillary (de la punta del dit o de la part superior del braç, en microtubs) o venous (de la vena, en tubs). És el mètode definit a la cita o, si no n’hi ha, el default_draw_method de la seva ubicació. Després de l’extracció de sang, és el mètode que s’ha fet servir.
string
requerit
Marca de temps ISO 8601 de quan es va crear la cita.
string
Marca de temps ISO 8601 de l’última actualització. Pot ser null.
object
requerit
El perfil del pacient associat a aquesta cita.
AppointmentPanel[]
requerit
Panells associats actualment a aquesta cita. Exclou les associacions cancel·lades. Consulta els detalls del panell (nom, biomarcadors) mitjançant Llista els panells.
AppointmentIndividualBiomarker[]
requerit
Biomarcadors a la carta associats a aquesta cita fora de qualsevol panell (consulta Afegeix biomarcadors personalitzats). Contrasta cada biomarker_id amb Llista els biomarcadors per obtenir les dades de visualització.
AppointmentShipmentLink[]
requerit
Enviaments vinculats a aquesta cita, del vincle més antic al més recent. Matriu buida quan no hi ha enviaments vinculats. Creua cada id amb Obtén l’enviament per obtenir les dades completes de l’enviament (estat, número de seguiment, actualitzacions d’estat, etc.).
string[]
requerit
Codis de laboratori (codis de barres dels tubs) registrats per a aquesta cita, per ordre d’escaneig. Buit fins que es confirmi l’extracció de sang. Una extracció venosa porta un sol codi imprès a cada tub; una extracció capil·lar porta un codi per microtub. Els resultats i documents a Obtén els resultats fan referència a aquests codis mitjançant lab_code.

Crides repetides

Aniva desa la resposta d’aquest punt final durant 5 minuts per a cada clau d’API. Una crida repetida dins d’aquest període rep la resposta desada. Les capçaleres Cache-Status i Age indiquen que la resposta està desada i quina antiguitat té. Per assabentar-te d’un canvi a l’instant, subscriu-te als esdeveniments de webhook appointment.created, appointment.rescheduled i a l’esdeveniment de cada estat, per exemple appointment.confirmed. Consulta Lectures repetides.

Respostes d’error