№ кроку

Крок

Опис

Технічний модуль

Методи API які мають або можуть бути використані

SE 1.10

Початок процесу

Користувач хоче зареєструватись у Системі

1.10

Користувач ініціює реєстрацію у Системі

Користувач:

• виконав вхід в інтерфейс кваліфікованої системи

• виконує ініціалізацію процедури реєстрації в ЕСОЗ

1.20

Запит на отримання даних для реєстрації

КПІС виконує запит до сервісу авторизації на отримання даних для авторизації системи

Scope

Resource - POST /oauth/nonce

[DRAFT] Get nonce [API-009-001-007-0344]

2.10

Get Nonce

В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ

[DRAFT] Get nonce [API-009-001-007-0344]

1.30

Відобразити користувачу форму для реєстрації

КПІС:

• отримала дані для авторизації системи

• готує форму для реєстрації

1.40

Заповнити дані для реєстрації

КПІС:

• відображає форму для реєстрації

Користувач:

• заповнює дані форми для реєстрації згідно наступних вимог:

1. ім'я (параметр "first_name") - обов'язково;

2. прізвище (параметр "last_name") - обов'язково;

3. по батькові (параметр "second_name");

4. дата народження (параметр "birth_date"), яка заповнюється в форматі "ДД.ММ.РРРР" - обов'язково;

5. країна народження (параметр "birth_country"), яка заповнюється користувачем згідно з довідником "COUNTRY" та, у разі відсутності необхідного значення, довільним значенням - обов'язково;

6. місце народження (параметр "birth_settlement"), яка заповнюється користувачем згідно з довідниками "SETTLEMENT_TYPE" та, у разі відсутності необхідного значення, довільним значенням  - обов'язково;

7. стать (параметр "gender") згідно з довідником "GENDER"- обов'язково;

8. електронна пошта (параметр "email"), домен якої не міститься в переліку заборонених (заблокованих) визначених відповідними розпорядженнями Національного центру оперативно-технічного управління мережами телекомунікацій (НЦУ);

9. відмітка про відмову РНОКПП (параметр "no_tax_id");

10. РНОКПП (параметр "tax_id"), має відповідати формату "^[0-9]{10}$";

11. кодове слово (параметр "secret") відповідно формату "^[A-Za-zА-Яа-яҐґЇїІіЄє0-9]{6,20}$"  - обов'язково;

12. документ пацієнта (масив "documents"), що посвідчує особу згідно закону - обов’язково, зокрема:

    1. тип документа (параметр "type") згідно з довідником "DOCUMENT_TYPE" - обов’язково;

    2. серію (за наявності) та номер документа (параметр "number") - обов’язково, відповідно формату:

• PASSPORT - "^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$",

• NATIONAL_ID - "^[0-9]{9}$",

• BIRTH_CERTIFICATE - "^((?![ЫЪЭЁыъэё@%&$^#`~:,.*|}{?!])[A-ZА-ЯҐЇІЄ0-9№\\/()-]){2,25}$",

• COMPLEMENTARY_PROTECTION_CERTIFICATE - "^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$",

• REFUGEE_CERTIFICATE - "^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$"

• TEMPORARY_CERTIFICATE - "^(((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{4,6}|[0-9]{9}|((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{5}\\/[0-9]{5})$",

• TEMPORARY_PASSPORT - "^((?![ЫЪЭЁыъэё@%&$^#`~:,.*|}{?!])[A-ZА-ЯҐЇІЄ0-9№\\/()-]){2,25}$";

3. дата видачі (параметр "issued_at") - обовʼязково;

4. дійсний до (параметр "expiration_date");

5. орган яким виданий (параметр "issued_by");

6. унікальний номер запису в ЄДДР  (УНЗР) (параметр "unzr"), має відповідати формату: "^[0-9]{8}-[0-9]{5}$" ;

7. адреси пацієнта  (масив параметрів "addresses"), користувач повинен обов'язково вказати адресу фактичного місця проживання та адресу реєстрації. Якщо ці адреси співпадають, необхідно поставити відмітку, що адреси збігаються  - обов’язково;

   1. тип адреси - (параметр "type"), згідно з довідником "ADDRESS_TYPE" - обов’язково;

   2. країна - (параметр "country"), згідно з довідником "COUNTRY" - обов’язково;

   3. область - (параметр "area") - обов’язково;

   4. район області - (параметр "region");

   5. населений пункт - (параметр "settlement") - обов’язково;

   6. тип населеного пункту - (параметр "settlement_type"), згідно з довідником "SETTLEMENT_TYPE"  - обов’язково;

   7. ідентифікатор населеного пункту (параметр "settlement_id") - обов’язково;

   8. тип вулиці - (параметр "street_type"), згідно з довідником "STREET_TYPE";

   9. назва вулиці - (параметр "street");

   10. будинок - (параметр "building");

   11. квартира - (параметр "apartment");

   12. поштовий індекс - (параметр "zip");

