Documentos
Obtener resultados del documento
Consultar el estado y los valores de laboratorio extraídos de un documento que has subido
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
}
]
}
Lee el estado y los valores de laboratorio de un documento que hayas subido con
Subir documento. La respuesta tiene la misma estructura que
Obtener resultados de laboratorio para una cita. Consulta
Resultados para conocer cada campo.
Solo responden los documentos subidos bajo un grupo de perfiles en el que tu clave puede leer resultados.
Cualquier otro documento devuelve
404: consulta sus resultados en la cita o el pedido de kit de prueba en casa que lo generó.
No necesitas hacer polling. Suscríbete a los webhooks document.results.updated o
document.results.completed y llama a este endpoint cuando llegue un evento.
Requiere el permiso results_view en el grupo de perfiles bajo el que se subió el documento.
Solicitud
Parámetros de ruta
Cabeceras
El
ETag de una respuesta anterior. Si no ha cambiado nada, la API responde 304 Not Modified
sin cuerpo.Respuesta
Si la solicitud tiene éxito, la API devuelve200 OK con el objeto de resultados y una cabecera ETag.
Uno de estos valores:
in_progress— Aniva está extrayendo los valores.completed— extracción finalizada.fault— la extracción ha fallado.stored— el documento no tiene valores: lo subiste sinextract_resultso no contiene resultados de laboratorio.storedes definitivo: no le sigue ningún webhookdocument.results.completed.
Los valores extraídos. Cada valor incluye
origin: partner_upload. Un informe con varias fechas
de muestra asigna a cada valor su propio tested_at. Nunca es planned: una subida no solicita nada.Respuestas de error
| Estado | Descripción |
|---|---|
304 | Sin modificar: el etag de If-None-Match sigue coincidiendo. Sin cuerpo. |
400 | Formato de ID no válido. |
403 | Tu clave de API no tiene el permiso results_view. |
404 | Ningún documento subido bajo alguno de tus grupos de perfiles tiene este ID. |
500 | Error interno 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
}
]
}