Versions Compared

Old Version 7

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

Saved on

compared with

New Version 8

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

Saved on

Key

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

ID метода

API-005-011-001-0190

Автор

Viacheslav Tybin (SoE eHealth)

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

1.0

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

Status
titledraft

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

Отримати список декларацій через Кабмін

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

Get declaration list via Cabinet

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

Дозволяє бачити історію всіх декларацій пацієнта та фільтрувати їх.

...

Properties of a REST API method document

Scope

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]Get declaration list via Cabinet

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-001005-001010-001-00010192

Microservices (namespace)

MPIIL

Component

AuthPatient Cabinet

Component ID

COM-001005-001010

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-detailspatient-cabinet/cabinet/get-declaration-list-via-cabinet

Resource

{{host}}//api.ehealth.gov.ua/api/patients/id/encounter_package

/cabinet/declarations

Scope

declaration:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

Describe the purpose of the API method, add Key points (if necessary)This WS is designed to obtain a declaration list by a patient in a cabinet

Logic

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

Configuration parameters

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

Dictionaries

...

  • POSITION

  • LEGAL_FORM

  • DIVISION_TYPE

  • DIVISION_STATUS

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

composition_id

 M

String ($uuid) (path)

Composition object ID

 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
...
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
Content-Type:application/json
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
3
 
 
 
 
 
Request data validation
...
Validate user
  • Extract party_user (user_id) from token.
  • Check if party_user=$.declarations.person_id
    • in case error return 403
  • check person.tax_id=users.tax_id
    • in case error return 401 - access denied
  • Check users password is not expired
    • in case error return 401 - password expired
  • Check if users.is_blocked = false
    • in case error return 401 - access denied
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "declaration_number": "0000-12H4-245D",
      "start_date": "2017-03-02",
      "status": "active",
      "person": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      },
      "employee": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "position": "P6",
        "party": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "first_name": "Петро",
          "last_name": "Іванов",
          "second_name": "Миколайович"
        }
      },
      "legal_entity": {
        "id": "d290f1ee",
        "name": "Клініка Ноунейм",
        "short_name": "Ноунейм",
        "legal_form": "140",
        "edrpou": "5432345432"
      },
      "division": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Бориспільське відділення Клініки Ноунейм",
        "type": "clinic",
        "status": "ACTIVE",
        "dls_id": "2872985",
        "dls_verified": true
      }
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
2
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
1
Базові
2
200
 Response
 
3
 401
 Access denied
4
401
Password expired
5
401
Validation failed
6
401
Unauthorized
 
Помилка підтвердження
7
403
Validation failed
8
403
Your scope does not allow to access this resource. Missing allowances: declaration:read
9
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
310
 
401
Unauthorized
 
Помилка підтвердження
411
Специфічні
512
 
422
Only for active MPI record can be created medication request!
 
 
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical modules where the method is used
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354