8.  контактний телефон користувача (об'єкт "phones"):

   1. тип телефону (параметр "phones_type"), згідно з довідником "PHONE_TYPE" - обов’язково;

   2. номер телефону в форматі "^\\+38[0-9]{10}$" (параметр "phones_number") - обов’язково;

9. метод автентифікації (об'єкт "authentication_methods") - обов’язково:

   1. тип (параметр "type") - обов’язково;

   2. номер мобільного телефону, що належить оператору в Україні, в форматі "^\\+38[0-9]{10}$" (параметр "phone_number") - обов’язково;

10. бажаний спосіб зв'язку (параметр "preferred_way_communication");

    1. електронна пошта (параметр "email");

    2. телефон (параметр "phone");

11. дані особи для екстреного зв'язку (об'єкт "emergency_contact") - обов’язково:

    1. ім'я (параметр "first_name") - обов'язково;

    2. прізвище (параметр "last_name") - обов'язково;

    3. по батькові (параметр "second_name");

    4. телефон контакту для екстреного зв'язку (масив "emergency_contact.phones"):

       1. тип телефону (параметр "phones_type"), згідно з довідником "PHONE_TYPE" - обов’язково;

       2. номер телефону (параметр "number" в форматі "^\\+38[0-9]{10}$") - обов’язково;

1.50

Підписати дані для реєстрації за допомогою ЕП

Користувач підписує внесені дані для реєстрації, за допомогою ЕП, не використовуючи інші веб-сайти, або системи

1.60

Передати дані користувача до ресурсу реєстрації Системи

Після підписання користувачем даних для реєстрації за допомогою ЕП, КПІС передає підписані дані до Системи

Scope - person:sign_up

Resource - GET /sign_up

[DRAFT] PIS. Patient sign-up [API-010-001-003-0372]

2.20

PIS. Patient sign-up

В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ

[DRAFT] PIS. Patient sign-up [API-010-001-003-0372]

GW 1.10

Підписані дані коректні?

• Якщо “ні“ (підписані дані не коректні), перейти до кроку 1.70

• Якщо “так“ (підписані дані коректні), перейти до кроку 1.90

1.70

Зупинити процес реєстрації

КПІС зупиняє процес реєстрації

1.80

Відобразити користувачу повідомлення про помилку

КПІС відображає помилку реєстрації користувачу з посиланням на помилкову сутність

EE 1.10

Процес завершено

Процес реєстрації завершується через отримання помилки під час реєстрації

1.90

Відобразити заповнені дані для реєстрації

КПІС має надати можливість Користувачу переглянути заповнені ним дані для реєстрації, з можливістю прийняти та продовжити або відхилити їх, які КПІС повинна відобразити в своєму інтерфейсі

1.100

Переглянути заповнені ним дані для реєстрації

Користувачу переглядає заповнені ним дані для реєстрації, які були отримані від КПІС

GW 1.20

Користувач погодив заповнені дані?

• Якщо “ні“ (у випадку відхилення користувачем даних для реєстрації, процес реєстрації припиняється, і  КПІС має  відобразити Користувачу початкове вікно реєстрації), перейти до кроку 1.10

• Якщо “так“ (у разі погодження КПІС повинна провести верифікацію номера телефона метода автентифікації пацієнта), перейти до кроку 1.110

1.110

Запит на проведення верифікації номера телефона методу аутентифікації

• Користувач погодив дані для реєстрації

• КПІС повинна провести верифікацію номера телефона метода автентифікації пацієнта

Scope - otp:read

Resource - POST /api/sms_verifications

[DRAFT] PIS. Verify phone number [API-010-001-001-0353]

2.30

Verify phone number

В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ

[DRAFT] PIS. Verify phone number [API-010-001-001-0353]

2.40

Відправити SMS ID: 0007

Відправити СМС з кодом користувачу

EE 2.10

СМС відправлена

СМС з кодом відправлено, перехід до кроку 1.120

GW 1.30

Телефон верифікований?

• Якщо “ні“ (телефон не верифікований, у відповідь на запит в параметрі "phone verification result" отримано значення "OTP sent", АПІС повинна відобразити Користувачу поле для введення коду верифікації з СМС), перейти до кроку 1.120

• Якщо “так“ (телефон верифікований, у відповідь на запит в параметрі "phone verification result" отримано значення "Verified", верифікація номера телефона не потрібна, Система не повинна відображати Користувачу поле для введення коду верифікації з СМС), перейти до кроку GW 1.50

1.120

Відобразити поле для введення коду верифікації з СМС

КПІС повинна відобразити Користувачу поле для введення коду верифікації з СМС, у форматі верифікаційного коду -  "^\d{4}$", з визначеним часом строку дії верифікаційного коду відповідно до конфігураційного параметру "CODE_EXPIRATION_PERIOD_MINUTES"

GW 1.40

Користувач отримав СМС з кодом?

• Якщо “ні“ (Користувач не отримав СМС з кодом), перейти до кроку 1.130

• якщо “так“ (Користувач отримав СМС з кодом), перейти до кроку 1.160

1.130

Отримати повторно СМС з кодом

Якщо користувач не отримав "OTP" або термін дії пароля вичерпано, КПІС має забезпечити можливість Користувачу одноразово повторно отримати "OTP"

1.140

Запит на повтор. надсилання СМС з кодом сформовано

"OTP" має бути з визначеним часом строку дії верифікаційного коду відповідно до конфігураційного параметру "code_expired_at"

Scope - authentication_method_request:write_pis

Resource - POST /api/pis/authentication_method_requests/{{request_id}}/actions/resend_otp

API-010-001-013-0458
PIS API · Apiary

2.50

PIS. Resend authorization OTP for authentication method request

В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом А

PIS API · Apiary

2.60

Відправити SMS ID: 0007

Відправити СМС з кодом користувачу

EE 2.20

СМС відправлена

СМС з кодом відправлено, перехід до кроку 1.150

1.150

СМС з кодом отримано

Користувач отримав СМС повідомлення з кодом, для введення одноразового пароля в інтерфейсі КПІС

1.160

Ввести пароль з СМС в поле для введення коду

Користувач вводить одноразовий пароль, отриманий на номер телефону, який необхідно верифікувати

GW 1.50

Одноразовий пароль з СМС коректний?

• Якщо “ні“ (одноразовий пароль з СМС не коректний), перейти до кроку 1.700

• Якщо “так“ (одноразовий пароль з СМС коректний), перейти до кроку GW 1.60

1.160

Зупинити процес реєстрації

КПІС зупиняє процес реєстрації

1.170

Інформаційне повідомлення користувачу щодо помилки коду з СМС

КПІС має відобразити користувачу повідомлення про помилку щодо коду з СМС

EE 1.20

Процес завершено

Процес реєстрації завершується через отримання помилки щодо коду з СМС під час реєстрації

GW 1.60

Активного запису про пацієнта знайдено?

• Якщо “ні“ (активного запису про пацієнта не знайдено), перейти до кроку 1.190

• Якщо “так“ (активного запису про пацієнта знайдено), перейти до кроку GW 1.70

1.190

Зупинити процес реєстрації

КПІС повинна зупинити процес реєстрації

1.200

Інформ. повідом. корист. про необх.реєстр. пацієнта

КПІС повинна та відобразити Користувачу повідомлення про помилку реєстрації з посиланням на помилкову сутність

EE 1.30

Процес завершено

Процес реєстрації завершується через отримання помилки щодо помилки реєстрації

GW 1.70

Знайдено більше одного активного запису про пацієнта?

• Якщо “ні“ (знайдено одного активного запису про пацієнта), перейти до кроку 1.230

• Якщо “так“ (знайдено більше одного активного запису про пацієнта), перейти до кроку 1.210

1.210

Зупинити процес реєстрації

КПІС зупиняє процес реєстрації

1.220

Інформаційне повідомлення користувачу "Звернутись за уточненням персональних даних"

КПІС зупиняє процес авторизації, відображає повідомлення про помилку реєстрації з пропозицією Користувачу звернутись до свого сімейного лікаря, або до контакт-центру НСЗУ для уточнення  своїх персональних даних (поза процесом)

EE 1.40

Процес завершено

Процес реєстрації завершується оскільки знайдено більше одного активного запису про пацієнта

1.230

Відобразити користувачу форму для погодження переліку скоупів

КПІС повинна відобразити Користувачу форму для погодження переліку скоупів для отримання КПІС

1.240

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

Користувач:

• переглядає форму для надання доступу КПІС

• виконує погодження запиту на надання доступу

1.250

Запит на отримання токена доступу

КПІС:

• отримала grant code в результаті авторизації доступів користувачем

• формує запит на отримання токену доступу та відправляє його сервісу авторизації

Scope ---

Resource - POST /oauth/tokens

[DRAFT] PIS. Exchange oAuth Code Grant to Access Token [API-009-001-001-0328]

2.70

Exchange oAuth Code Grant to Access Token

в ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ

[DRAFT] PIS. Exchange oAuth Code Grant to Access Token [API-009-001-001-0328]

1.260

Зберегти токен доступу “access token” та токен оновлення доступу “refresh token”

КПІС зберігає токен доступу (access token) та токен оновлення доступу (refresh token) для користувача для подальшого використання для звернення до ЕСОЗ

1.270

Повідомлення про успішну реєстрацію

Користувач отримує повідомлення про успішну реєстрацію

EE 1.50]

Процес реєстрації користувача завершено

Користувач успішно авторизований в Системі

SE 1.20

Присутні документи з вимогою до завантаження

в масиві "person.documents" присутні документи з типом "PERMANENT_RESIDENCE_PERMIT", та/або міститься документ з типом, що відповідає конфігураційному параметру: "PIS_PERSON_LEGAL_CAPACITY_DOCUMENT_TYPES"

1.280

Завантажити електронні копії оригіналів документів

Завантаження електроних копіїй оригіналів документів відбувається відповідно процесу “Завантаження електронних копій оригіналів документів“

EE 1.50

Документи завантажені

Електронні копії оригіналів документів успішно завантажені