Saltar para o conteúdo principal
GET
Obtém os resultados de laboratório clínicos e genéticos de uma encomenda de kit de teste em casa, juntamente com as referências de documento dos PDF de relatórios de laboratório. Todos os biomarcadores pedidos para o kit aparecem na resposta, para que possas acompanhar toda a encomenda e não apenas o que já chegou. Os resultados são registados sob o lab_code da encomenda — o pedido ao laboratório é feito na ativação e o laboratório comunica os marcadores individualmente à medida que são analisados, pelo que um payload parcial é normal e o status de nível superior mantém-se in_progress até ao relatório final. Lê o status de cada resultado antes de usares o respetivo value:
  • As análises ainda pendentes aparecem com o estado planned enquanto a encomenda está in_progress. Podes chamar este endpoint antes da ativação — todos os marcadores pedidos surgem então como planned.
  • 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 ainda tem o seu value preenchido — esse valor está errado. Nunca o apresentes como um resultado válido.
  • 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 válido sem revisã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 home_kit_order.results.updated ou home_kit_order.results.completed e chama-o quando chegar um evento. O polling continua a funcionar como alternativa. Requer o scope results_view — os resultados de laboratório e os documentos estão sempre protegidos por ele, tal como os resultados de marcações e Transferir documento — bem como o scope home_kit_orders_view ou home_kit_orders_manage para aceder à própria encomenda do kit.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da encomenda de kit de teste em casa da qual obter resultados.

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 para cada chave de API. Uma chamada repetida dentro deste período recebe a resposta guardada enquanto a encomenda de kit de teste em casa e os respetivos resultados não sofrerem alterações. 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 uma alteração de imediato, subscreve os eventos de webhook home_kit_order.results.updated, home_kit_order.results.completed e home_kit_order.results.fault. Consulta Leituras repetidas.

Respostas de erro