Saltar para o conteúdo principal
DELETE
Cancela uma marcação definindo o seu estado como cancelled. Só podem ser canceladas marcações cuja colheita de sangue ainda não tenha sido confirmada. Cancelar uma marcação que já está como cancelled devolve 200 com essa marcação e não escreve nada — não é registado um segundo cancelamento. A resposta inclui Idempotent-Replayed: true para que possas distinguir uma repetição da chamada que realizou a ação. Uma repetição que inclua um cancellation_reason diferente devolve 409 em vez disso: o motivo registado nunca é substituído. Consulta Idempotência.
Não é possível cancelar marcações após a confirmação da colheita de sangue — isso devolve 409 Conflict.
Requer o âmbito appointments_schedule ou appointments_manage.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da marcação a cancelar.

Parâmetros do corpo

O corpo é opcional — não envies qualquer corpo para cancelar sem registar um motivo.
string
Motivo de cancelamento em texto livre, até 500 caracteres (p. ex., Patient no-show). Guardado na marcação e devolvido como cancellation_reason nesta e em leituras posteriores.

Resposta

Em caso de sucesso, a API devolve 200 OK com a marcação cancelada e o respetivo perfil incorporado.
string
obrigatório
Identificador único da marcação (UUID).
string
obrigatório
UUID do perfil a que pertence esta marcação.
string
UUID do local de teste onde decorre a colheita de sangue.
string
Data e hora agendada da marcação como instante UTC (ISO 8601 com sufixo Z, p. ex., 2026-05-15T10:30:00Z). Pode ser null.
string
obrigatório
Estado da marcação. Será cancelled após um cancelamento bem-sucedido.
string
Motivo em texto livre registado quando a marcação foi cancelada (p. ex., falta de comparência, cancelamento tardio, ‘Falhou. Repetição necessária’). null, exceto quando status é cancelled.
string[]
obrigatório
Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta E-mails de resultados prontos.
string
obrigatório
Como o sangue é colhido: capillary (ponta do dedo ou parte superior do braço, em microtubos) ou venous (na veia, em tubos). É o método definido na marcação ou, caso contrário, o default_draw_method do respetivo local. Após a colheita de sangue, é o método que foi utilizado.
string
obrigatório
Data e hora ISO 8601 da criação da marcação.
string
Data e hora ISO 8601 da última atualização. Pode ser null.
object
obrigatório
O perfil do paciente associado a esta marcação.
AppointmentPanel[]
obrigatório
Painéis que estavam associados a esta marcação antes do cancelamento. Consulta os detalhes do painel (nome, biomarcadores) através de Listar painéis.
AppointmentIndividualBiomarker[]
obrigatório
Biomarcadores avulsos associados a esta marcação fora de qualquer painel (consulta Adicionar biomarcadores personalizados). Cruza cada biomarker_id com Listar biomarcadores para obter os dados de apresentação.
AppointmentShipmentLink[]
obrigatório
Envios que estavam associados a esta marcação antes do cancelamento. Cada id relaciona-se com Obter envio.
string[]
obrigatório
Códigos de laboratório (códigos de barras dos tubos) registados para esta marcação, por ordem de leitura. Vazio até a colheita de sangue ser confirmada. Uma colheita venosa tem um código impresso em todos os tubos; uma colheita capilar tem um código por microtubo. Os resultados e documentos em Obter resultados referenciam estes códigos através de lab_code.

Respostas de erro