Saltar para o conteúdo principal
GET
Obtém uma lista de marcações de colheita de sangue. Cada marcação inclui o perfil do paciente incorporado. Os filtros combinam-se:
  • date devolve as marcações de um dia de calendário. O dia é o dia local da localização de cada marcação, pelo que uma colheita de sangue às 23:30 em Berlim conta na sua data de Berlim.
  • location_id devolve as marcações num local de análise.
  • profile_id sem date devolve todas as marcações desse perfil, sem restrição temporal.
  • Sem profile_id nem date, aplica-se a janela temporal predefinida: dos últimos 2 meses até 1 mês no futuro.
Requer o scope appointments_view ou appointments_schedule.

Pedido

Parâmetros de consulta

string
Filtra por UUID do perfil. Quando fornecido, são devolvidas todas as marcações deste perfil independentemente da data de agendamento. Quando omitido, aplica-se a janela temporal predefinida.
string
Filtra por UUID do local de análise.
string
Dia de calendário no formato YYYY-MM-DD, no fuso horário da localização de cada marcação. Substitui a janela temporal predefinida. Os resultados são ordenados por scheduled_at, mais cedo primeiro.

Resposta

Em caso de sucesso, a API devolve 200 OK com um array de objetos de marcação.
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 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 há envios associados. Cruza cada id com Obter envio para obter o payload completo do envio (estado, número de seguimento, atualizações de estado, etc.).
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.

Chamadas repetidas

A Aniva guarda a resposta deste endpoint durante 5 minutos por cada chave API. Uma chamada repetida dentro deste período recebe a resposta guardada. Os cabeçalhos Cache-Status e Age mostram que a resposta está guardada e há quanto tempo. Para saberes logo de uma alteração, subscreve os eventos de webhook appointment.created, appointment.rescheduled e o evento de cada estado, por exemplo appointment.confirmed. Consulta Leituras repetidas.

Respostas de erro