Przejdź do głównej treści
Profil to rekord reprezentujący pacjenta lub użytkownika w systemie Aniva. Każda wizyta, zlecenie laboratoryjne i wynik są powiązane z profilem.

Grupy profili

Podczas tworzenia profilu przypisujesz go do grupy profili za pomocą parametru profile_group. Grupa profili porządkuje profile na twoim koncie partnerskim, przypisując je do konkretnego programu lub integracji. Pole profile_group przyjmuje niezmienny identyfikator UUID grupy albo jej czytelny slug. UUID to trwałe odniesienie — nigdy się nie zmienia i pozostaje aktualny po zmianie sluga. Slug służy do czytelnych adresów URL i integracji partnerskich. Wartość profile_group (UUID lub slug) jest wymagana przy tworzeniu profilu. Starsze pole profile_group_slug jest nadal akceptowane jako przestarzały alias.

Pola

string
wymagane
Identyfikator UUID wygenerowany automatycznie przez Aniva. Używaj go do wskazywania profilu w innych wywołaniach API.
string
Opcjonalna nazwa użytkownika lub identyfikator handle dla profilu. Może mieć wartość null.
string
Imię pacjenta. Wyłącznie znaki łacińskie, 1–100 znaków. Wymagane przy tworzeniu.
string
Nazwisko pacjenta. Wyłącznie znaki łacińskie, 1–100 znaków. Wymagane przy tworzeniu — laboratoria odrzucają zlecenia dla pacjenta bez nazwiska. Może mieć wartość null w profilach utworzonych przed wprowadzeniem tego wymogu.
string
Adres e-mail pacjenta. Jeśli nie podasz go przy tworzeniu, Aniva automatycznie wygeneruje zastępczy adres e-mail.
string
Numer telefonu w formacie E.164 (np. +14155552671). Może mieć wartość null.
integer
Płeć biologiczna według ISO/IEC 5218: 1 = mężczyzna, 2 = kobieta. Wymagana przy tworzeniu, chyba że twoja grupa profili pozwala pacjentowi ją wpisać (zobacz niżej). Laboratorium potrzebuje jej do wyznaczenia zakresów referencyjnych, więc utworzenie lub aktualizacja z wartością 0 (nieznana) zwraca 400. Profile utworzone przed 30 września 2026 r. mogą nadal zwracać 0.
string
Data urodzenia w formacie YYYY-MM-DD. Wymagana przy tworzeniu, chyba że twoja grupa profili pozwala pacjentowi ją wpisać (zobacz niżej). Musi być w przeszłości, nie wcześniej niż w 1900 r., i oznaczać wiek od 16 do 100 lat; nierealne wartości są odrzucane z kodem 400. Data urodzenia trafia do laboratorium na zleceniu i nie można jej zmienić po złożeniu zlecenia.
number
Wzrost w centymetrach. Może mieć wartość null.
number
Waga w kilogramach. Może mieć wartość null.
string
Preferowany język komunikacji z pacjentem. Akceptowane wartości: en, de, fi.
boolean
Czy profil otrzymuje wiadomości transakcyjne, takie jak potwierdzenia wizyt i powiadomienia o gotowych wynikach. Niezależne od zgody marketingowej. Wartość null, jeśli nigdy nie ustawiono.
string
wymagane
Znacznik czasu ISO 8601 utworzenia profilu.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Wartość null, jeśli profil nigdy nie był aktualizowany.
Pola first_name, last_name, sex, date_of_birth i profile_group są wymagane podczas tworzenia profilu. Wszystkie pozostałe pola są opcjonalne. Starsze pole profile_group_slug jest nadal akceptowane jako przestarzały alias dla profile_group.

Pozwól pacjentowi wpisać datę urodzenia i płeć

Możemy włączyć jedno ustawienie dla twojej grupy profili. Wtedy możesz utworzyć profil bez pól date_of_birth i sex. Poproś nas o jego włączenie. Bez niego utworzenie profilu bez któregokolwiek z tych pól zwróci 400. Pacjent wpisuje obie dane na stronie aktywacji zestawu (anivahealth.com/activate) wraz z kodem zestawu. Strona prosi o datę urodzenia dwa razy, ponieważ laboratorium nie może jej później zmienić. Po tym zestaw otwiera się tylko z tą datą urodzenia. Dopóki pacjent nie wpisze obu danych, wstrzymujemy zlecenie laboratoryjne. Używaj tego ustawienia tylko dla domowych zestawów testowych.

Cykl życia

Profile mają prosty cykl życia:
  1. Utwórz — zarejestruj profil z wymaganymi polami demograficznymi i polem profile_group (UUID lub slug).
  2. Zaktualizuj (opcjonalnie) — dodaj lub zmień pola takie jak phone, height czy weight.
  3. Powiąż — połącz profil z wizytami, używając jego id jako profile_id.
Webhook profile.* informuje cię, gdy profil się pojawi, zmieni lub zostanie usunięty.

Przykładowy profil