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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

/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-002-001-0026

Microservices (namespace)

IL

Component

Contracts

Component ID

COM-005-002

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

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contracts/public.-get-contracts-list

Resource

{{host}}/api/admin/contracts

Scope

private_contracts:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Private

Purpose

This method allows to get all existing contracts with GB_CBP type through the NHS IT system

Logic

This method allows to get all existing contracts with GB_CBP type through the NHS IT system

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

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

 Example

Headers

Key

Value

Mandatory

Description

Example

1

Content-Type

application/json

M

Тип контенту

Content-Type:application/json

2

Authorization

Bearer c2778f3064753ea70de870a53795f5c9

M

Перевірка користувача

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

3

Request data validation

Validate request

  1. Only authenticated and authorized user can use this service

  2. Deleted records won't be shown in response

Processing

  1. Search contracts with type = GB_CBP in DB according to requested query parameters

  2. Render resopse

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

 Example
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "8be63914-a278-470b-b868-1af5b9087332",
      "start_date": "2017-04-20",
      "end_date": "2017-04-20",
      "status": "VERIFIED",
      "contractor_legal_entity_id": "56440c03-e218-432a-b417-9574b2b287bd",
      "contractor_owner_id": "54fea667-62cf-4688-ae9e-31acc19d986d",
      "contractor_base": "на підставі закону про Медичне обслуговування населення",
      "contractor_payment_details": {
        "bank_name": "Банк номер 1",
        "MFO": "351005",
        "payer_account": "32009102701026"
      },
      "contractor_rmsp_amount": 50000,
      "external_contractor_flag": true,
      "external_contractors": [
        {
          "legal_entity": {
            "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
            "name": "Клініка Ноунейм"
          },
          "contract": {
            "number": "1234567",
            "issued_at": "2018-01-01",
            "expires_at": "2019-01-01"
          },
          "divisions": [
            {
              "id": "2922a240-63db-404e-b730-09222bfeb2dd",
              "name": "Бориспільське відділення Клініки Ноунейм",
              "medical_service": "Послуга ПМД"
            }
          ]
        }
      ],
      "nhs_signer_id": "da8cc932-7bca-4048-a3ff-9b07f901a860",
      "nhs_signer_base": "на підставі наказу",
      "nhs_legal_entity_id": "e5f76afb-4d96-4279-bcf1-0308457e6b64",
      "nhs_payment_method": "prepayment",
      "is_suspended": false,
      "issue_city": "Київ",
      "nhs_contract_price": 50000,
      "contract_number": "0000-9EAX-XT7X-3115",
      "status_reason": "default",
      "parent_contract_id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "id_form": "PMD",
      "nhs_signed_date": "2017-04-20",
      "type": "CAPITATION",
      "reason": "не було виконано умов контракту",
      "signed_content_location": "bucket_name/folder_identifier/file_name",
      "medical_programs": [
        "d313342c-0b3c-443b-a92e-afb78d1e8086"
      ],
      "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

200

3

401

Unauthorized

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

4

1000

404

Composition not found

COMPOSITION_NOT_FOUND_404

Не знайдено медичний висновок

5

Специфічні

6

422

Only for active MPI record can be created medication request!

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

Generating page properties report...

  • No labels

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