Versions Compared

Version Old Version 3 New Version Current
Changes made by

Anzhela Kovalenko (SoE eHealth)

Anzhela Kovalenko (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] REST API Get capitation reports [API-005-001-001-0015]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

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

Date of update

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

Method API ID

API-005-001-001-0015

Microservices (namespace)

IL

Component

Contract reports

Component ID

COM-005-001

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/capitation-reports/get-capitation-reports

Resource

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

Scope

capitation_report: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 This method returns a list of all available already created capitation reports

Logic

N/A

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

...

language

...

json

...

Headers
...
Headers 
...
Request data validation
...
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
...
Authorize
  1. Verify the validity of access token
    1. in case of error return 401 ('Access denied')
  2. Check user scope capitation_report:read in order to perform this action
    1. in case of error generate 401 response ('Invalid scopes')
Verify role
Extract from token:
  1. Validate client_id (is_blocked=false)
    1. in case of error return 403 Error ('Client is blocked')
  2. In case WS was called by MSP check contractor_legal_entity is active
    • in case error return 403 - ('Client is not active')
Processing
N/A
Response structure examples
Return array of existing reports according to Apiary and Capitation Report Data Structure
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": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "billing_date": "2018-05-01",
      "inserted_at": "2018-05-22"
    }
  ]
}
HTTP status codes
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
1000
200
4043
Response
Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
3
401
Access denied
4
401
Unauthorized
Invalid scopes
Помилка підтвердження
5
4
403
Специфічні
Client is blocked
5
6
422
Only for active MPI record can be created medication request!
403
Client is not active
7
Специфічні
8
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"
...