Saltar para o conteúdo principal
GET
Obtém os resultados laboratoriais clínicos e genéticos de uma marcação, juntamente com referências de documentos para os PDF dos relatórios laboratoriais. Todos os biomarcadores pedidos para a marcação aparecem na resposta, para poderes acompanhar todo o pedido e não apenas o que já chegou. Lê status em cada resultado antes de usares o respetivo value:
  • As análises ainda pendentes aparecem com o estado planned enquanto a marcação estiver em in_progress.
  • Os resultados que o laboratório entregou, mas que não devem ser usados clinicamente, aparecem com o estado fault ou undeliverable e incluem um status_reason a explicar porquê. Um resultado fault continua a ter o seu value preenchido — esse valor está errado. Nunca o apresentes como um resultado clínico.
  • Os resultados de que a Aniva ou o membro duvida aparecem com o estado likely_wrong e um status_reason. O valor não está confirmado. Não o mostres como um resultado clínico sem revisão.
Cada resultado e documento recebido inclui o lab_code (código de barras do tubo) sob o qual foi registado, e o array submissions lista cada requisição laboratorial da colheita de sangue com o seu próprio estado — uma colheita de sangue repartida por vários tubos ou laboratórios fica concluída requisição a requisição. Usa Descarregar documento para descarregar os PDF dos relatórios laboratoriais referenciados no array documents. Não precisas de fazer polling a este endpoint. Subscreve os webhooks appointment.results.updated ou appointment.results.completed e chama-o quando chegar um evento. O polling continua a funcionar como alternativa. Requer o scope results_view.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da marcação cujos resultados queres obter.

Resposta

Em caso de sucesso, a API devolve 200 OK com o objeto de resultados.
string
obrigatório
Estado geral dos resultados. Um de:
  • in_progress — algumas requisições ainda estão no laboratório.
  • completed — todas as requisições foram fechadas e pelo menos uma enviou relatório.
  • fault — todas as requisições falharam sem enviar relatório. Nada é devido.
object[]
obrigatório
Uma entrada por requisição laboratorial — uma colheita de sangue repartida por vários tubos ou laboratórios tem várias. O status de nível superior passa a completed assim que todas as entradas forem fechadas e uma tiver enviado relatório.
object[]
obrigatório
Array de resultados de biomarcadores clínicos.
object[]
obrigatório
Array de resultados de biomarcadores genéticos.
object[]
obrigatório
Documentos de relatório de laboratório. Usa GET /api/v1/documents/{id} para transferir cada ficheiro.

Chamadas repetidas

A Aniva guarda a resposta deste endpoint durante 60 minutos por cada chave API. Uma chamada repetida dentro deste período recebe a resposta guardada enquanto a marcação e os seus resultados não mudarem. Após uma alteração, recebes uma nova resposta. Os cabeçalhos Cache-Status e Age mostram que a resposta está guardada e há quanto tempo. Para saberes de imediato sobre uma alteração, subscreve os eventos de webhook appointment.results.updated, appointment.results.completed e appointment.results.fault. Consulta Leituras repetidas.

Respostas de erro