Zum Hauptinhalt springen
Mit dieser Anleitung erstellst du ein Patientenprofil und weist es deiner Profilgruppe zu. Profile sind der Ausgangspunkt, um Termine zu vereinbaren und Laboraufträge auszulösen.
1

Hol dir deine Profilgruppen-Referenz

Jedes Profil muss einer Profilgruppe zugewiesen werden, die zu deinem Partnerkonto gehört. Das Feld profile_group akzeptiert entweder die unveränderliche UUID der Gruppe oder ihren menschenlesbaren Slug – die UUID wird bevorzugt, da sie sich nie ändert und Umbenennungen des Slugs überdauert.Wenn du deine Profilgruppen-Referenz nicht kennst, kontaktiere Aniva, um sie zu erhalten. Ohne gültige Referenz kannst du keine Profile erstellen.
2

Profil erstellen

Sende eine POST-Anfrage an /api/v1/profiles mit den demografischen Daten des Patienten.
first_name und last_name sind beide erforderlich. Sie akzeptieren nur Buchstaben der lateinischen Schrift (einschließlich akzentuierter Buchstaben wie ü), Leerzeichen, Bindestriche und Apostrophe. Transliteriere Namen aus anderen Schriftsystemen, bevor du sie übermittelst.
Wenn du email weglässt, generiert Aniva automatisch eine Platzhalter-E-Mail-Adresse für das Profil. Du kannst sie später mit einer PATCH-Anfrage aktualisieren.
Das Feld language steuert die Sprache, in der Aniva mit dem Patienten kommuniziert – zum Beispiel bei Terminerinnerungen und Ergebnisbenachrichtigungen. Setze es auf die bevorzugte Sprache des Patienten. Unter Profil erstellen findest du die unterstützten Werte. Standardwert ist en.
Eine erfolgreiche Anfrage gibt 201 Created mit dem neuen Profilobjekt zurück:
Speichere die id – du brauchst sie, um Termine zu vereinbaren und das Profil zu aktualisieren.
3

Profil aktualisieren (optional)

Verwende PATCH /api/v1/profiles/{id}, um nach dem Erstellen beliebige Profilfelder zu aktualisieren. Alle Felder sind optional – gib nur die Felder an, die du ändern möchtest.Das folgende Beispiel fügt eine Telefonnummer und die Körpergröße hinzu:
Eine erfolgreiche Anfrage gibt 200 OK mit dem vollständigen aktualisierten Profilobjekt zurück.

Fehlerbehandlung