Zum Hauptinhalt springen
GET
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

string
erforderlich
Dokument-ID (UUID) aus der Upload-Antwort.
string
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 API 200 OK mit dem Ergebnisobjekt und einem ETag-Header zurück.
string
erforderlich
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 ohne extract_results hochgeladen oder es enthält keine Laborergebnisse. stored ist endgültig: Es folgt kein document.results.completed-Webhook.
object[]
erforderlich
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.
object[]
erforderlich
Genetische Ergebnisse. Für ein hochgeladenes Dokument derzeit leer.
object[]
erforderlich
Das hochgeladene Dokument selbst.
object[]
erforderlich
Ein Eintrag für den Upload. lab_code ist null.

Fehlerantworten