Versions Compared

Old Version 3

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

Saved on

compared with

New Version 4

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

...

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методу]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-009-002-0186

Microservices (namespace)

IL

Component

Legal Entities

Component ID

COM-005-009

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/legal-entities/get-legators-legal-entities

Resource

{{host}}/api/legal_entities/{{id}}/related

Scope

related_legal_entities:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

...

  1. only employees with scope "related_legal_entities:read" can get a list of related legal entities

  2. it's possible to see only children legal entities (GET /legal_entities/{{id}}/related{?page,page_size})

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

Provides a list of links to dictionaries that are available in Confluence

Input parameters

...

parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

Required

d290f1ee-6c54-4b01-90e6-d701748f0851

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
Authorize
Request to process the request using a token in the headers
Validate token
  • Verify the validity of access token
    • Return 401 in case validation fails
  • token is not expired
    • in case error return 401 
...
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": [
    {
      "merged_from_legal_entity": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "name": "Клініка Ноунейм",
        "edrpou": "5432345432"
      },
      "reason": "на підставі наказу №1111",
      "reason_date": "2022-02-10",
      "type": "ACCESSION",
      "is_active": true,
      "inserted_at": "2005-10-30 10:45",
      "inserted_by": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}
...
Only for active MPI record can be created medication request!
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
 Response
 
3
401
 Token validation failed
 
4
401
Unauthorized
Помилка підтвердження
5
403
User is not allowed to view
65
403
Your scope does not allow to access this resource. Missing allowances: related_legal_entities:read
7
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
8
Специфічні
9
422
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 modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...