Zum Hauptinhalt springen
POST
Erstelle ein neues Patientenprofil und weise es einer Profilgruppe zu. Das Profil enthält demografische Daten, die für Termine und Laboraufträge verwendet werden. Erfordert den Scope create_user. Sende einen optionalen Idempotency-Key-Header, damit sich das Erstellen sicher wiederholen lässt – bei Wiederholung mit demselben Schlüssel kommt die ursprüngliche Antwort zurück, statt einen zweiten Termin zu erstellen. Siehe Idempotenz.

Anfrage

Body-Parameter

string
erforderlich
Vorname des Patienten. Muss lateinische Zeichen verwenden, zwischen 1 und 100 Zeichen.
string
erforderlich
Nachname des Patienten. Muss lateinische Zeichen verwenden, zwischen 1 und 100 Zeichen. Labore lehnen Aufträge für Patienten ohne Nachnamen ab, daher kann kein Profil ohne Nachnamen erstellt werden.Drei Werte sind für vordefinierte Testdaten reserviert – siehe Sandbox-Testdaten.
integer
erforderlich
Biologisches Geschlecht nach ISO/IEC 5218. Verwende 1 für männlich, 2 für weiblich. Das Labor benötigt es für die Referenzbereiche, daher gibt 0 (unbekannt) 400 zurück. Erforderlich, es sei denn, deine Profilgruppe lässt Patienten es auf der Kit-Aktivierungsseite eingeben. Lass es dann weg. Siehe Patienten Geburtsdatum und Geschlecht eingeben lassen.
string
erforderlich
Geburtsdatum im Format YYYY-MM-DD. Muss in der Vergangenheit liegen und darf nicht vor 1900 sein. Das sich daraus ergebende Alter muss zwischen 16 und 100 liegen. Andere Werte geben 400 zurück. Erforderlich, es sei denn, deine Profilgruppe lässt Patienten es auf der Kit-Aktivierungsseite eingeben. Lass es dann weg.
string
erforderlich
Polymorphe Referenz (UUID oder Slug) auf die Profilgruppe, der dieses Profil zugewiesen wird. Die UUID ist die unveränderliche Kennung und bleibt auch bei Umbenennungen des Slugs gültig; der Slug wird weiterhin für Marketing- und Partnerintegrationen mit lesbaren Kennungen akzeptiert. Die UUID wird bevorzugt. Die Profilgruppe muss im Zugriffskontext deines API-Schlüssels liegen. Erforderlich, sofern du nicht das veraltete Feld profile_group_slug sendest.
string
veraltet
Veraltet: Verwende profile_group. Slug der Profilgruppe. Nur Kleinbuchstaben, Ziffern, Bindestriche und Unterstriche.
string
E-Mail-Adresse für das Profil. Wenn weggelassen, generiert Aniva automatisch eine E-Mail-Adresse.Die Angabe von email macht das Erstellen außerdem wiederholungssicher: Eine Adresse kann immer nur ein Profil haben, sodass eine wiederholte Anfrage 409 statt eines zweiten Profils zurückgibt. Automatisch generierte Adressen sind pro Anfrage eindeutig. Sende email oder einen Idempotency-Key, wenn deine Integration Anfragen wiederholt.
string
Telefonnummer im E.164-Format (z. B. +14155552671).
number
Körpergröße in Zentimetern.
number
Gewicht in Kilogramm.
string
Standard:"en"
Bevorzugte Sprache für das Profil: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr oder uk. Standardwert ist en.
boolean
Ob dieses Profil transaktionale (programmatische) E-Mails erhalten soll – Terminbestätigungen, Benachrichtigungen über vorliegende Ergebnisse usw. Überschreibt den Standard der Profilgruppe. Unabhängig vom Marketing-Opt-in. Weglassen, um den Standard zu verwenden.
boolean
Ob dieses Profil Marketing-E-Mails (Newsletter, Produktupdates) zustimmt. Überschreibt den Standard der Profilgruppe. Unabhängig von transaktionalen E-Mails. Weglassen, um den Standard der Profilgruppe zu verwenden. Nur schreibbar: wird in der Profil-Antwort nicht zurückgegeben.

