Dokument
Hämta dokumentresultat
Läs status och extraherade labbvärden för ett dokument som du har laddat upp
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 och labbvärden för ett dokument som du laddat upp med
Ladda upp dokument. Svaret har samma struktur som
Hämta labbresultat för en bokning. Se
Resultat för alla fält.
Endast dokument som laddats upp under en profilgrupp där din nyckel kan läsa resultat ger svar. Alla andra
dokument returnerar
404: läs deras resultat under den bokning eller beställning av hemtestkit som skapade dem.
Du behöver inte polla. Prenumerera på webhooks för document.results.updated eller document.results.completed
och anropa den här endpointen när en händelse kommer in.
Kräver scopet results_view för den profilgrupp som dokumentet laddades upp under.
Förfrågan
Sökvägsparametrar
Headers
Svar
Vid lyckat anrop returnerar API:et200 OK med resultatobjektet och en ETag-header.
Ett av följande:
in_progress– Aniva extraherar värdena.completed– extraheringen är klar.fault– extraheringen misslyckades.stored– dokumentet har inga värden: du laddade upp det utanextract_results, eller så innehåller det inga labbresultat.storedär slutgiltig: ingendocument.results.completed-webhook skickas efteråt.
De extraherade värdena. Varje värde har
origin: partner_upload. En rapport med flera
provtagningsdatum ger varje värde sitt eget tested_at. Aldrig planned: en uppladdning beställer inget.Felsvar
| Status | Beskrivning |
|---|---|
304 | Oförändrad – etag i If-None-Match matchar fortfarande. Ingen body. |
400 | Ogiltigt ID-format. |
403 | Din API-nyckel saknar scopet results_view. |
404 | Inget dokument som laddats upp under någon av dina profilgrupper har detta ID. |
500 | Internt serverfel. |
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
}
]
}