Dokumenter
Hent dokumentresultater
Læs status og udtrukne laboratorieværdier for et dokument, du har uploadet
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æs status og laboratorieværdier for et dokument, du har uploadet med
Upload dokument. Svaret har samme struktur som
Hent laboratorieresultater for en tid. Se
Resultater for alle felter.
Kun dokumenter uploadet under en profilgruppe, hvor din nøgle læser resultater, giver svar. Alle andre
dokumenter returnerer
404: Læs deres resultater under den tid eller bestilling af hjemmetestkit, de stammer fra.
Du behøver ikke at polle. Abonner på webhooks for document.results.updated eller document.results.completed,
og kald dette endpoint, når der kommer en hændelse.
Kræver scopet results_view på den profilgruppe, som dokumentet blev uploadet under.
Forespørgsel
Stiparametre
Headers
Svar
Ved succes returnerer API’et200 OK med resultatobjektet og en ETag-header.
En af:
in_progress– Aniva udtrækker værdierne.completed– udtrækningen er færdig.fault– udtrækningen mislykkedes.stored– dokumentet har ingen værdier: Du uploadede det udenextract_results, eller det indeholder ingen laboratorieresultater.storeder endelig: Der følger ingendocument.results.completed-webhook.
De udtrukne værdier. Hver værdi har
origin: partner_upload. En rapport med flere prøvedatoer
giver hver værdi sin egen tested_at. Aldrig planned: En upload bestiller intet.Fejlsvar
| Status | Beskrivelse |
|---|---|
304 | Ikke ændret – If-None-Match-etag matcher stadig. Ingen body. |
400 | Ugyldigt id-format. |
403 | Din API-nøgle mangler scopet results_view. |
404 | Intet dokument uploadet under en af dine profilgrupper har dette id. |
500 | Intern serverfejl. |
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
}
]
}