Versions Compared

Version Old Version 5 New Version Current
Changes made by

Oksana Demchenko

Anzhela Kovalenko (SoE eHealth)

Saved on

Key

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

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

...

Page Properties
idpage_properties_method_REST API
Scope

Document type

Метод REST API

Document title

[DRAFT] Get client connections [API-009-001-006-0337]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-001009-001-001006-00010337

Microservices (namespace)

MPIMithril

Component

AuthMithril

Component ID

COM-001009-001

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manage-client-configuration/get-client-connections

Resource

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

/clients/{{id}}/connections

Scope

connection: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)Service returns list of connections for specified client

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

  1. This service must return list of clients connections for specified client ID. Client connections are restricted by Client ID and its context

    1. Extract client_type from token

    2. Validate specified Client ID according to context:

      1. Mithril Admin - receives all client records

      2. MSP, MIS, PHARMACY - receives only its own client

        1. in case of error generate 403 response ('forbidden')

Prepare response

  1. Query data from mithril.connections for specified Client ID

  2. Hide secret from response

Configuration parameters

N/A

Dictionaries

N/A

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
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
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
...
Authorize
  1. Verify the validity of access token
    1. in case of error return 401 ('Access denied')
  2. Check user scope connection:read in order to perform this action
    1. in case of error generate 403 response ('Invalid scopes')
Processing
N/A
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": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "client_id": "c4a6d45f-2cf2-4e6d-909a-5962604ad63b",
      "consumer_id": "25c03af6-69bd-439e-b0dd-f1669b3dbbfd",
      "redirect_uri": "https://example2.com"
    }
  ],
  "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
200
404
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
Response
 
3
401
Unauthorized
Access denied
Помилка підтвердження
 
4
Специфічні
403
Invalid scopes
 
5
422
Only for active MPI record can be created medication request!
403
Forbidden
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
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...