ЕСОЗ - публічна документація

[DRAFT] REST API Get capitation report details [API-005-001-001-0016]

Owned by Kateryna Yakovleva
Last updated: yesterday at 4:45 PM by Anastasiia Prokhorova (SoE eHealth)
4 min read

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

https://e-health-ua.atlassian.net/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

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-001-001-0016

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-report-details

Resource

{{host}}/api/capitation_report_details

Scope

capitation_report:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

Purpose

This method returns details of the specified capitation report

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

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

 

 

 

 

 

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Key

Value

Mandatory

Description

Example

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

 

 

 

 

 

Request data validation

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

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification

  1. Generate synthetical id for each object in response

    1. id = edrpou +  '-' + report_id

  2. In case WS was called by NHS

    1. Select all capitation_report_details by id

    2. Return the result

  3. In case WS was called by MSP

    1. Extract legal_entity_id from token

    2. search for merged_from_legal_entities 

    3. Select capitation_report_details where legal_entity_id = legal_entity_id (from step a) and legal_entity_id = merged_from_legal_entities_id (from step b)

    4. Return the result

{ "meta": { "code": 200, "url": "https://example.com/resource", "type": "object", "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810" }, "data": [ { "id": "29000165-09106b70-18b0-4726-b0ed-6bda1369fd52", "biling_date": "2017-04-20", "report_id": "09106b70-18b0-4726-b0ed-6bda1369fd52", "legal_entity_id": "09106b70-18b0-4726-b0ed-6bda1369fd52", "edrpou": "29000165", "legal_entity_name": "Поліклініка для Капітації", "capitation_contracts": [ { "contract_id": "09106b70-18b0-4726-b0ed-6bda1369fd52", "contract_number": "0000-9EAX-XT7X-3115", "details": [ { "mountain_group": true, "attributes": { "0-5": 17, "6-17": 7, "18-39": 9, "40-65": 12, "65+": 15 } }, { "mountain_group": false, "attributes": { "0-5": 22, "6-17": 10, "18-39": 15, "40-65": 19, "65+": 21 } } ], "total": { "attributes": { "0-5": 39, "6-17": 17, "18-39": 24, "40-65": 31, "65+": 36 } } } ] } ] }

HTTP status codes

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 Response

 

Помилка підтвердження

3

 

401

Access denied

 

 

4

 

401

Invalid scopes

 

 

5

 

403

Client is not active

 

 

6

 

403

Client is blocked

 

 

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 modules where the method is used

 

ЕСОЗ - публічна документація