Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel3

...

Filter

Values

Type

Description

Example

id

String

contract id

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

type

String

type of a contract

CAPITATIO

CAPITATION

REIMBURSEMENT

contractor_legal_entity_id

String

id of legal entity which created contract request

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

edrpou

String

contractor legal entity EDRPOU

5432345432

contractor_owner_id

String

id of legal entity owner

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

nhs_signer_id

String

id of nhs employee

b075f148-7f93-4fc2-b2ec-2d81b19a9b7b

status

Enum

current contract status

VERIFIED

TERMINATED

VERIFIED

is_suspended

Boolean

wether contract is suspensed

true

is_active

Boolean

wether contract is active

true

date_from_start_date

String

2019-01-01

date_to_start_date

String

2019-01-01

date_from_end_date

String

2019-01-01

date_to_end_date

String

2019-01-01

contract_number

String

human readable number of contract request

0000-9EAX-XT7X-3115

medical_program_id

String

id of a program that is a subject of reimbursement contract

2075f148-7f93-4fc2-b2ec-2d81b19a9b7b

page

Number

Page number

2

page_size

Number

A limit on the number of objects to be returned. Maximum: 500

50

Request structure

API paragraph not found

Authorize

  1. Verify the validity of api-key

    1. Return 401 in case validation fails

  2. Verify the validity of token

    1. Return 401 in case validation fails

  3. Check scopes in order to perform this action (scope = 'private_contracts:read')

    1. Return 403 in case invalid scope(s)

Request to process the request using a token in the headers

Headers

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

...

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

  2. Render resopse

Response structure

See on Apiary

...

Expand
titleResponse example
Code Block
{
  "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
  }
}

Post-processing processes

...

HTTP status codes

HTTP status code

Message

What caused the error

 200

 

 

...