> ## 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.

# Profile

> So funktionieren Patientenprofile in der Aniva Partner API: Erstelle, aktualisiere und verknüpfe die Personen, für die du Bluttests und Heimtest-Kits buchst.

Ein Profil ist ein Datensatz, der einen Patienten oder Nutzer im Aniva-System abbildet. Jeder Termin, jeder Laborauftrag und jedes Ergebnis ist mit einem Profil verknüpft.

## Profilgruppen

Wenn du ein Profil erstellst, ordnest du es über den Parameter `profile_group` einer **Profilgruppe** zu. Eine Profilgruppe organisiert Profile unter deinem Partnerkonto und beschränkt sie auf ein bestimmtes Programm oder eine Integration.

Das Feld `profile_group` akzeptiert entweder die unveränderliche UUID der Gruppe oder ihren menschenlesbaren Slug. Die UUID ist die dauerhafte Referenz – sie ändert sich nie und bleibt auch bei Umbenennungen des Slugs bestehen. Der Slug ist für lesbare URLs und Partnerintegrationen gedacht.

Ein Wert für `profile_group` (UUID oder Slug) ist bei der Erstellung erforderlich. Das ältere Feld `profile_group_slug` wird weiterhin als veralteter Alias akzeptiert.

## Felder

**id** `string` *required*

Von Aniva automatisch generierte UUID. Verwende sie, um das Profil in anderen API-Aufrufen zu
referenzieren.

**handle** `string`

Ein optionaler Benutzername oder Handle für das Profil. Kann null sein.

**first\_name** `string`

Vorname des Patienten. Nur lateinische Zeichen, 1–100 Zeichen. Bei der Erstellung erforderlich.

**last\_name** `string`

Nachname des Patienten. Nur lateinische Zeichen, 1–100 Zeichen. Bei der Erstellung erforderlich –
Labore lehnen Aufträge für einen Patienten ohne Nachnamen ab. Kann bei Profilen null sein, die
erstellt wurden, bevor das Feld verpflichtend wurde.

**email** `string`

E-Mail-Adresse des Patienten. Wenn du bei der Erstellung keine angibst, generiert Aniva
automatisch eine Platzhalter-E-Mail-Adresse.

**phone** `string`

Telefonnummer im [E.164-Format](https://www.itu.int/rec/T-REC-E.164/en) (z. B. `+14155552671`).
Kann null sein.

**sex** `integer`

Biologisches Geschlecht nach [ISO/IEC 5218](https://www.iso.org/standard/36266.html): `1` =
männlich, `2` = weiblich. Bei der Erstellung erforderlich, es sei denn, deine Profilgruppe
erlaubt dem Patienten die Eingabe (siehe unten). Das Labor benötigt diese Angabe für die
Referenzbereiche, daher gibt das Erstellen oder Aktualisieren mit `0` (unbekannt) `400` zurück.
Profile, die vor dem 30. September 2026 erstellt wurden, können weiterhin `0` zurückgeben.

**date\_of\_birth** `string`

Geburtsdatum im Format `YYYY-MM-DD`. Bei der Erstellung erforderlich, es sei denn, deine
Profilgruppe lässt den Patienten es selbst eingeben (siehe unten). Muss in der Vergangenheit
liegen, nicht vor 1900, und ein Alter zwischen 16 und 100 ergeben; unplausible Werte werden mit
`400` abgelehnt. Das Geburtsdatum wird mit dem Auftrag an das Labor übermittelt und kann nach
Auftragserteilung nicht mehr geändert werden.

**height** `number`

Körpergröße in Zentimetern. Kann null sein.

**weight** `number`

Gewicht in Kilogramm. Kann null sein.

**language** `string`

Bevorzugte Sprache für die Kommunikation mit dem Patienten. Akzeptierte Werte: `en`, `de`, `fi`.

**transactional\_emails\_enabled** `boolean`

Ob das Profil Transaktions-E-Mails erhält, etwa Terminbestätigungen und Benachrichtigungen über
verfügbare Ergebnisse. Getrennt vom Marketing-Opt-in. Null, wenn nie festgelegt.

**created\_at** `string` *required*

ISO-8601-Zeitstempel der Profilerstellung.

**updated\_at** `string`

ISO-8601-Zeitstempel der letzten Aktualisierung. Null, wenn das Profil noch nie aktualisiert
wurde.

> [!NOTE]
>
> Die Felder `first_name`, `last_name`, `sex`, `date_of_birth` und `profile_group` sind beim
> Erstellen eines Profils erforderlich. Alle anderen Felder sind optional. Das ältere Feld
> `profile_group_slug` wird weiterhin als veralteter Alias für `profile_group` akzeptiert.

### Geburtsdatum und Geschlecht vom Patienten eingeben lassen

Wir können eine Einstellung für deine Profilgruppe aktivieren. Dann kannst du ein Profil ohne
`date_of_birth` und `sex` erstellen. Sag uns Bescheid, dann aktivieren wir sie. Ohne diese
Einstellung gibt eine Erstellung, bei der eines der beiden Felder fehlt, `400` zurück.

Der Patient gibt beides zusammen mit dem Kit-Code auf der Seite zur Kit-Aktivierung
(`anivahealth.com/activate`) ein. Die Seite fragt das Geburtsdatum zweimal ab, weil das Labor es
später nicht mehr ändern kann. Danach lässt sich das Kit nur noch mit diesem Geburtsdatum öffnen.
Bis der Patient beides eingegeben hat, halten wir den Laborauftrag zurück. Verwende diese
Einstellung nur für Heimtest-Kits.

## Lebenszyklus

Profile durchlaufen einen einfachen Lebenszyklus:

1. **Erstellen** – registriere das Profil mit den erforderlichen demografischen Feldern und einer `profile_group` (UUID
   oder Slug).
2. **Aktualisieren** (optional) – füge Felder wie `phone`, `height` oder `weight` hinzu oder ändere sie.
3. **Verknüpfen** – verbinde das Profil über seine `id` als `profile_id` mit Terminen.

Ein `profile.*`-[Webhook](https://docs.anivahealth.com/de/concepts/webhooks.md) informiert dich, wenn ein Profil hinzukommt, sich ändert oder gelöscht wird.

## Beispielprofil

```json theme={null}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "handle": "jdoe42",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+14155552671",
  "sex": 2,
  "date_of_birth": "1990-06-15",
  "height": 168.0,
  "weight": 65.0,
  "language": "en",
  "transactional_emails_enabled": true,
  "created_at": "2026-03-01T09:00:00Z",
  "updated_at": "2026-03-10T14:32:00Z"
}
```


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