Dokumenty
Pobierz wyniki z dokumentu
Odczytaj status i wyodrębnione wartości laboratoryjne przesłanego przez ciebie 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
}
]
}
Odczytaj status i wartości laboratoryjne dokumentu przesłanego przez
Prześlij dokument. Odpowiedź ma taki sam kształt jak
Pobierz wyniki laboratoryjne dla wizyty. Zobacz
Wyniki, aby sprawdzić każde pole.
Dostępne są tylko dokumenty przesłane w grupie profili, w której twój klucz odczytuje wyniki. Każdy inny
dokument zwraca
404: odczytaj jego wyniki w ramach wizyty lub zamówienia domowego zestawu testowego, z których pochodzi.
Nie musisz cyklicznie odpytywać API. Zasubskrybuj webhooki document.results.updated lub document.results.completed
i wywołaj ten endpoint, gdy nadejdzie zdarzenie.
Wymaga zakresu results_view w grupie profili, w której przesłano dokument.
Żądanie
Parametry ścieżki
Nagłówki
ETag z poprzedniej odpowiedzi. Gdy nic się nie zmieniło, API odpowiada 304 Not Modified bez
treści.Odpowiedź
W razie powodzenia API zwraca200 OK z obiektem wyników i nagłówkiem ETag.
Jedna z wartości:
in_progress— Aniva wyodrębnia wartości.completed— wyodrębnianie zakończone.fault— wyodrębnianie nie powiodło się.stored— dokument nie ma wartości: został przesłany bezextract_resultsalbo nie zawiera wyników laboratoryjnych.storedto status końcowy: nie pojawi się po nim webhookdocument.results.completed.
Wyodrębnione wartości. Każda wartość ma
origin: partner_upload. W raporcie z kilkoma datami
pobrania każda wartość otrzymuje własne tested_at. Nigdy planned: przesłanie pliku niczego nie zamawia.Odpowiedzi z błędami
| Status | Opis |
|---|---|
304 | Niezmodyfikowano — etag z If-None-Match nadal pasuje. Brak treści. |
400 | Nieprawidłowy format ID. |
403 | Twój klucz API nie ma zakresu results_view. |
404 | Żaden dokument przesłany w jednej z twoich grup profili nie ma tego ID. |
500 | Wewnętrzny błąd serwera. |
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
}
]
}