Przejdź do głównej treści
POST
Utwórz nowy profil pacjenta i przypisz go do grupy profili. Profil przechowuje dane demograficzne wykorzystywane w wizytach i zleceniach laboratoryjnych. Wymaga zakresu create_user. Wyślij opcjonalny nagłówek Idempotency-Key, aby ponawianie tego żądania utworzenia było bezpieczne — powtórzenie tego samego klucza zwraca pierwotną odpowiedź zamiast tworzyć kolejną wizytę. Zobacz Idempotentność.

Żądanie

Parametry treści

string
wymagane
Imię pacjenta. Musi zawierać znaki łacińskie, od 1 do 100 znaków.
string
wymagane
Nazwisko pacjenta. Musi zawierać znaki łacińskie, od 1 do 100 znaków. Laboratoria odrzucają zlecenia dla pacjenta bez nazwiska, więc bez niego nie można utworzyć profilu.Trzy wartości są zarezerwowane dla danych testowych — zobacz Dane testowe w środowisku sandbox.
integer
wymagane
Płeć biologiczna według ISO/IEC 5218. Użyj 1 dla mężczyzny, 2 dla kobiety. Laboratorium potrzebuje tej informacji do określenia zakresów referencyjnych, więc 0 (nieznana) zwraca 400. Wymagane, chyba że twoja grupa profili pozwala pacjentowi podać płeć na stronie aktywacji zestawu. Wtedy pomiń to pole. Zobacz Pozwól pacjentowi podać datę urodzenia i płeć.
string
wymagane
Data urodzenia w formacie YYYY-MM-DD. Musi być w przeszłości i nie przed 1900 rokiem. Wynikający z niej wiek musi mieścić się w przedziale od 16 do 100 lat. Inne wartości zwracają 400. Wymagane, chyba że twoja grupa profili pozwala pacjentowi podać ją na stronie aktywacji zestawu. Wtedy pomiń to pole.
string
wymagane
Polimorficzne odniesienie (UUID lub slug) do grupy profili, do której chcesz przypisać ten profil. UUID jest niezmiennym identyfikatorem i pozostaje ważny po zmianie sluga; slug nadal jest akceptowany w integracjach marketingowych i partnerskich opartych na czytelnych identyfikatorach. Preferowany jest UUID. Grupa profili musi znajdować się w kontekście dostępu twojego klucza API. Wymagane, chyba że wysyłasz przestarzałe pole profile_group_slug.
string
przestarzałe
Przestarzałe: użyj profile_group. Slug grupy profili. Tylko małe litery, cyfry, łączniki i podkreślenia.
string
Adres e-mail dla profilu. Jeśli go pominiesz, Aniva wygeneruje adres e-mail automatycznie.Podanie pola email sprawia też, że utworzenie profilu jest bezpieczne przy ponawianiu: jeden adres może mieć tylko jeden profil, więc powtórzone żądanie zwraca 409 zamiast drugiego profilu. Automatycznie generowane adresy są unikalne dla każdego żądania. Wyślij email lub nagłówek Idempotency-Key, jeśli twoja integracja ponawia żądania.
string
Numer telefonu w formacie E.164 (np. +14155552671).
number
Wzrost w centymetrach.
number
Waga w kilogramach.
string
domyślnie:"en"
Preferowany język profilu: 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 lub uk. Domyślnie en.
boolean
Czy ten profil ma otrzymywać e-maile transakcyjne (automatyczne) — potwierdzenia wizyt, powiadomienia o gotowych wynikach itp. Nadpisuje ustawienie domyślne grupy profili. Niezależne od zgody marketingowej. Pomiń, aby użyć ustawienia domyślnego.
boolean
Czy ten profil wyraża zgodę na e-maile marketingowe (newslettery, informacje o nowościach). Nadpisuje ustawienie domyślne grupy profili. Niezależne od e-maili transakcyjnych. Pomiń, aby użyć ustawienia domyślnego grupy profili. Tylko do zapisu: nie jest zwracane w odpowiedzi profilu.

