Documentos
Obter resultados do documento
Ler o estado e os valores laboratoriais extraídos de um documento que carregaste
GET
/
api
/
v1
/
documents
/
{id}
/
results
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
Lê o estado e os valores de laboratório de um documento que carregaste com
Carregar documento. A resposta tem a mesma estrutura que
Obter resultados de laboratório para uma marcação. Consulta
Resultados para ver todos os campos.
Apenas respondem documentos carregados num grupo de perfis onde a tua chave lê resultados. Todos os outros
documentos devolvem
404: lê os respetivos resultados através da marcação ou da encomenda de kit de teste em casa que os originou.
Não precisas de fazer polling. Subscreve os webhooks document.results.updated ou document.results.completed
e chama este endpoint quando chegar um evento.
Requer o âmbito results_view no grupo de perfis em que o documento foi carregado.
Pedido
Parâmetros de caminho
Cabeçalhos
O
ETag de uma resposta anterior. Quando nada mudou, a API responde 304 Not Modified sem
corpo.Resposta
Em caso de sucesso, a API devolve200 OK com o objeto de resultados e um cabeçalho ETag.
Um dos seguintes:
in_progress— a Aniva está a extrair os valores.completed— extração concluída.fault— a extração falhou.stored— o documento não tem valores: carregaste-o semextract_resultsou não contém resultados de laboratório.storedé final: não se segue nenhum webhookdocument.results.completed.
Os valores extraídos. Cada valor tem
origin: partner_upload. Um relatório com várias datas de
colheita atribui a cada valor o seu próprio tested_at. Nunca é planned: um carregamento não encomenda nada.Respostas de erro
| Estado | Descrição |
|---|---|
304 | Não modificado — o etag de If-None-Match ainda corresponde. Sem corpo. |
400 | Formato de ID inválido. |
403 | A tua chave de API não tem o âmbito results_view. |
404 | Nenhum documento carregado num dos teus grupos de perfis tem este ID. |
500 | Erro interno do servidor. |
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/documents/f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c/results \
--header 'x-api-key: YOUR_API_KEY'
{
"status": "stored",
"submissions": [{ "lab_code": null, "status": "completed" }],
"clinical_results": [],
"genetic_results": [],
"documents": [
{
"id": "f8a1b2c3-d4e5-4f6a-8b8c-9d0e1f2a3b4c",
"file_name": "20261023 - Arztbrief.pdf",
"original_file_name": "arztbrief.pdf",
"origin": "partner_upload",
"content_type": "application/pdf",
"etag": "56104b36f860cfd5b41efc716fdf7b6f",
"size_bytes": 182311,
"lab_code": null
}
]
}