Saltar al contingut principal
DELETE
Cancel·la una cita establint-ne l’estat a cancelled. Només es poden cancel·lar les cites que encara no tinguin l’extracció de sang confirmada. Cancel·lar una cita que ja té l’estat cancelled retorna 200 amb la cita i no escriu res — no es registra cap segona cancel·lació. La resposta inclou Idempotent-Replayed: true perquè puguis distingir una repetició de la crida que ha fet l’acció. Una repetició amb un cancellation_reason diferent retorna 409: el motiu registrat no se sobreescriu mai. Consulta Idempotència.
Les cites no es poden cancel·lar un cop confirmada l’extracció de sang — això retorna 409 Conflict.
Requereix l’àmbit appointments_schedule o appointments_manage.

Sol·licitud

Paràmetres de ruta

string
requerit
Identificador únic (UUID) de la cita que vols cancel·lar.

Paràmetres del cos

El cos és opcional — no enviïs cap cos per cancel·lar sense registrar cap motiu.
string
Motiu en text lliure de la cancel·lació, de fins a 500 caràcters (p. ex., Patient no-show). Es desa a la cita i es retorna com a cancellation_reason en aquesta lectura i en les posteriors.

Resposta

Si té èxit, l’API retorna 200 OK amb la cita cancel·lada i el seu perfil incrustat.
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 de la cita. Serà cancelled després d’una cancel·lació correcta.
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 que estaven associats a aquesta cita abans de la cancel·lació. Consulta els detalls del panell (nom, biomarcadors) a 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 que estaven vinculats a aquesta cita abans de la cancel·lació. Cada id es contrasta amb Obtén l’enviament.
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.

Respostes d’error