Dokumente
Dokumentergebnisse abrufen
Den Status und die extrahierten Laborwerte eines von dir hochgeladenen Dokuments auslesen
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
}
]
}
Lies den Status und die Laborwerte eines Dokuments aus, das du mit
Dokument hochladen hochgeladen hast. Die Antwort hat die gleiche
Struktur wie Laborergebnisse abrufen für einen Termin. Unter
Ergebnisse findest du alle Felder.
Nur Dokumente, die unter einer Profilgruppe hochgeladen wurden, für die dein Schlüssel Ergebnisse
lesen darf, geben eine Antwort zurück. Jedes andere Dokument gibt
404 zurück: Lies seine
Ergebnisse über den Termin oder die Heimtest-Kit-Bestellung aus, von denen es stammt.
Du musst nicht pollen. Abonniere die Webhooks document.results.updated
oder document.results.completed und rufe diesen Endpunkt auf, wenn ein Event eintrifft.
Erfordert den Scope results_view für die Profilgruppe, unter der das Dokument hochgeladen wurde.
Anfrage
Pfadparameter
Header
Der
ETag einer vorherigen Antwort. Wenn sich nichts geändert hat, antwortet die API mit
304 Not Modified ohne Body.Antwort
Bei Erfolg gibt die API200 OK mit dem Ergebnisobjekt und einem ETag-Header zurück.
Einer der folgenden Werte:
in_progress– Aniva extrahiert die Werte.completed– Extraktion abgeschlossen.fault– Extraktion fehlgeschlagen.stored– das Dokument hat keine Werte: Du hast es ohneextract_resultshochgeladen oder es enthält keine Laborergebnisse.storedist endgültig: Es folgt keindocument.results.completed-Webhook.
Die extrahierten Werte. Jeder Wert trägt
origin: partner_upload. Ein Bericht mit mehreren
Probenahmedaten gibt jedem Wert ein eigenes tested_at. Nie planned: Ein Upload bestellt
nichts.Fehlerantworten
| Status | Beschreibung |
|---|---|
304 | Nicht geändert – der If-None-Match-ETag stimmt noch überein. Kein Body. |
400 | Ungültiges ID-Format. |
403 | Deinem API-Schlüssel fehlt der Scope results_view. |
404 | Kein Dokument, das unter einer deiner Profilgruppen hochgeladen wurde, hat diese ID. |
500 | Interner Serverfehler. |
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
}
]
}