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

[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-001005-001007-001004-00010125

Microservices (namespace)

MPIIL

Component

AuthEmployees

Component ID

COM-001005-001007

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/manageemployee-client-configurationroles/get-clientemployee-detailsroles

Resource

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

Scope

employee_role: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)This WS is designed to search (get list) of Employee roles.

Logic

  1. Only authenticated and authorized user can use this service

  2. Service returns only employee roles related to the same legal entity as the user

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

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
Content-Type:application/jsonAuthorization:Bearer c2778f3064753ea70de870a53795f5c9
Key
Value
Mandatory
Description
Example
1
Content-Type
application/json
M
Тип контенту
2
Authorization
Bearer c2778f3064753ea70de870a53795f5c9
M
Перевірка користувача
3
Request data validation
Authorize
...
  1. Verify the 
...
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, example
...
titleExample
...
  1. validity of access token
    1. Return 401 in case validation fails
  2. Check scopes in order to perform this action (scope = 'employee_role:read')
    1. Return 403 in case invalid scope(s)
Processing
  1. Extract client_id from token
  2. Return entries filtered by client_id and query params
Response structure examples
See on API-specification 
 Expand
titleExample
 Code Block
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "7c3da506-804d-4550-8993-bf17f9ee0402",
      "healthcare_service_id": "98b6ed10-17b4-44f1-892c-7514f66bf505",
      "employee_id": "9d229fcb-6a77-4574-99a5-30729aa518fd",
      "start_date": "2019-04-20T19:14:13Z",
      "end_date": "2017-12-20T19:14:13Z",
      "status": "ACTIVE",
      "is_active": true,
      "inserted_at": "2017-04-20T19:14:13Z",
      "inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
      "updated_at": "2017-04-20T19:14:13Z",
      "updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
    }
  ],
  "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
1000201
404 Response
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
 
3
401
Unauthorized
Помилка підтвердження
4
Специфічні
5
422
Only for active MPI record can be created medication request! Invalid access token
4
403
 Invalid scope(s)
5
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"
...