Перейти до основного вмісту
Профіль — це обліковий запис, що представляє пацієнта або користувача в системі Aniva. Кожен запис, лабораторне замовлення та результат пов’язані з профілем.

Групи профілів

Коли ти створюєш профіль, то додаєш його до групи профілів за допомогою параметра profile_group. Група профілів упорядковує профілі у твоєму партнерському акаунті, обмежуючи їх конкретною програмою або інтеграцією. Поле profile_group приймає або незмінний UUID групи, або її зрозумілий для людини slug. UUID слугує надійним посиланням — він ніколи не змінюється й зберігається після перейменування slug. Slug призначений для читабельних URL і партнерських інтеграцій. Значення profile_group (UUID або slug) обов’язкове під час створення. Старе поле profile_group_slug усе ще приймається як застарілий псевдонім.

Поля

string
обов'язково
UUID, автоматично згенерований Aniva. Використовуй його, щоб посилатися на профіль в інших викликах API.
string
Необов’язкове ім’я користувача або псевдонім для профілю. Може бути null.
string
Ім’я пацієнта. Лише латинські символи, 1–100 символів. Обов’язкове під час створення.
string
Прізвище пацієнта. Лише латинські символи, 1–100 символів. Обов’язкове під час створення — лабораторії відхиляють замовлення для пацієнтів без прізвища. Може бути null у профілях, створених до того, як поле стало обов’язковим.
string
Електронна адреса пацієнта. Якщо ти не вкажеш її під час створення, Aniva автоматично згенерує електронну адресу-заглушку.
string
Номер телефону у форматі E.164 (наприклад, +14155552671). Може бути null.
integer
Біологічна стать за ISO/IEC 5218: 1 = чоловіча, 2 = жіноча. Обов’язкова під час створення, якщо твоя група профілів не дозволяє пацієнту ввести її самостійно (див. нижче). Вона потрібна лабораторії для референтних діапазонів, тому створення або оновлення зі значенням 0 (невідомо) повертає 400. Профілі, створені до 30 вересня 2026 року, усе ще можуть повертати 0.
string
Дата народження у форматі YYYY-MM-DD. Обов’язкова під час створення, якщо твоя група профілів не дозволяє пацієнту ввести її самостійно (див. нижче). Має бути в минулому, не раніше 1900 року та відповідати віку від 16 до 100 років; неправдоподібні значення відхиляються з кодом 400. Дата народження передається в лабораторію разом із замовленням і не може бути змінена після його оформлення.
number
Зріст у сантиметрах. Може бути null.
number
Вага в кілограмах. Може бути null.
string
Бажана мова для комунікації з пацієнтом. Допустимі значення: en, de, fi.
boolean
Чи отримує профіль транзакційні листи, як-от підтвердження запису та сповіщення про готовність результатів. Не залежить від згоди на маркетингові розсилки. Null, якщо значення ніколи не задавалося.
string
обов'язково
Позначка часу створення профілю у форматі ISO 8601.
string
Позначка часу останнього оновлення у форматі ISO 8601. Null, якщо профіль ніколи не оновлювався.
Поля first_name, last_name, sex, date_of_birth і profile_group обов’язкові під час створення профілю. Усі інші поля необов’язкові. Старе поле profile_group_slug усе ще приймається як застарілий псевдонім для profile_group.

Дозволити пацієнту ввести дату народження і стать

Ми можемо увімкнути одне налаштування для твоєї групи профілів. Тоді ти зможеш створювати профіль без date_of_birth і sex. Попроси нас увімкнути його. Без нього створення без будь-якого з цих полів повертає 400. Пацієнт вводить обидва значення на сторінці активації набору (anivahealth.com/activate) разом із кодом набору. Сторінка запитує дату народження двічі, бо лабораторія не зможе змінити її пізніше. Після цього набір відкривається лише з цією датою народження. Поки пацієнт не введе обидва значення, ми притримуємо замовлення в лабораторію. Використовуй це налаштування лише для наборів для домашнього тесту.

Життєвий цикл

Профілі мають простий життєвий цикл:
  1. Створення — зареєструй профіль з обов’язковими демографічними полями та profile_group (UUID або slug).
  2. Оновлення (необов’язково) — додай або зміни такі поля, як phone, height чи weight.
  3. Прив’язка — пов’яжи профіль із записами, використовуючи його id як profile_id.
Вебхук profile.* сповіщає тебе, коли профіль з’являється, змінюється або видаляється.

Приклад профілю