Группы профилей
При создании профиля ты привязываешь его к группе профилей с помощью параметраprofile_group. Группа профилей организует профили в твоём партнёрском аккаунте и закрепляет их за конкретной программой или интеграцией.
Поле profile_group принимает либо неизменяемый UUID группы, либо её человекочитаемый slug. UUID служит постоянным идентификатором — он никогда не меняется и сохраняется при переименовании slug. Slug предназначен для читаемых URL и партнёрских интеграций.
Значение profile_group (UUID или slug) обязательно при создании. Старое поле profile_group_slug по-прежнему принимается как устаревший псевдоним.
Поля
UUID, автоматически созданный Aniva. Используй его для ссылок на профиль в других запросах API.
Фамилия пациента. Только латинские символы, 1–100 символов. Обязательна при создании — лаборатории
отклоняют заказы для пациента без фамилии. Может быть null в профилях, созданных до того, как это
поле стало обязательным.
Адрес электронной почты пациента. Если не указать его при создании, Aniva автоматически создаст
адрес-заглушку.
Номер телефона в формате E.164 (например,
+14155552671). Может быть null.Биологический пол по ISO/IEC 5218:
1 = мужской, 2 =
женский. Обязателен при создании, если твоя группа профилей не позволяет пациенту указать его
самостоятельно (см. ниже). Он нужен лаборатории для референсных интервалов, поэтому создание или
обновление со значением 0 (неизвестно) вернёт 400. Профили, созданные до 30 сентября 2026
года, всё ещё могут возвращать 0.Дата рождения в формате
YYYY-MM-DD. Обязательна при создании, если твоя группа профилей не
позволяет пациенту указать её самостоятельно (см. ниже). Должна быть в прошлом, не раньше 1900
года и соответствовать возрасту от 16 до 100 лет; неправдоподобные значения отклоняются с кодом
400. Дата рождения передаётся в лабораторию в заказе и не может быть изменена после его
оформления.Получает ли профиль транзакционные письма, например подтверждения записи и уведомления о
готовности результатов. Отдельно от согласия на маркетинговую рассылку. Значение null, если
никогда не задавалось.
Метка времени последнего обновления в формате 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) вместе с кодом
набора. Страница запрашивает дату рождения дважды, потому что лаборатория не сможет изменить её
позже. После этого набор открывается только с этой датой рождения. Пока пациент не введёт оба
значения, мы придерживаем заказ в лабораторию. Используй эту настройку только с наборами для
домашнего теста.
Жизненный цикл
У профилей простой жизненный цикл:- Создание — зарегистрируй профиль с обязательными демографическими полями и
profile_group(UUID или slug). - Обновление (необязательно) — добавь или измени поля, например
phone,heightилиweight. - Привязка — свяжи профиль с записями, указав его
idкакprofile_id.
profile.* сообщает, когда профиль появляется, изменяется или удаляется.