Versions Compared

Old Version 6

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
idENT-005-011-006

ID метода

API-005-011-006-0205

Автор

Viacheslav Tybin (SoE eHealth)

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

1.0

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

Status
titleDRAFT

Назва метода (укр.)

Отримати особисту інформацію

Назва метода (eng.)

Get Personal info

Короткий опис метода

Для отримання персональних даних про пацієнта за токеном.

...

Note

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

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[DRAFT] Get Personal info [API-005-010-006-0207]

Guideline ID

GUI-0011

Author

Viacheslav Tybin (SoE eHealth)

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-010-006-0207

Microservices (namespace)

IL

Component

Patient Cabinet

Component ID

COM-005-010

Link на API-специфікацію

https://ehealthmisapi1.docs.apiary.io/#reference/public.-patient-cabinet/cabinet/get-personal-info

Resource

{{host}}/api/cabinet/persons

Scope

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This WS is designed to get the personal information of patient by token

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in ConfluenceN/A

Dictionaries

N/A

Input parameters

Description of input parameters

Composition object ID

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

 89678f60-4cdc-4fe3-ae83-e8b3ebd35c59

2

 

 

 

 

 

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Expand
titleExample
Code Block
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorization
...
Bearer c2778f3064753ea70de870a53795f5c9
...
M
...
Перевірка користувача
...
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
...
 
...
 
...
 
...
 
...
 
Headers 
Request data validation
Validate token
  • Check token existance
    • in case error return 404 - token was not found
  • Check expiration date tokens.expires_at 
    • if  tokens.expires_at < now() return 401 - access denied
  • Extract user_id from token
Validate role
  • Check users_roles.user_id=&.user and user_roles.role_id = roles.id where roles.name = CABINET
    • in case error return 403
Validate person
  • Check if mithril.users.person_id = mpi.persons.id and mithril.users.tax_id = mpi.persons.tax_id
    • in case error return 401
  • Check if users.is_blocked = false
    • in case error return 401
  • Check users password is not expired
    • in case error return 401 - password expired
Processing
In case nothing found return 404 - user was not found
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API response structure, example
 Expand
titleExample
 Code Block
languagejson
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "first_name": "Петро",
    "last_name": "Іванов",
    "second_name": "Миколайович",
    "id": "7e9cffd9-c75f-45fb-badf-6e8d20b6a8a8"
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 Response
 
3
401
 
Validation failed
4
401
Unauthorized
 
Помилка підтвердження
5
403
 
Validation failed
65
404
 
Validation failed
7
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
8
Специфічні
9
 
422
Only for active MPI record can be created medication request!
 
 
6
Специфічні
7
 
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354
...