Перейти до основного вмісту
Використовуй цей посібник, щоб створити профіль пацієнта й призначити його до своєї групи профілів. Профілі — це відправна точка для планування записів і запуску лабораторних замовлень.
1

Отримати ідентифікатор групи профілів

Кожен профіль має бути призначений до групи профілів, що належить твоєму партнерському акаунту. Поле profile_group приймає або незмінний UUID групи, або її читабельний slug — краще використовувати UUID, адже він ніколи не змінюється і зберігається після перейменування slug.Якщо ти не знаєш ідентифікатор своєї групи профілів, звернися до Aniva, щоб його отримати. Без дійсного ідентифікатора створювати профілі неможливо.
2

Створити профіль

Надішли POST-запит на /api/v1/profiles із демографічними даними пацієнта.
Поля first_name і last_name є обов’язковими. Вони приймають лише літери латиниці (включно з літерами з діакритичними знаками, як-от ü), пробіли, дефіси та апострофи. Перед надсиланням транслітеруй імена, написані іншими абетками.
Якщо ти не вкажеш email, Aniva автоматично згенерує тимчасову електронну адресу для профілю. Її можна оновити пізніше за допомогою PATCH-запиту.
Поле language визначає мову, якою Aniva спілкується з пацієнтом — наприклад, у нагадуваннях про запис і сповіщеннях про результати. Задай його відповідно до бажаної мови пацієнта. На сторінці Створення профілю перелічено підтримувані значення. Типове значення — en.
Успішний запит повертає 201 Created з об’єктом нового профілю:
Збережи id — він знадобиться для планування записів і оновлення профілю.
3

Оновити профіль (необов’язково)

Використовуй PATCH /api/v1/profiles/{id}, щоб оновити будь-які поля профілю після створення. Усі поля необов’язкові — передавай лише ті, які хочеш змінити.У наведеному нижче прикладі додаються номер телефону та зріст:
Успішний запит повертає 200 OK із повним об’єктом оновленого профілю.

Обробка помилок