№ кроку

Крок

Опис

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

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

SE 1.10

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

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

1.10

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

Користувач:

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

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

1.20

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

АПІС:

• генерує список доступів (scope), які повинен погодити користувач

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

1.30

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

Користувач:

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

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

АПІС:

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

GW 1.10

Запит на надання доступу відхилено?

• якщо “ні“ (запит на надання доступу не відхилено), перейти до кроку 1.50

• якщо “так“ (запит на надання доступу відхилено), перейти до кроку 1.40

1.50

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

Користувач:

• відхилив запит на надання доступу авторизованій системі

АПІС:

• зупиняє процес реєстрації пацієнта

1.60

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

Авторизована система: повертає користувача на початок процесу реєстрації, перейти до кроку 1.10

1.40

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

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

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.70

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

АПІС:

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

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

1.80

Заповнити та/або змінити попередньо заповнені дані для реєстрації

Користувач:

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

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. РНОКПП (параметр "tax_id"), має відповідати формату "^[0-9]{10}$" - АПІС повинна заповнити відомостями отриманими з ДРФО без можливості їх редагування користувачем; 

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

11. документ пацієнта (масив "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. номер в форматі "^\\+38[0-9]{10}$" (параметр "number") - обов’язково;

1.90

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

Користувач виконує процедуру накладання ЕП на форму для реєстрації

1.100

Провести верифікацію номера телефону методу аутентифікації

АПІС:

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

• відправляє номер телефону методу аутентифікації пацієнта для верифікації сервісом верифікації E-Health, додає хеш підписаних даних для реєстрації

• отримує результат верифікації телефону

Scope - otp:read

Resource - POST /api/sms_verifications

API-010-001-001-0353

Verify phone number

2.20

Verify phone number

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

Verify phone number

2.30

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

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

EE 2.10

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

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

GW 1.20

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

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

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

1.110

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

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

GW 1.30

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

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

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

1.120

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

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

1.130

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

"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
https://pisapi1.docs.apiary.io/#reference/public.-patient-information-system/person-authentication-methods/resend-authorization-otp-for-authentication-method-request

2.40

PIS. Resend authorization OTP for authentication method request

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

https://pisapi1.docs.apiary.io/#reference/public.-patient-information-system/person-authentication-methods/resend-authorization-otp-for-authentication-method-request

2.50

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

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

EE 2.20

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

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

1.140

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

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

1.150

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

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

1.160

Додати пароль з СМС до підписних даних реєстрації

АПІС додає одноразовий пароль до підписаної форми для реєстрації

1.170

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

АПІС:

• передає підписану форму для реєстрації.

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

Scope - trusted_person:sign_up

Resource - POST /api/pis/sign-up

TRUSTED PIS. Patient sign-up [API-010-001-006-0441]

2.60

TRUSTED PIS. Patient sign-up

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

TRUSTED PIS. Patient sign-up [API-010-001-006-0441]

GW 1.40

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

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

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

1.180

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

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

1.190

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

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

EE 1.10

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

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

GW 1.50

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

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

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

1.200

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

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

1.210

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

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

EE 1.20

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

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

GW 1.60

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

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

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

1.220

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

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

1.230

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

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

EE 1.30

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

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

1.140

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

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

1.150

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

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

EE 1.40

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

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

SE 1.20

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

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

1.260

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

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

EE 1.50

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

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