Versions Compared

Version Old Version 31 New Version Current
Changes made by

Oleksandr Zhuk (SoE eHealth) (Unlicensed)

Oleksandr Zhuk (SoE eHealth) (Unlicensed)

Saved on

Key

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

...

Page Properties
idAPI_Specification

Link

https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/private.-update-contract-request-by-nhs-signer

Посилання на Apiary або Swagger

Resource

/api/contract_requests/{{id}}

Посилання на ресурс, наприклад: /api/persons/create

Scope

contract_request:update

Scope для доступу

Components

Contracts

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

API paragraph not found

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

PATCH

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

API paragraph not found

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Preconditions

Before this the contract request should be created from MSP/PHARAMCY side and NHS employee should be appointed

...

  • NHS employee with scopes 'contract_request:update' can change contract request

  • Contract request only in status 'IN_PROCESS' could be changed

  • NHS employee can change only several field of the contract request but not all of them

  • In case of reimbursement contract, nhs_contract_price shouldn`t be filled.

Input parameters

Input parameter

Values

Type

Description

Example

id

String

Contract request identifier. Required

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

Request structure

Example:

...

Request to process the request using a token in the headers

Headers

Наприклад:

Content-Type:application/json

...

  • Verify the validity of access token

    • Return 401 in case validation fails

  • Check if token is not expired

    • in case error return 401 - "Token is expired"

Validate user

...

extract client_id from token

...

Fill the fields of contract_request in DB with information from request and from employee token:

field

value

contract_requests.nhs_signer_id

$nhs_signer_id

contract_requests.nhs_legal_entity_id

$client_id

contract_requests.nhs_signer_base

$.nhs_signer_base

contract_requests.issue_city

$.issue_city

contract_requests.nhs_contract_price

$.nhs_contract_price

contract_requests.nhs_payment_method

$.nhs_payment_method

contract_requests.updated_by

$.user_id

contract_requests.updated_at

now()

Response structure

Expand
Code Block
{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
    "contract_type": "REIMBURSEMENT",
    "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"
    },
    "id_form": "RMB-1",
    "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"
        }
      ]
    },
    "nhs_signer_base": "на підставі наказу",
    "nhs_contract_price": 50000,
    "nhs_payment_method": "BACKWARD",
    "status": "NEW",
    "status_reason": "Не відповідає попереднім домовленостям",
    "issue_city": "Київ",
    "contract_number": "0000-9EAX-XT7X-3115",
    "contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
    "start_date": "2017-04-20",
    "end_date": "2017-04-20",
    "printout_content": "Contract request content",
    "previous_request_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "assignee_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
    "medical_programs": [
      "3914a240-63db-404e-b730-09222bfeb2d0"
    ],
    "updated_at": "2017-04-20T19:14:13Z",
    "inserted_at": "2017-04-20T19:14:13Z"
  }
}

field

value

contract_requests.nhs_signer_id

$nhs_signer_id

contract_requests.nhs_legal_entity_id

$client_id

contract_requests.nhs_signer_base

$.nhs_signer_base

contract_requests.issue_city

$.issue_city

contract_requests.nhs_contract_price

$.nhs_contract_price

contract_requests.nhs_payment_method

$.nhs_payment_method

contract_requests.updated_by

$.user_id

contract_requests.updated_at

now()

contract_request_update_response.json_schema

...