Table of Contents

minLevel	1
maxLevel	3

...

Purpose

...

This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP/PHARMACY employee (public API).
Contract type should be declared in the URL.

Specification

...

Page Properties
Link
https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contracts/public.-get-contract-details
Resource
/api/contracts/{{contract_type}}/{{id}}
Scope
contract:read
Components
Contracts
Microservices
API paragraph not found
Protocol type
REST
Request type
GET
Sync/Async
Sync
Public/Private/Internal
Public

Logic

...

This method is designed to get full information of contract by id.
Contract type (capitation or reimbursement) should be declared in the URL.

Input parameters

Input parameter

Values

Type

Description

Example

Description

Example

contract_type

capitation

reimbursement

String

contract type

id

String

contract identifier

d290f1ee-6c54-4b01-90e6-d701748f0851

Request structure*

API paragraph not found

Authorize

...

Request to process the request using a token in the headers

Headers

...

Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

...

Validate token

Verify the validity of access token
- Return 401 in case validation fails
token is not expired
- in case error return 401

...

Check user scopes in order to perform this action (scope = 'contract:read')
1. Return 403 in case invalid scope(s)

Validate employee

extract user_id from token

...

Validate contract id. Check contract.id = $.id
- in case error return 404 ("Contract with id=$id doesn't exist")

Processing*

API paragraph not found

...

Dictionaries

CONTRACT_PAYMENT_METHOD
CONTRACT_TYPE
REIMBURSEMENT_CONTRACT_TYPE
ADDRESS_TYPE
COUNTRY
SETTLEMENT_TYPE
STREET_TYPE
PHONE_TYPE
SPECIALITY_TYPE
SPECIALITY_LEVEL
SPEC_QUALIFICATION_TYPE

Response structure

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
    "contract_type": "CAPITATION",
    "start_date": "2017-04-20",
    "contractor_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "contractor_owner": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    },
    "contractor_base": "на підставі закону про Медичне обслуговування населення",
    "contractor_payment_details": {
      "bank_name": "Банк номер 1",
      "MFO": "351005",
      "payer_account": "32009102701026"
    },
    "contractor_rmsp_amount": 50000,
    "contractor_divisions": [
      {
        "id": "2922a240-63db-404e-b730-09222bfeb2dd",
        "name": "Бориспільське відділення Клініки Ноунейм",
        "addresses": [
          {
            "type": "RESIDENCE",
            "country": "UA",
            "area": "Житомирська",
            "region": "Бердичівський",
            "settlement": "Київ",
            "settlement_type": "CITY",
            "settlement_id": "b075f148",
            "street_type": "STREET",
            "street": "вул. Ніжинська",
            "building": "15",
            "apartment": "23",
            "zip": "02090"
          }
        ],
        "phones": [
          {
            "type": "MOBILE",
            "number": "+380503410870"
          }
        ],
        "email": "email@example.com",
        "working_hours": {
          "mon": [
            [
              "08.00",
              "12.00"
            ],
            [
              "14.00",
              "18.00"
            ]
          ],
          "tue": [
            [
              "08.00",
              "12.00"
            ]
          ],
          "wed": [
            [
              "08.00",
              "12.00"
            ]
          ],
          "thu": [
            [
              "08.00",
              "12.00"
            ]
          ],
          "fri": [
            [
              "08.00",
              "12.00"
            ]
          ]
        },
        "mountain_group": false
      }
    ],
    "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": "Послуга ПМД"
          }
        ]
      }
    ],
    "contractor_employee_divisions": [
      {
        "employee": {
          "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
          "party": {
            "first_name": "Петро",
            "last_name": "Іванов",
            "second_name": "Миколайович"
          },
          "speciality": {
            "speciality": "THERAPIST",
            "speciality_officio": true,
            "level": "FIRST",
            "qualification_type": "AWARDING",
            "attestation_name": "Академія Богомольця",
            "attestation_date": "2017-02-28",
            "valid_to_date": "2020-02-28",
            "certificate_number": "AB/21331"
          }
        },
        "staff_units": 0.5,
        "declaration_limit": 2000,
        "division_id": "2922a240-63db-404e-b730-09222bfeb2dd"
      }
    ],
    "nhs_signer_base": "на підставі наказу",
    "nhs_contract_price": 50000,
    "nhs_payment_method": "prepayment",
    "status": "VERIFIED",
    "reason": "не було виконано умов контракту",
    "status_reason": "default",
    "nhs_signer": {
      "id": "b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
        "first_name": "Петро",
        "last_name": "Іванов",
        "second_name": "Миколайович"
      }
    },
    "nhs_legal_entity": {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "Клініка Ноунейм",
      "edrpou": "32323454",
      "addresses": [
        {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      ]
    },
    "issue_city": "Київ",
    "contract_number": "0000-9EAX-XT7X-3115",
    "contract_request_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "is_suspended": false,
    "end_date": "2017-04-20",
    "id_form": "PMD",
    "parent_contract_id": "09106b70-18b0-4726-b0ed-6bda1369fd52"
  },
  "urgent": {
    "documents": [
      {
        "type": "SIGNED_CONTENT",
        "url": "https://storage.ehealth.world"
      }
    ]
  }
}

...

In response show ops.contracts.id+ops.contractor_employees.id and end_date is null

Post-processing processes*

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error
200

Versions Compared

Old Version 17

New Version Current

Key

Purpose

This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP/PHARMACY employee (public API).
Contract type should be declared in the URL.

Specification

Logic

This method is designed to get full information of contract by id.
Contract type (capitation or reimbursement) should be declared in the URL.

Input parameters

Request structure*

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate token

Validate employee

Processing*

Dictionaries

Response structure

Post-processing processes*

HTTP status codes

Page Comparison

Versions Compared

Old Version 17

New Version Current

Key

Purpose

This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP/PHARMACY employee (public API). Contract type should be declared in the URL.

Specification

Logic

This method is designed to get full information of contract by id.Contract type (capitation or reimbursement) should be declared in the URL.

Input parameters

Request structure*

Authorize

Request to process the request using a token in the headers

Headers

Наприклад:Content-Type:application/jsonAuthorization:Bearer c2778f3064753ea70de870a53795f5c9

Request data validation

Validate token

Validate employee

Processing*

Dictionaries

Response structure

Post-processing processes*

HTTP status codes

This web service is designed to obtain full information about capitation or reimbursement contract by NHS employee(private API) or MSP/PHARMACY employee (public API).
Contract type should be declared in the URL.

This method is designed to get full information of contract by id.
Contract type (capitation or reimbursement) should be declared in the URL.

Наприклад:
Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9