Documenten
Documentresultaten ophalen
Lees de status en de geëxtraheerde labwaarden van een document dat je hebt geüpload
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
}
]
}
Lees de status en de labwaarden van een document dat je hebt geüpload met
Document uploaden. De response heeft dezelfde structuur als
Labresultaten ophalen voor een afspraak. Zie
Resultaten voor elk veld.
Alleen documenten die zijn geüpload onder een profielgroep waarvoor je sleutel resultaten mag lezen, geven een antwoord. Elk ander
document geeft
404 terug: lees de resultaten ervan via de afspraak of thuistestkit-bestelling waaruit het afkomstig is.
Je hoeft niet te pollen. Abonneer je op de document.results.updated- of document.results.completed-
webhooks en roep dit endpoint aan zodra er een event binnenkomt.
Vereist de results_view-scope voor de profielgroep waaronder het document is geüpload.
Verzoek
Padparameters
Headers
De
ETag van een eerdere response. Als er niets is veranderd, antwoordt de API met 304 Not Modified
zonder body.Respons
Bij succes geeft de API200 OK terug met het resultatenobject en een ETag-header.
Een van:
in_progress— Aniva is bezig de waarden uit te lezen.completed— uitlezen is klaar.fault— uitlezen is mislukt.stored— het document bevat geen waarden: je hebt het geüpload zonderextract_results, of het bevat geen labresultaten.storedis definitief: er volgt geendocument.results.completed-webhook.
De uitgelezen waarden. Elke waarde heeft
origin: partner_upload. Bij een rapport met meerdere
afnamedatums krijgt elke waarde een eigen tested_at. Nooit planned: een upload bestelt niets.Foutresponsen
| Status | Beschrijving |
|---|---|
304 | Niet gewijzigd — de If-None-Match-etag komt nog overeen. Geen body. |
400 | Ongeldig ID-formaat. |
403 | Je API-sleutel mist de results_view-scope. |
404 | Er is geen document met dit ID geüpload onder een van jouw profielgroepen. |
500 | Interne serverfout. |
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
}
]
}