Перейти к основному содержанию
POST
Создай новый профиль пациента и привяжи его к группе профилей. Профиль хранит демографические данные, которые используются для записей и лабораторных заказов. Требуется разрешение create_user. Передай необязательный заголовок Idempotency-Key, чтобы этот запрос на создание можно было безопасно повторять — повтор с тем же ключом вернёт исходный ответ вместо создания второй записи. См. Идемпотентность.

Запрос

Параметры тела запроса

string
обязательно
Имя пациента. Только латинские символы, от 1 до 100 символов.
string
обязательно
Фамилия пациента. Только латинские символы, от 1 до 100 символов. Лаборатории отклоняют заказы для пациентов без фамилии, поэтому без неё профиль создать нельзя.Три значения зарезервированы для создания тестовых фикстур — см. Тестовые фикстуры для песочницы.
integer
обязательно
Биологический пол по стандарту ISO/IEC 5218. Используй 1 для мужского и 2 для женского. Он нужен лаборатории для референсных интервалов, поэтому 0 (неизвестно) возвращает 400. Обязательно, если только твоя группа профилей не позволяет пациенту указать его на странице активации набора. В этом случае не передавай поле. См. Разрешить пациенту указать дату рождения и пол.
string
обязательно
Дата рождения в формате YYYY-MM-DD. Должна быть в прошлом и не раньше 1900 года. Возраст должен быть от 16 до 100 лет. Другие значения возвращают 400. Обязательно, если только твоя группа профилей не позволяет пациенту указать её на странице активации набора. В этом случае не передавай поле.
string
обязательно
Полиморфная ссылка (UUID или slug) на группу профилей, к которой нужно привязать этот профиль. UUID — неизменяемый идентификатор, который сохраняется при переименовании slug; slug по-прежнему принимается для маркетинговых и партнёрских интеграций, построенных на читаемых идентификаторах. UUID предпочтительнее. Группа профилей должна входить в контекст доступа твоего API-ключа. Обязательно, если ты не передаёшь устаревшее поле profile_group_slug.
string
устарело
Устарело: используй profile_group. Slug группы профилей. Только строчные буквы, цифры, дефисы и знаки подчёркивания.
string
Email-адрес для профиля. Если его не указать, Aniva сгенерирует адрес автоматически.Указание email также делает создание безопасным при повторах: к одному адресу может быть привязан только один профиль, поэтому повторный запрос вернёт 409, а не создаст второй профиль. Автоматически сгенерированные адреса уникальны для каждого запроса. Передавай email или Idempotency-Key, если твоя интеграция повторяет запросы.
string
Номер телефона в формате E.164 (например, +14155552671).
number
Рост в сантиметрах.
number
Вес в килограммах.
string
по умолчанию:"en"
Предпочитаемый язык профиля: 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 или uk. По умолчанию en.
boolean
Должен ли этот профиль получать транзакционные (системные) письма — подтверждения записей, уведомления о готовности результатов и т. д. Переопределяет настройку группы профилей по умолчанию. Не связано с согласием на маркетинг. Не передавай, чтобы использовать значение по умолчанию.
boolean
Согласен ли этот профиль получать маркетинговые письма (рассылки, новости продукта). Переопределяет настройку группы профилей по умолчанию. Не связано с транзакционными письмами. Не передавай, чтобы использовать значение группы профилей по умолчанию. Только для записи: не возвращается в ответе профиля.

Тестовые фикстуры для песочницы

Все важные для тестирования запросы на чтение — Список записей, Получить результаты, Скачать документ — пусты, пока через несколько дней не пройдёт реальный забор крови. Из-за этого неудобно писать автоматические интеграционные тесты. Чтобы решить эту проблему, зарезервированы три значения last_name. Создай профиль с одним из них, и Aniva заранее заполнит описанное ниже состояние ещё до ответа, так что твой следующий запрос его уже увидит: Регистр при сравнении не учитывается. Все остальные поля — включая date_of_birth и sex — сохраняются и используются как обычно, поэтому ты получаешь реальные референсные интервалы с учётом возраста и пола созданного профиля. Запись оформляется в локации Aniva Test на реальный доступный слот минимум через пять дней от текущего момента (или пять дней назад для прошедших состояний). Её создание не отправляет заказ в лабораторию и не вызывает курьера.
Указывай для тестовых профилей адрес, к которому у тебя есть доступ. Напоминания Aniva о записях зависят от scheduled_at, поэтому предстоящая фикстура отправит их, если для профиля не отключена отправка через transactional_emails_enabled: false.
Панель выбирается случайно из тех, которые видит твой API-ключ, поэтому её panel_id всегда соответствует твоему Списку панелей. Клинические биомаркеры получают значение в пределах своего референсного интервала; гены получают случайный генотип из справочных данных Aniva вместе с соответствующими ему вариантами, клинической значимостью и rs-идентификаторами.
Панель и значения генерируются заново при каждом создании, поэтому проверяй структуру, а не конкретную панель или точные числа.

Ответ

При успехе API возвращает 201 Created с созданным профилем.
string
обязательно
Уникальный идентификатор профиля (UUID).
string
Хендл или имя пользователя профиля. Может быть null.
string
Имя. Может быть null.
string
Фамилия. Может быть null.
string
Адрес электронной почты. Может быть null.
string
Номер телефона в формате E.164. Может быть null.
integer
Биологический пол по ISO/IEC 5218 (0 = неизвестно, 1 = мужской, 2 = женский). Может быть null.
string
Дата рождения в формате YYYY-MM-DD. Может быть null.
number
Рост в сантиметрах. Может быть null.
number
Вес в килограммах. Может быть null.
string
Предпочитаемый язык, один из 32 кодов выше.
boolean
Получает ли этот профиль транзакционные (автоматические) письма. null, если значение не задавалось.
string
Временная метка создания профиля в формате ISO 8601.
string
Временная метка последнего обновления в формате ISO 8601. null для только что созданных профилей.

Ответы с ошибками

Ответ 409 выглядит так — воспринимай его как «этот профиль уже существует» и найди профиль через Список профилей (?email=), вместо того чтобы повторять создание:
Для человека с такими же именем, фамилией, полом и датой рождения, как в профиле, который видит твой ключ, возвращается 409 с error_name: "duplicate_profile_error". Используй возвращённый profile_id вместо создания второго профиля:
Фамилии из песочницы, которые создают тестовые данные, являются исключением.