Dane testowe w środowisku sandbox

Każda ścieżka odczytu warta przetestowania — Wyświetl wizyty, Pobierz wyniki, Pobierz dokument — jest pusta, dopóki kilka dni później nie odbędzie się prawdziwe pobranie krwi. To utrudnia napisanie automatycznego testu integracyjnego. Aby to rozwiązać, zarezerwowano trzy wartości last_name. Utwórz profil z jedną z nich, a Aniva przed wysłaniem odpowiedzi wstępnie wypełni stan opisany poniżej, więc twoje kolejne wywołanie od razu go zobaczy: Dopasowanie nie uwzględnia wielkości liter. Każde inne pole — w tym date_of_birth i sex — jest zapisywane i używane normalnie, więc otrzymywane zakresy referencyjne to rzeczywiste zakresy dopasowane do wieku i płci utworzonego profilu. Wizyta jest rezerwowana w lokalizacji Aniva Test, w rzeczywistym wolnym terminie za co najmniej pięć dni (lub pięć dni temu w przypadku stanów przeszłych). Jej wygenerowanie nie składa zlecenia laboratoryjnego i nie zamawia kuriera.
Podaj w profilach testowych adres, który kontrolujesz. Przypomnienia o wizytach w Aniva zależą od scheduled_at, więc zestaw testowy dla nadchodzącej wizyty je wyśle, chyba że wyłączysz je w profilu przez transactional_emails_enabled: false.
Panel jest wybierany losowo spośród tych, które widzi twój klucz API, więc jego panel_id zawsze odpowiada pozycji z twojej Listy paneli. Biomarkery kliniczne otrzymują wartość z zakresu referencyjnego danego biomarkera; geny otrzymują losowy genotyp z danych referencyjnych Aniva wraz z wynikającymi z niego pasującymi wariantami, znaczeniem klinicznym i identyfikatorami rs.
Panel i wartości są generowane na nowo przy każdym utworzeniu, więc w testach sprawdzaj strukturę, a nie konkretny panel czy dokładne liczby.

Odpowiedź

Po pomyślnym wykonaniu API zwraca 201 Created z nowo utworzonym profilem.
string
wymagane
Unikalny identyfikator profilu (UUID).
string
Handle lub nazwa użytkownika profilu. Może mieć wartość null.
string
Imię. Może mieć wartość null.
string
Nazwisko. Może mieć wartość null.
string
Adres e-mail. Może mieć wartość null.
string
Numer telefonu w formacie E.164. Może mieć wartość null.
integer
Płeć biologiczna wg ISO/IEC 5218 (0 = nieznana, 1 = męska, 2 = żeńska). Może mieć wartość null.
string
Data urodzenia w formacie YYYY-MM-DD. Może mieć wartość null.
number
Wzrost w centymetrach. Może mieć wartość null.
number
Masa ciała w kilogramach. Może mieć wartość null.
string
Preferowany język, jeden z 32 powyższych kodów.
boolean
Czy ten profil otrzymuje e-maile transakcyjne (automatyczne). null, jeśli nigdy nie ustawiono.
string
Znacznik czasu ISO 8601 utworzenia profilu.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. null dla nowo utworzonych profili.

Odpowiedzi z błędami

Odpowiedź 409 wygląda tak — potraktuj ją jako „ten profil już istnieje” i wyszukaj go za pomocą Listy profili (?email=) zamiast ponawiać tworzenie:
Osoba o takim samym imieniu, nazwisku, płci i dacie urodzenia jak profil widoczny dla twojego klucza otrzymuje 409 z error_name: "duplicate_profile_error". Użyj zwróconego profile_id zamiast tworzyć drugi profil:
Nazwiska w środowisku sandbox, które generują dane testowe, są z tego wyłączone.