Zum Hauptinhalt springen
GET
Rufe klinische und genetische Laborergebnisse für eine Heimtest-Kit-Bestellung ab, zusammen mit Dokumentreferenzen für Laborbericht-PDFs. Jeder für das Kit bestellte Biomarker erscheint in der Antwort, sodass du die gesamte Bestellung verfolgen kannst und nicht nur die bereits vorliegenden Werte. Die Ergebnisse laufen unter dem lab_code der Bestellung ein – der Laborauftrag wird bei der Aktivierung ausgelöst und das Labor meldet die Marker einzeln, sobald sie analysiert sind, sodass eine Teilantwort normal ist und der übergeordnete status bis zum Abschlussbericht in_progress bleibt. Prüfe status bei jedem Ergebnis, bevor du dessen value verwendest:
  • Noch ausstehende Tests erscheinen mit dem Status planned, solange die Bestellung in_progress ist. Du kannst diesen Endpunkt bereits vor der Aktivierung aufrufen – jeder bestellte Marker hat dann den Status planned.
  • Ergebnisse, die das Labor geliefert hat, die aber klinisch nicht verwendet werden dürfen, erscheinen mit dem Status fault oder undeliverable und enthalten einen status_reason mit der Begründung. Bei einem Ergebnis mit dem Status fault ist value weiterhin befüllt – dieser Wert ist falsch. Zeige ihn niemals als Befund an.
  • Ergebnisse, die Aniva oder das Mitglied anzweifelt, erscheinen mit dem Status likely_wrong und einem status_reason. Der Wert ist nicht bestätigt. Zeige ihn ohne Prüfung nicht als Befund an.
Nutze Dokument herunterladen, um die im Array documents referenzierten Laborbericht-PDFs herunterzuladen. Du musst diesen Endpunkt nicht regelmäßig abfragen. Abonniere die Webhooks home_kit_order.results.updated oder home_kit_order.results.completed und rufe den Endpunkt auf, wenn ein Event eintrifft. Polling funktioniert weiterhin als Fallback. Erfordert den Scope results_view – Laborergebnisse und Dokumente sind immer daran gebunden, genau wie Terminergebnisse und Dokument herunterladen – sowie den Scope home_kit_orders_view oder home_kit_orders_manage für den Zugriff auf die Kit-Bestellung selbst.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung, für die Ergebnisse abgerufen werden sollen.

Antwort

Bei Erfolg gibt die API 200 OK mit dem Ergebnisobjekt zurück.
string
erforderlich
Gesamtstatus der Ergebnisse. Einer der folgenden Werte:
  • in_progress – einige Aufträge sind noch im Labor.
  • completed – jeder Auftrag ist abgeschlossen und mindestens einer hat einen Bericht geliefert.
  • fault – jeder Auftrag ist ohne Bericht fehlgeschlagen. Es steht nichts mehr aus.
object[]
erforderlich
Ein Eintrag pro Laborauftrag – eine Blutabnahme über mehrere Röhrchen oder Labore hat mehrere Einträge. Der übergeordnete status ist completed, sobald jeder Eintrag abgeschlossen ist und einer einen Bericht geliefert hat.
object[]
erforderlich
Array mit klinischen Biomarker-Ergebnissen.
object[]
erforderlich
Array mit genetischen Biomarker-Ergebnissen.
object[]
erforderlich
Laborbericht-Dokumente. Nutze GET /api/v1/documents/{id}, um jede Datei herunterzuladen.

Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für jeden API-Schlüssel 60 Minuten lang. Ein wiederholter Aufruf innerhalb dieser Zeit erhält die gespeicherte Antwort, solange die Heimtest-Kit-Bestellung und ihre Ergebnisse unverändert bleiben. Nach einer Änderung erhältst du eine aktuelle Antwort. Die Header Cache-Status und Age zeigen, dass die Antwort gespeichert ist und wie alt sie ist. Um sofort über eine Änderung informiert zu werden, abonniere die Webhook-Events home_kit_order.results.updated, home_kit_order.results.completed und home_kit_order.results.fault. Siehe Wiederholte Abrufe.

Fehlerantworten