> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Einführung

> Überblick über die Aniva Partner API, eine REST-API für Bluttests in Apotheken und Praxen, Heimtest-Kits und Laborergebnisse.

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](https://docs.anivahealth.com/de/concepts/webhooks.md).

## Dokumentation entdecken

> [card] [Authentifizierung](https://docs.anivahealth.com/de/authentication.md)
>
> Authentifiziere Anfragen mit deinem Partner-API-Schlüssel.

> [card] [Schnellstart](https://docs.anivahealth.com/de/quickstart.md)
>
> Führe mit Schritt-für-Schritt-Beispielen in wenigen Minuten deinen ersten API-Aufruf durch.

> [card] [Profile](https://docs.anivahealth.com/de/concepts/profiles.md)
>
> Erfahre, wie Patientenprofile funktionieren und welche Daten sie enthalten.

> [card] [Termine](https://docs.anivahealth.com/de/concepts/appointments.md)
>
> Verstehe den Lebenszyklus eines Termins von der Planung bis zur Bestätigung.

> [card] [Heimtest-Kit-Bestellungen](https://docs.anivahealth.com/de/concepts/home-kit-orders.md)
>
> 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`.

```text theme={null}
https://anivahealth.com/api/v1/
```

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`).

| Kategorie | Format | Verwendet für |
| - | - | - |
| **Zeitpunkt** | ISO 8601 in UTC (`Z`-Suffix, z. B. `2026-04-15T08:30:00Z`) | Jeder Zeitstempel in der Ausgabe – Termin `scheduled_at`, Verfügbarkeit `slots[]`, Sendung `pickup.from` / `pickup.till`, `created_at`, `updated_at`, `added_at`. Clientseitig in einer beliebigen lokalen Zeitzone darstellen. |
| **Anbieter-Ereignis** | ISO 8601 mit dem Offset des vorgelagerten Anbieters (unverändert durchgereicht) | Nur `status_updates[].time` bei Sendungen – der Offset entspricht der Angabe des Kuriers. |
| **Ortszeit** | `YYYY-MM-DD` für Datumsangaben, `HH:MM` für Uhrzeiten – ohne Offset | Reine Kalender- oder Uhrzeitwerte – `date_of_birth`, Ergebnisse `tested_at`, Verfügbarkeit `start_date` / `end_date`, Sendung `pickup_date` / `pickup_time_from` / `pickup_time_till`, Standort `open_hours`. |

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.

> [!NOTE]
>
> Kontaktiere Aniva, um deinen Partner-API-Schlüssel zu erhalten.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.