Zum Hauptinhalt springen
Die Aniva Partner API ist eine REST-API, mit der Partner im Gesundheitswesen Patientenprofile verwalten, Termine für Blutabnahmen an Teststandorten planen und Laborauftrags-Pipelines auslösen können. Du greifst über HTTPS mit deinem Partner-API-Schlüssel auf die API zu.

Was du tun kannst

  • Profilverwaltung – Demografische Patientenprofile erstellen, abrufen und aktualisieren.
  • Terminplanung – Termine für Blutabnahmen an Aniva-Teststandorten buchen.
  • Panel-Verwaltung – Labortest-Panels zu einem bestehenden Termin hinzufügen oder entfernen.
  • Einzelne Biomarker – Einzelne Biomarker einem Termin hinzufügen oder von ihm entfernen, ohne ein Panel auszuwählen.
  • Heimtest-Kit-Bestellungen – Ein Heimtest-Kit per Post an einen Patienten senden, dessen Pakete verfolgen und melden, wann die Probe abgenommen wurde.
  • Panel-Katalog – Verfügbare Panels mit GET /api/v1/panels durchsuchen, um Panel-IDs und die enthaltenen Biomarker abzurufen.
  • Biomarker-Katalog – Die Biomarker, die du an einem Standort oder in einem Heimtest-Kit bestellen kannst, mit GET /api/v1/biomarkers durchsuchen, um IDs abzurufen.
  • Bestätigung der Blutabnahme – Nach einer Blutabnahme die Laborcode(s) übermitteln, um die Laborauftrags-Pipeline auszulösen.
  • Laborergebnisse – Klinische und genetische Ergebnisse abrufen und Laborberichte als PDF herunterladen.
  • Standortsuche – Verfügbare Teststandorte auflisten, um sie Patienten anzuzeigen.
  • Versandlogistik – Kurierversandaufträge erstellen, verfolgen, ändern und stornieren.
  • Webhooks – Einen HTTPS-Aufruf erhalten, wenn sich ein Termin, eine Heimtest-Kit-Bestellung, ihre Ergebnisse, ein Standort, ein Profil oder eine Sendung ändert. Siehe Webhooks.

Dokumentation entdecken

Authentifizierung

Authentifiziere Anfragen mit deinem Partner-API-Schlüssel.

Schnellstart

Führe mit Schritt-für-Schritt-Beispielen in wenigen Minuten deinen ersten API-Aufruf durch.

Profile

Erfahre, wie Patientenprofile funktionieren und welche Daten sie enthalten.

Termine

Verstehe den Lebenszyklus eines Termins von der Planung bis zur Bestätigung.

Heimtest-Kit-Bestellungen

Sende ein Test-Kit zu einem Patienten nach Hause und verfolge es, bis die Probe das Labor erreicht.

API-Versionierung

Die aktuelle API-Version ist v1. Alle Endpunkte haben das Präfix /api/v1/. Die Basis-URL lautet https://anivahealth.com.
Nicht abwärtskompatible Änderungen werden unter einem neuen Versionspräfix eingeführt. Die v1-API bleibt verfügbar, und Abkündigungen werden vorab mitgeteilt.

Datumsangaben und Zeitzonen

Alle Zeitpunkte bei der Übertragung verwenden UTC ISO 8601 (Z-Suffix). Reine Kalenderfelder verwenden Teile der Ortszeit (YYYY-MM-DD, HH:MM). Besondere Hinweise:
  • Eingaben mit Datum und Uhrzeit (z. B. scheduled_at bei POST / PATCH /api/v1/appointments) müssen eine Zeitzonenangabe enthalten – entweder Z oder einen expliziten Offset wie +02:00. Zeitangaben ohne Zeitzone werden mit 400 abgelehnt. Beide Formen kodieren denselben Zeitpunkt; die Antwort gibt scheduled_at immer als UTC Z zurück. Nutze das Feld timezone des Standorts (oder eine andere IANA-Kennung), um den Zeitpunkt bei der Anzeige in der lokalen Ortszeit zu formatieren.
  • Ortszeit-Eingaben werden in der Zeitzone der jeweiligen Zielressource interpretiert: Datumsangaben für Verfügbarkeiten verwenden den Query-Parameter timezone (Standard ist die Zeitzone des Standorts); pickup_date / pickup_time_* einer Sendung werden in der Zeitzone des Ausgangsstandorts interpretiert.
  • Reine Datumsfelder in Antworten (z. B. tested_at, Verfügbarkeit availability[].date) sind Kalenderdaten ohne Zeitzone.

Zugang erhalten

API-Schlüssel werden von Aniva pro Partner ausgestellt.
Kontaktiere Aniva, um deinen Partner-API-Schlüssel zu erhalten.