Documents
Obtén els resultats d'un document
Llegeix l’estat i els valors de laboratori extrets d’un document que has pujat
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
}
]
}
Llegeix l’estat i els valors de laboratori d’un document que hagis pujat amb
Puja un document. La resposta té la mateixa estructura que
Obtén els resultats de laboratori per a una cita. Consulta
Resultats per a cada camp.
Només responen els documents pujats en un grup de perfils en què la teva clau pot llegir resultats. Qualsevol altre
document retorna
404: llegeix-ne els resultats a la cita o a la comanda del kit de prova a casa que l’ha generat.
No cal que facis consultes periòdiques. Subscriu-te als webhooks document.results.updated o document.results.completed
i crida aquest punt final quan arribi un esdeveniment.
Requereix l’àmbit results_view al grup de perfils en què es va pujar el document.
Sol·licitud
Paràmetres de ruta
Capçaleres
L’
ETag d’una resposta anterior. Si no ha canviat res, l’API respon 304 Not Modified sense
cos.Resposta
Si té èxit, l’API retorna200 OK amb l’objecte de resultats i una capçalera ETag.
Un dels següents:
in_progress— Aniva està extraient els valors.completed— extracció completada.fault— l’extracció ha fallat.stored— el document no té valors: l’has pujat senseextract_resultso no conté resultats de laboratori.storedés definitiu: no s’enviarà cap webhookdocument.results.completed.
Els valors extrets. Cada valor porta
origin: partner_upload. Un informe amb diverses dates de
mostra assigna a cada valor el seu propi tested_at. Mai planned: una pujada no fa cap comanda.Respostes d’error
| Estat | Descripció |
|---|---|
304 | No modificat — l’etag d’If-None-Match continua coincidint. Sense cos. |
400 | Format d’ID no vàlid. |
403 | La teva clau API no té l’àmbit results_view. |
404 | No hi ha cap document pujat en cap dels teus grups de perfils amb aquest ID. |
500 | Error intern del 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
}
]
}