Zum Hauptinhalt springen
GET
Rufe klinische und genetische Laborergebnisse für einen Termin ab, zusammen mit Dokumentreferenzen für Laborbericht-PDFs. Jeder für den Termin bestellte Biomarker erscheint in der Antwort, damit du den gesamten Auftrag nachverfolgen kannst und nicht nur das, was bereits zurückgekommen ist. Lies status bei jedem Ergebnis, bevor du dessen value verwendest:
  • Noch ausstehende Tests erscheinen mit dem Status planned, solange der Termin in_progress ist.
  • 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, der erklärt, warum. Bei einem fault-Ergebnis ist value weiterhin befüllt – dieser Wert ist falsch. Stelle ihn niemals als Befund dar.
  • 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 nicht ohne Prüfung als Befund an.
Jedes eingegangene Ergebnis und Dokument trägt den lab_code (Röhrchen-Barcode), unter dem es erfasst wurde, und das Array submissions listet jeden Laborauftrag der Blutabnahme mit seinem eigenen Status auf – eine Blutabnahme über mehrere Röhrchen oder Labore wird Auftrag für Auftrag abgeschlossen. Nutze Dokument herunterladen, um die im Array documents referenzierten Laborbericht-PDFs herunterzuladen. Du musst diesen Endpunkt nicht per Polling abfragen. Abonniere die Webhooks appointment.results.updated oder appointment.results.completed und rufe den Endpunkt auf, wenn ein Event eintrifft. Polling funktioniert weiterhin als Fallback. Erfordert den Scope results_view.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) des Termins, für den 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-Key 60 Minuten lang. Ein erneuter Aufruf innerhalb dieser Zeit erhält die gespeicherte Antwort, solange der Termin und seine Ergebnisse unverändert sind. 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 von einer Änderung zu erfahren, abonniere die Webhook-Events appointment.results.updated, appointment.results.completed und appointment.results.fault. Siehe Wiederholte Abrufe.

Fehlerantworten