Dokumenty
Získat výsledky dokumentu
Načíst stav a extrahované laboratorní hodnoty tvého nahraného dokumentu
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
}
]
}
Načti stav a laboratorní hodnoty dokumentu nahraného pomocí
Nahrát dokument. Odpověď má stejnou strukturu jako
Získat laboratorní výsledky pro termín. Popis všech polí najdeš v sekci
Výsledky.
Odpovídají pouze dokumenty nahrané pod skupinou profilů, ze které tvůj klíč může číst výsledky. Každý jiný
dokument vrátí
404: jeho výsledky si přečti pod termínem nebo objednávkou domácí testovací sady, ze které pochází.
Nemusíš dělat polling. Přihlas se k odběru webhooků document.results.updated nebo document.results.completed
a zavolej tento endpoint, až přijde událost.
Vyžaduje scope results_view pro skupinu profilů, pod kterou byl dokument nahrán.
Požadavek
Parametry cesty
Hlavičky
Odpověď
Při úspěchu API vrátí200 OK s objektem výsledků a hlavičkou ETag.
Jedna z hodnot:
in_progress— Aniva extrahuje hodnoty.completed— extrakce dokončena.fault— extrakce selhala.stored— dokument nemá žádné hodnoty: byl nahrán bezextract_results, nebo neobsahuje žádné laboratorní výsledky. Stavstoredje konečný: žádný webhookdocument.results.completeduž nepřijde.
Extrahované hodnoty. Každá hodnota má
origin: partner_upload. Zpráva s několika daty odběru
dá každé hodnotě její vlastní tested_at. Nikdy není planned: nahrání nic neobjednává.Chybové odpovědi
| Stav | Popis |
|---|---|
304 | Nezměněno — etag v If-None-Match stále odpovídá. Bez těla. |
400 | Neplatný formát ID. |
403 | Tvůj API klíč nemá scope results_view. |
404 | Pod žádnou z tvých skupin profilů není nahraný dokument s tímto ID. |
500 | Interní chyba serveru. |
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
}
]
}