Versions Compared

Old Version 2

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.
REST API method / Метод REST API (настанова) (
Info
Note

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

Info

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

Table of Contents

Properties of a REST API method document

Page Properties
idpage_properties_method_REST API

Document type

Метод REST API

Document title

[DRAFT] Get Legal Entities V2 [API-005-009-002-0176]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-001005-001009-001002-00010176

Microservices (namespace)

MPIIL

Component

AuthLegal Entities

Component ID

COM-001005-001009

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/managelegal-client-configurationentities/get-clientlegal-entities-detailsv2

Resource

{{host}}//api.ehealth.gov.ua/api/patientsv2/id/encounterlegal_packageentities

Scope

legal_entity: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)

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

Description of input parameters

This service returns a list of all active legal entities of all types (except MIS) filtering result by query parameters

Logic

...

Configuration parameters

N/A

Dictionaries

N/A

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
...
Request data validation
Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API
Response structure examples
Description of the REST API response structure, exampleHeaders
Request data validation
Authorize
  1. Verify the validity of access token
  2. Check user scope legal_entity:read in order to perform this action
Check user context
Return response to user limited by context from user's token
Token type
Limitation
TOKENS_TYPES_PERSONAL
Limited by Legal Entity (ID)
TOKENS_TYPES_MIS
No limitations
TOKENS_TYPES_ADMIN
No limitations
Processing
Get legal entities
Invoke PRM.Legal Entities List
  1. By default service returns legal entities with type - MSP
  2. Service return only active legal_entities, where is_active = true
  3. If settlement_id passes as input parameter - legal entities should be filtered by setllement_id in residence address only
  4. Method returns list of objects with short details from PRM DM legal_entity tableand pagination information.
    1. For each legal entity return in response:
      1. legal entity details from legal_entities table and from edr_data table
      2. licenses from licenses table
      3. services from capitation_contract table
      4. addresses from legal_entity table
      5. phones from legal_entity table
      6. emails from legal_entity table
      7. founders from legal_entity table
  5. If according to filters Legal Entities are not found, WS returns empty data array.
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
languagejson
{
  "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",
      "edr": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "name": "Клініка Ноунейм",
        "short_name": "Ноунейм",
        "public_name": "Ноунейм",
        "legal_form": "140",
        "edrpou": "54323454",
        "kveds": [
          {
            "name": "Діяльність лікарняних закладів",
            "code": "86.10",
            "is_primary": true
          }
        ],
        "registration_address": {
          "zip": "02090",
          "country": "УКРАЇНА",
          "address": "Волинська обл., місто Луцьк ВУЛИЦЯ КОНЯКІНА буд. 14 кв. 144",
          "parts": {
            "atu": "Волинська обл., місто Луцьк",
            "atu_code": "0710100000",
            "street": "ВУЛИЦЯ КОНЯКІНА",
            "house_type": "буд.",
            "house": "14",
            "building_type": "null",
            "building": "``",
            "num_type": "кв.",
            "num": "144"
          }
        },
        "state": 1
      },
      "edrpou": "32323454",
      "type": "PRIMARY_CARE",
      "residence_address": {
        "type": "RESIDENCE",
        "country": "UA",
        "area": "Житомирська",
        "region": "Бердичівський",
        "settlement": "Київ",
        "settlement_type": "CITY",
        "settlement_id": "b075f148",
        "street_type": "STREET",
        "street": "вул. Ніжинська",
        "building": "15",
        "apartment": "23",
        "zip": "02090"
      },
      "phones": [
        {
          "type": "MOBILE",
          "number": "+380503410870"
        }
      ],
      "email": "email@example.com",
      "website": "www.msp.com.ua",
      "receiver_funds_code": "12345",
      "beneficiary": "Борисов Борис Борисович",
      "accreditation": {
        "category": "SECOND",
        "issued_date": "2017-02-28",
        "expiry_date": "2017-02-28",
        "order_no": "fd123443",
        "order_date": "2017-02-28"
      },
      "license": {
        "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
        "type": "MSP",
        "license_number": "fd123443",
        "issued_by": "Кваліфікацйна комісія",
        "issued_date": "2017-02-28",
        "expiry_date": "2017-02-28",
        "active_from_date": "2017-02-28",
        "what_licensed": "реалізація наркотичних засобів",
        "order_no": "ВА43234"
      },
      "archive": [
        {
          "date": "2017-02-28",
          "place": "вул. Грушевського 15"
        }
      ],
      "public_offer": {
        "consent_text": "Consent text",
        "consent": true
      },
      "status": "ACTIVE"
    }
  ],
  "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
1
Базові
2
1000
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
3
401
Unauthorized
Помилка підтвердження
4
Специфічні
5
422
Only for active MPI record can be created medication request!
200
 Response
3
Специфічні
4
Post-processing processes
Description of actions performed on data after processingN/A
Technical modules where the method is used
List of pages describing technical modules where the method is usedN/A
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...