Versions Compared

Version Old Version 9 New Version Current
Changes made by

Anastasiia Prokhorova (SoE eHealth)

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

Document type

Метод REST API

Document title

[Document statusDRAFT] REST API [Назва методу] [ID методу]Get capitation report details [API-005-001-001-0016]

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

...

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)N/A

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 ConfluenceN/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

1

2

Request structure

See on API-specification

Expand
titleExample
Code Block

Headers

...

Key

...

Value

...

Mandatory

...

Description

...

Example

...

Content-Type

...

application/json

...

M

...

Тип контенту

...

Content-Type:application/json

...

languagejson
Headers
Headers 
Request data validation
Authorize
...
  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 APIN/A
Response structure examples
...
 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": "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
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 N/A
Technical modules where the method is used
 Page Properties Report
headingsID ТМ, Статус
cqllabel = "tr-mis"
...