ЕСОЗ - публічна документація

[RC] [DRAFT] BP-ESOZ-020-0006 [PIS] Створення методу автентифікації пацієнта

Owned by Mykhailo Troinin (SoE eHealth) (Unlicensed)
Last updated: Nov 22, 2024 by Anastasiia Prokhorova (SoE eHealth)
1 min read

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17560797187 (видаліть блок з посиланням перед публікацією документа)

Властивості документа

Тип документа

Бізнес-процес

Назва документа

BP-ESOZ-020-0006 [PIS] Створення методу автентифікації пацієнта

ID настанови

GUI-004

Автор

@Liudmyla Dobrovolska (SoE eHealth)

Версія документа

v010

Статус документа

DRAFT

Дата створеня

01.04.2024

Дата оновлення

 

ID групи

BPG-ESOZ-020

ID бізнес-процесу

BP-ESOZ-020-0006

Назва бізнес-процесу

[PIS] Створення методу автентифікації пацієнта

Посилання на схеми

[[PIS] Створення методу автентифікації пацієнта

Загальні відомості

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

Передумови

Користувач авторизований у ПІС та має дійсний токен доступу (“access token”) та токен оновлення доступу (“refresh token”)

Схема бізнес-процесу

Зображення схеми

Посилання на схему

На перегляд: https://modeler.camunda.io/share/ae4995d4-f9df-453a-9b64-5e2602b318a1

На редагування: https://modeler.camunda.io/diagrams/0ebcb3a1-2a93-43dc-a615-8f648208b1f5--bp-esoz-020-0006-pis-створення-методу-автентифікації-пацієнта?v=765,343,1

Похідний файл схеми (BPMN)

Опис кроків по процесу

1

№ кроку

Крок

Опис

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

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

2

SE 1.10

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

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

 

 

3

1.10

Виконати авторизацію в ЕСОЗ через інформаційну систему

Користувач:

виконав авторизацію в ЕСОЗ через КПІС або АПІС:

 

 

4

1.20

Подати запит на створення методу автентифікації

Користувач ПІС формує запит наступним чином:

  • вводить номер телефону в інтерфейсі ПІС, та

  • опційно може ввести аліас (назву) цього методу аутентифікації

 

 

5

1.30

Сформовано запит на створення методу автентифікації

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

Scope - authentication_method_request:write_pis

Resource - POST /api/pis/authentication_method_requests

API-010-001-013-0457

https://ehealthpisapi.docs.apiary.io/#reference/public.-patient-information-system/person-authentication-methods/create-authentication-method-request

6

2.10

PIS. Create Person authentication method request

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

 

API-010-001-013-0457

https://ehealthpisapi.docs.apiary.io/#reference/public.-patient-information-system/person-authentication-methods/create-authentication-method-request

7

GW 1.10

Номер телефона верифікований?

  • Якщо “так“ (телефон користувача верифікований), перейти до кроку EE 1.10

  • Якщо “ні“ (телефон користувача не верифікований), перейти до кроку 1.40

 

 

8

EE 1.10

Метод автентифікації створено

 

 

 

9

1.40

Підтвердити запит за допомогою SMS з кодом

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

 

 

10

1.50

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

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

Scope - authentication_method_request:write_pis

Resource - PATCH /api/pis/authentication_method_requests/{{request_id}}/actions/approve

API-010-001-013-0459

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

11

2.20

PIS. Approve Person authentication method request

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

 

API-010-001-013-0459

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

12

2.30

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

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

 

 

13

EE 2.10

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

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

 

 

14

1.60

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

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

 

 

15

GW 1.20

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

  • Якщо “так“ (СМС з кодом отримано), перейти до кроку 1.80

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

 

 

16

1.70

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

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

Scope - authentication_method_request:write_pis

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

API-010-001-013-0458

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

17

2.40

PIS. Resend authorization OTP for authentication method reques

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

 

API-010-001-013-0458

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

18

2.50

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

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

 

 

19

EE 2.20

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

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

 

 

20

1.80

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

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

 

 

21

EE 1.20

Метод автентифікації створено

Користувач успішно створив метод автентифікації

 

 

Бізнес правила

  • ПІС має забезпечити користувачу подати запит на створення методу автентифікації з типом “Автентифікація через СМС” ("OTP"), причому ПІС повинна забезпечити наступні обмеження

  • Якщо за результатом виконання запиту згідно з вимогами розділу https://e-health-ua.atlassian.net/wiki/x/fYM9KwQ, виявлено, що метод "Автентифікація через СМС" ("OTP") вже існує, в такому випадку ПІС не має надавати можливість користувачу додати ще один такий метод:

    • метод "Автентифікація через СМС" ("OTP") має бути номер мобільного телефону в форматі "^\\+38[0-9]{10}$";

    • заборона на реєстрацію власного методу "Автентифікація через СМС" ("OTP") для недієздатних користувачів

  • Створюється новий запит на метод автентифікації зі статусом "NEW", генерується одноразовий пароль (якщо потрібен OTP), скасовуються попередні активні запити, старий метод стає неактивним, новий додається з відповідними даними, після чого запит завершується зі статусом "COMPLETED" та оновленими датою і часом

Результат процесу

Метод автентифікації створено, в інтерфейсі ПІС відображається результат виконання з відповідним ідентифікатором методу автентифікації (параметр "authentication_method.id"): 

  • значення параметра:

    • тип ("type") - обов’язково;

    • номер телефону ("phone_number") - обов’язково;

    • назва методу ("alias").           

Перелік змін

Версія документа

Опис змін

Номер релізу

Версія документа

Опис змін

Номер релізу

1

 

 

 

2

 

 

 

 

 

ЕСОЗ - публічна документація