Dokumentit
Hae dokumentin tulokset
Lue palveluun lataamasi dokumentin tila ja siitä poimitut laboratorioarvot
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
}
]
}
Lue Lähetä asiakirja -päätepisteellä lähettämäsi asiakirjan tila ja
laboratorioarvot. Vastauksella on sama rakenne kuin ajanvarauksen
Hae laboratoriotulokset -vastauksella. Katso kaikki kentät sivulta
Tulokset.
Vastauksen saa vain asiakirjoista, jotka on lähetetty profiiliryhmään, jonka tuloksia avaimesi lukee. Kaikki muut
asiakirjat palauttavat tilan
404: lue niiden tulokset sen ajanvarauksen tai kotitestipakkaustilauksen kautta, joka ne tuotti.
Sinun ei tarvitse kysellä tilaa toistuvasti. Tilaa document.results.updated- tai
document.results.completed-webhookit ja kutsu tätä päätepistettä, kun tapahtuma saapuu.
Vaatii results_view-scopen profiiliryhmälle, johon asiakirja lähetettiin.
Pyyntö
Polkuparametrit
Otsakkeet
Aiemman vastauksen
ETag. Kun mikään ei ole muuttunut, API vastaa 304 Not Modified ilman
runkoa.Vastaus
Onnistuessaan API palauttaa tilan200 OK, tulosobjektin ja ETag-otsakkeen.
Jokin seuraavista:
in_progress— Aniva poimii arvoja.completed— poiminta valmistui.fault— poiminta epäonnistui.stored— asiakirjassa ei ole arvoja: lähetit sen ilmanextract_results-kenttää tai siinä ei ole laboratoriotuloksia.storedon lopullinen tila: sitä ei seuraadocument.results.completed-webhook.
Poimitut arvot. Jokaisella arvolla on
origin: partner_upload. Jos raportissa on useita
näytepäiviä, kukin arvo saa oman tested_at-arvonsa. Ei koskaan planned: lähetys ei tilaa mitään.Virhevastaukset
| Tila | Kuvaus |
|---|---|
304 | Ei muutettu — If-None-Match-otsakkeen etag täsmää yhä. Ei runkoa. |
400 | Virheellinen tunnuksen muoto. |
403 | API-avaimeltasi puuttuu results_view-scope. |
404 | Yhdessäkään profiiliryhmistäsi ei ole tällä tunnuksella lähetettyä asiakirjaa. |
500 | Sisäinen palvelinvirhe. |
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
}
]
}