Sandbox-Testdaten

Jeder testenswerte Lesepfad – Termine auflisten, Ergebnisse abrufen, Dokument herunterladen – ist leer, bis Tage später eine echte Blutabnahme stattfindet. Das macht automatisierte Integrationstests umständlich zu schreiben. Drei last_name-Werte sind reserviert, um das zu lösen. Erstelle ein Profil mit einem davon, und Aniva füllt den unten beschriebenen Zustand vor der Antwort vorab aus, sodass dein nächster Aufruf ihn bereits sieht: Groß- und Kleinschreibung spielen keine Rolle. Jedes andere Feld – einschließlich date_of_birth und sex – wird normal gespeichert und verwendet, sodass die zurückgegebenen Referenzbereiche den echten alters- und geschlechtsspezifischen Bereichen des erstellten Profils entsprechen. Der Termin wird am Standort Aniva Test in einem tatsächlich buchbaren Zeitfenster gebucht, mindestens fünf Tage in der Zukunft (oder vor fünf Tagen bei vergangenen Zuständen). Beim Seeding wird kein Laborauftrag erteilt und kein Kurier gebucht.
Gib Testprofilen eine Adresse, die du kontrollierst. Die Terminerinnerungen von Aniva werden über scheduled_at gesteuert, sodass das Fixture für bevorstehende Termine sie versendet, wenn das Profil nicht über transactional_emails_enabled: false abgemeldet ist.
Das Panel wird zufällig aus den Panels gewählt, die dein API-Key sehen kann, sodass sich die panel_id immer über dein eigenes Panels auflisten auflösen lässt. Klinische Biomarker erhalten einen Wert innerhalb ihres Referenzbereichs; Gene erhalten einen zufälligen Genotyp aus den Referenzdaten von Aniva, aus dem sich die passenden Varianten, die klinische Signifikanz und die rs-IDs ergeben.
Panel und Werte werden bei jedem Erstellen neu generiert, prüfe daher die Struktur statt eines bestimmten Panels oder exakter Zahlen.

Antwort

Bei Erfolg gibt die API 201 Created mit dem neu erstellten Profil zurück.
string
erforderlich
Eindeutige Profil-ID (UUID).
string
Profil-Handle oder Benutzername. Kann null sein.
string
Vorname. Kann null sein.
string
Nachname. Kann null sein.
string
E-Mail-Adresse. Kann null sein.
string
Telefonnummer im E.164-Format. Kann null sein.
integer
Biologisches Geschlecht nach ISO/IEC 5218 (0 = unbekannt, 1 = männlich, 2 = weiblich). Kann null sein.
string
Geburtsdatum im Format YYYY-MM-DD. Kann null sein.
number
Körpergröße in Zentimetern. Kann null sein.
number
Gewicht in Kilogramm. Kann null sein.
string
Bevorzugte Sprache, einer der 32 Codes oben.
boolean
Ob dieses Profil transaktionale (programmatische) E-Mails erhält. null, wenn noch nie gesetzt.
string
ISO-8601-Zeitstempel der Profilerstellung.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. null bei neu erstellten Profilen.

Fehlerantworten

Ein 409 sieht so aus – behandle ihn als „Dieses Profil existiert bereits“ und schlage das Profil über Profile auflisten (?email=) nach, statt das Erstellen erneut zu versuchen:
Eine Person mit demselben Vornamen, Nachnamen, Geschlecht und Geburtsdatum wie ein Profil, das dein Key sehen kann, erhält einen 409 mit error_name: "duplicate_profile_error". Verwende die zurückgegebene profile_id, statt ein zweites Profil zu erstellen:
Die Sandbox-Nachnamen, die Testdaten erzeugen, sind davon ausgenommen.