Перейти до основного вмісту
POST
Створи новий профіль пацієнта й додай його до групи профілів. Профіль зберігає демографічні дані, які використовуються для записів і лабораторних замовлень. Потребує дозволу create_user. Надішли необов’язковий заголовок Idempotency-Key, щоб зробити повторний запит на створення безпечним — повторення з тим самим ключем повертає початкову відповідь замість створення другого запису. Див. Ідемпотентність.

Запит

Параметри тіла запиту

string
обов'язково
Ім’я пацієнта. Має бути записане латиницею, від 1 до 100 символів.
string
обов'язково
Прізвище пацієнта. Має бути записане латиницею, від 1 до 100 символів. Лабораторії відхиляють замовлення для пацієнта без прізвища, тому профіль не можна створити без нього.Три значення зарезервовано для створення тестових даних — див. Тестові дані для sandbox.
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
Електронна адреса для профілю. Якщо не вказано, 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
Чи погоджується цей профіль на маркетингові листи (розсилки, оновлення продукту). Перевизначає типове налаштування групи профілів. Не залежить від транзакційних листів. Пропусти, щоб використати типове налаштування групи профілів. Лише для запису: не повертається у відповіді профілю.

Тестові дані для sandbox

Кожен шлях читання, який варто протестувати — Список записів, Отримати результати, Завантажити документ — залишається порожнім, доки через кілька днів не відбудеться реальний забір крові. Через це складно писати автоматизовані інтеграційні тести. Щоб вирішити це, зарезервовано три значення 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 замість створення другого профілю:
Прізвища пісочниці, які генерують тестові дані, є винятком.