Zum Hauptinhalt springen
GET
Rufe eine Liste der Blutabnahme-Termine ab. Jeder Termin enthält das eingebettete Patientenprofil. Die Filter lassen sich kombinieren:
  • date gibt die Termine an einem Kalendertag zurück. Der Tag richtet sich nach der Ortszeit des jeweiligen Terminstandorts, sodass eine Blutabnahme um 23:30 Uhr in Berlin zu ihrem Berliner Datum zählt.
  • location_id gibt die Termine an einem Teststandort zurück.
  • profile_id ohne date gibt alle Termine für dieses Profil ohne zeitliche Einschränkung zurück.
  • Ohne profile_id und ohne date gilt der Standardzeitraum: letzte 2 Monate bis 1 Monat in die Zukunft.
Erfordert den Scope appointments_view oder appointments_schedule.

Anfrage

Query-Parameter

string
Nach Profil-UUID filtern. Bei Angabe werden alle Termine dieses Profils unabhängig vom Termindatum zurückgegeben. Ohne Angabe gilt der Standardzeitraum.
string
Nach Teststandort-UUID filtern.
string
Kalendertag im Format YYYY-MM-DD, in der Zeitzone des jeweiligen Terminstandorts. Ersetzt den Standardzeitraum. Die Ergebnisse sind nach scheduled_at sortiert, früheste zuerst.

Antwort

Bei Erfolg gibt die API 200 OK mit einem Array von Termin-Objekten zurück.
string
erforderlich
Eindeutige Terminkennung (UUID).
string
erforderlich
UUID des Profils, zu dem dieser Termin gehört.
string
UUID des Teststandorts, an dem die Blutabnahme stattfindet.
string
Geplanter Terminzeitpunkt in UTC (ISO 8601 mit Z-Suffix, z. B. 2026-05-15T10:30:00Z). Kann null sein.
string
erforderlich
Aktueller Terminstatus. Einer von pending, confirmed, blood_drawn oder cancelled. Wie vollständig die Laborergebnisse sind, ergibt sich aus Ergebnisse abrufen; den genaueren Versandverlauf siehst du über jeden Eintrag im eingebetteten shipments-Array (siehe unten) in Kombination mit Sendung abrufen.
string
Freitextgrund, der bei der Stornierung des Termins erfasst wurde (z. B. Nichterscheinen, späte Stornierung, ‘Fehlgeschlagen. Wiederholung erforderlich’). null, sofern status nicht cancelled ist.
string[]
erforderlich
Adressen in Kleinbuchstaben, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Leer, wenn deaktiviert. Siehe E-Mails bei fertigen Ergebnissen.
string
erforderlich
Art der Blutabnahme: capillary (aus der Fingerkuppe oder dem Oberarm, in Microtainer) oder venous (aus der Vene, in Röhrchen). Entspricht der im Termin festgelegten Methode, sonst der default_draw_method des Standorts. Nach der Blutabnahme ist es die verwendete Methode.
string
erforderlich
ISO-8601-Zeitstempel der Erstellung des Termins.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. Kann null sein.
object
erforderlich
Das mit diesem Termin verknüpfte Patientenprofil.
AppointmentPanel[]
erforderlich
Panels, die derzeit diesem Termin zugeordnet sind. Stornierte Zuordnungen sind ausgeschlossen. Panel-Details (Name, Biomarker) findest du über Panels auflisten.
AppointmentIndividualBiomarker[]
erforderlich
Einzel-Biomarker, die außerhalb eines Panels mit diesem Termin verknüpft sind (siehe Eigene Biomarker hinzufügen). Gleiche jede biomarker_id für Anzeigedaten mit Biomarker auflisten ab.
AppointmentShipmentLink[]
erforderlich
Sendungen, die mit diesem Termin verknüpft sind, älteste Verknüpfung zuerst. Leeres Array, wenn keine Sendungen verknüpft sind. Gleiche jede id mit Sendung abrufen ab, um die vollständigen Sendungsdaten (Status, Sendungsnummer, Statusaktualisierungen usw.) zu erhalten.
string[]
erforderlich
Laborcodes (Röhrchen-Barcodes), die für diesen Termin erfasst wurden, in Scan-Reihenfolge. Leer, bis die Blutabnahme bestätigt wird. Eine venöse Blutabnahme hat einen Code, der auf jedem Röhrchen steht; eine kapillare Blutabnahme hat einen Code pro Microtainer. Ergebnisse und Dokumente unter Ergebnisse abrufen verweisen über lab_code auf diese Codes.

Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für jeden API-Key 5 Minuten lang. Ein erneuter Aufruf innerhalb dieser Zeit erhält die gespeicherte 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.created, appointment.rescheduled sowie das Event für jeden Status, zum Beispiel appointment.confirmed. Siehe Wiederholte Abrufe.

Fehlerantworten