Saltar para o conteúdo principal
PATCH
Atualiza detalhes da marcação, como a hora agendada ou o local da análise. Apenas marcações cuja colheita de sangue ainda não tenha sido confirmada podem ser modificadas.
As marcações não podem ser modificadas depois de a colheita de sangue ter sido confirmada ou se já estiverem canceladas. Tentar atualizar uma marcação nesse estado devolve 409 Conflict. A única exceção é results_ready_emails, que ainda podes alterar após a colheita de sangue.
Requer o âmbito appointments_schedule ou appointments_manage.

Pedido

Parâmetros de caminho

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

Parâmetros do corpo

Todos os parâmetros do corpo são opcionais — inclui apenas os campos que queres alterar.
string
Nova data e hora da marcação no formato ISO 8601 (por exemplo, 2026-05-20T14:00:00Z ou 2026-05-20T16:00:00+02:00). Tem de incluir um designador de fuso horário — Z ou um desvio explícito como +02:00; datas e horas sem fuso horário são rejeitadas. Tem de estar no futuro.Tem de ser o início exato de um horário com capacidade disponível — consulta Obter disponibilidade. A marcação a ser reagendada nunca conta para a capacidade do seu próprio horário de destino, mas movê-la para um horário onde o mesmo perfil já tem uma marcação diferente devolve 409 com o appointment_id dessa marcação.Se o local de destino for operado pela Aniva, a nova hora também tem de ter pelo menos 12 horas de antecedência — consulta Antecedência mínima.
string
UUID do novo local da análise. O local tem de existir e estar ativo. Usa Listar locais para encontrares os IDs dos locais disponíveis.
string[]
Substitui a lista de até 5 endereços que recebem um email cada assim que todos os resultados laboratoriais forem definitivos. Envia [] para desativares os emails. Este campo continua editável após a colheita de sangue; apenas uma marcação cancelada o recusa. Após a colheita de sangue, envia-o sozinho: com scheduled_at ou location_id no mesmo corpo, o pedido devolve 409. A tua chave precisa de acesso results_view ao paciente; caso contrário, 403. Consulta Emails de resultados prontos.
string | null
Novo método de colheita: capillary ou venous, ou null para voltar a usar o default_draw_method do local. O local tem de listar o método nos seus draw_methods e as análises marcadas têm de ser possíveis com ele; caso contrário, 400. Quando moves uma marcação para outro local, a mesma verificação é executada lá: sobre o seu próprio draw_method ou, caso contrário, sobre o default_draw_method do novo local.

Resposta

Em caso de sucesso, a API devolve 200 OK com a marcação atualizada 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 agendadas da marcação como instante UTC (ISO 8601 com sufixo Z, por exemplo, 2026-05-20T14:00:00Z). Pode ser null.
string
obrigatório
Estado atual da marcação. Um de pending, confirmed, blood_drawn ou cancelled. O detalhe sobre a conclusão dos resultados laboratoriais obtém-se em Obter resultados; a progressão detalhada dos envios obtém-se a partir de cada entrada no array shipments incorporado (vê abaixo) seguindo para Obter envio.
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 atualmente associados a esta marcação. Exclui associações canceladas. 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 associados a esta marcação, com a associação mais antiga primeiro. Array vazio quando não existem envios associados. Cruza cada id com Obter envio para obteres o payload completo do 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