Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

...

Purpose*

Необхідно зазначити призначення методу.

Наприклад: This method allows to receive active person declarations issued by the current legal entity (based on access_token)

Specification*

...

Link

...

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

...

Resource

...

Наприклад: /api/persons/create

...

Scope

...

Зазначається потрібний scope

...

Components

...

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

...

Microservices

...

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

...

Protocol type

...

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

...

Request type

...

Тип HTTP методу, який використовується запитом, наприклад: POST | GET…

...

Sync/Async

...

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

Logic*

Потрібно по пунктах описати логіку методу API або додати діаграму

Preconditions

Які передумови мають бути виконані системою/користувачем. Наприклад:

створений запис в MedicationRequest;
рецепт відпущений (COMPLETED)

Global and configuration parameters

Потрібно вказати глобальні та конфігураційні параметри.

Наприклад:

...

Variable

...

Values

...

Description

...

CARE_PLAN_<category>_ICD10_AM_CONDITIONS_ALLOWED

...

Values that matches with dictionaryeHealth/ICD10_AM/condition_codes

Example: “E10.32, E11.92”

...

Allowed diagnoses for specified care plan category. Diagnoses should match with eHealth/ICD10_AM/condition_codes dictionary, <category> - is a value from dictionary eHealth/care_plan_categories in uppercase

_{(Example: CARE_PLAN_CLASS_1_ICD10_AM_CONDITIONS_ALLOWED)}

Input parameters

Потрібно вказати вхідні параметри, наприклад:

...

Input parameter

...

Values

...

Type

...

Description

...

Example

...

asyncJobId

...

String

...

Async Job Object ID

Filters

Потрібно вказати фільтри. Наприклад:

...

Filter

...

Values

...

Type

...

Description

...

Example

...

id

...

String

...

7f93-4fc2-b2ec-2d81b19a9b7b (string, required)

...

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

Request structure*

See on Apiary

Example:

...

title	Request example

...

Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

This WS allows to terminate contract request by legal entity.

Specification*

Page Properties

Link	https://ehealthmisapi1.docs.apiary.io/#reference/public.-contracts/contract-request/public.-terminate-contract-request-by-msp
Resource	/api/contract_requests/contract_type/{id}/actions/terminate
Scope	contract_request:terminate
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PATCH
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

This WS is designed to terminate contract request by contractor. Contract request can't be in status='SIGNED'

Input parameters

Потрібно вказати вхідні параметри, наприклад:

Input parameter	Values	Type	Description	Example
id		String		`b075f148-7f93-4fc2-b2ec-2d81b19a9b7b`

Request structure*

See on Apiary

Example:

Expand

title	Request example

Code Block
{ "status_reason": "Неправильний період контракту" }

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Verify the validity of access token
1. in case of error return 401 ('Access denied')
Check user scope contract_request:termiante in order to perform this action
1. in case of error generate 401 response ('Invalid scopes')

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9

Validate request*

Наприклад:

Validate request using JSON schema
1. In case validation failed - generate 422 error

Expand

title	JSON schema

Code Block

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}

Validate User

Extract party_id (associated with user_id) from token.
1. Check party_id=party.contractor_owner_id
  1. in case of error return 403 "User is not allowed to perform this action"

Validate contract request status

Check contract_request.status<>SIGNED
- in case error return 422 - "Incorrect status of contract_request to modify it"

Request data validation*

Валідація даних

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Auto termination

Fetch all contract_request with start_date<now().
for REIMBURSEMENT contracts
- - find contracts in status NHS_SIGNED and nhs_signed < today -`REIMBURSEMENT_CONTRACT_REQUEST_AUTOTERMINATION_PERIOD_DAYS`
for CAPITATION contracts
- - find contracts in status NHS_SIGNED and nhs_signed < today -`CAPITATION_CONTRACT_REQUEST_AUTOTERMINATION_PERIOD_DAYS`

Set status and status reason for such contract request as below:

field	value
status	TERMINATED
status_reason	$.auto_expired
updated_at	now()
updated_by	$.user_id

Add status to event manager

After status was changed (status = TERMINATED) - add new status to event_manager

field	value
`event_type`	`StatusChangeEvent`
`entity_type`	Contract_request
`entity_id`	$.id
`properties.status.new_value`	$.status
`event_time`	$.update_at
`changed_by`	$.`changed_by`

Response structure*

See on Apiary 2 куска кода с номером кода 200. что с этим делать? втсавлять оба??

Example:

Expand

title	Response example

Code Block

{
  "meta": {
    "code": 201,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": {
    "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
    "contract_type": "REIMBURSEMENT",
    "contractor_legal_entity": {
      "codingid": ["df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name":  {
   "Клініка Ноунейм",
      "systemedrpou": "eHealth/composition32323454",
          "codeaddresses": "string"[
        }
 {
    ],       "texttype": "stringRESIDENCE",
     },     "valuecountry": "e49abc30-6d17-11ea-b83c-673680173afa"UA",
  },   "encounter": {    "area": "type": {Житомирська",
          "codingregion": ["Бердичівський",
           {"settlement": "Київ",
          "systemsettlement_type": "eHealth/compositionCITY",
          "codesettlement_id": "stringb075f148",
        }  "street_type": "STREET",
   ],       "textstreet": "string"вул. Ніжинська",
     },     "valuebuilding": "e49abc30-6d17-11ea-b83c-673680173afa"15",
       },   "authorapartment": {
 "23",
  "type": {       "codingzip": ["02090"
        {}
      ]
   "system": "eHealth/composition", },
    "contractor_owner": {
      "codeid": "string"b075f148-7f93-4fc2-b2ec-2d81b19a9b7b",
      "party": {
}       ],       "textfirst_name": "stringПетро",
    },
    "valuelast_name": "e49abc30-6d17-11ea-b83c-673680173afa"
  }Іванов",
  "section": {     "focussecond_name": {"Миколайович"
      "type":}
{    },
    "codingcontractor_base": [
          { "на підставі закону про Медичне обслуговування населення",
    "contractor_payment_details": {
      "systembank_name": "eHealth/compositionБанк номер 1",
    
       "codeMFO": "string351005",
          }
   "payer_account": "32009102701026"
    ]},
   
    "textid_form": "stringRMB-1",
    "nhs_signer": {
},
      "valueid": "e49abc30b075f148-6d177f93-11ea4fc2-b83cb2ec-673680173afa2d81b19a9b7b",
    }
  },   "extensionparty": [
  {
 {       "valueCodefirst_name": "AUTHORIZE_WITHПетро",
        "valueUuidlast_name": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }Іванов",
    {
      "valueCodesecond_name": "IS_ACCIDENTМиколайович",
      "valueBoolean":}
true     },
    "nhs_legal_entity": {
      "valueCodeid": "TREATMENT_VIOLATIONdf9f70ee-4b12-4740-b0f5-bb5aea116863",
      "valueStringname": "late_arrival"
    },
 Клініка Ноунейм",
  {       "valueCodeedrpou": "TREATMENT_VIOLATION_DATE32323454",
      "valueDateaddresses": "2020-12-12" [
       }, {
   {       "valueCodetype": "IS_INTOXICATEDRESIDENCE",
      "valueBoolean": true     }"country": "UA",
    {       "valueCodearea": "IS_FOREIGN_TREATMENTЖитомирська",
      "valueBoolean": true     },
"region": "Бердичівський",
   {       "valueCodesettlement": "IS_FORCE_RENEWКиїв",
          "valueBoolean": true"settlement_type": "CITY",
      }   ]
}

Authorize*

Вимоги до авторизації: яким чином надається доступ до використання методу

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json
Authorization:Bearer c2778f3064753ea70de870a53795f5c9
api-key:uXhEczJ56adsfh3Ri9SUkc4en

Validate request*

Наприклад:

Validate request using JSON schema
1. In case validation failed - generate 422 error

Expand

title	JSON schema

Code Block

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "verification_code": {
      "type": "string"
    }
  },
  "required": [
    "verification_code"
  ],
  "additionalProperties": false
}

Request data validation*

Валідація даних

Parameters that are used when processing the request

Configuration parameters

Наприклад: Доступ до методу визначається скоупом covid_certificate:get . Дозвіл на даний скоуп визначається адміністратором Системи шляхом конфігурування скоупів в контексті клієнтів і ролей.

Dictionaries

Потрібно вказати довідники, які використовує метод API

Processing*

Потрібно описати процеси, які відбуваються з даними

1. Using global parameters

Потрібно викликати глобальні параметри (Global parameters), щоб отримати наведені нижче параметри

Response structure*

See on Apiary

Example:

Expand

title	Response example

Code Block

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6 "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",
    "statusparent_contract_id": "PENDING22e416c4-5747-41cd-9f73-c3a85cdee885",
    "etastart_date": "string2017-04-20",
    "doneAtend_date": "string2017-04-20",
    "linksprintout_content": ["Contract request content",
    {
        "entity"previous_request_id": "eHealth/composition",
   df9f70ee-4b12-4740-b0f5-bb5aea116863",
    "hrefassignee_id": "composition/0daaad7822e416c4-6cfb5747-11ea41cd-9cd69f73-afab698838bcc3a85cdee885",
        "error"medical_programs": [
 "string"       }"3914a240-63db-404e-b730-09222bfeb2d0"
    ]
  }
}

mapping

field	value
status	TERMINATED
status_reason	$.status_reason
updated_at	now()
updated_by	$.user_id

Post-processing processes*

Що має відбутися в ЦБД після опрацювання та відправлення відповіді, тощо

HTTP status codes

HTTP status code	Message	What caused the error

200

Backward compatibility

...

Version	Old Version 1	New Version 2
Changes made by	Serhii Boldin (SoE eHealth) (Unlicensed)	Serhii Boldin (SoE eHealth) (Unlicensed)
Saved on	Jul 13, 2022	Jul 13, 2022

Content Comparison

Versions Compared

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Global and configuration parameters

Input parameters

Filters

Request structure*

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Input parameters

Request structure*

Authorize*

Headers*

Validate request*

Validate User

Validate contract request status

Request data validation*

Processing*

1. Using global parameters

Auto termination

Add status to event manager

Response structure*

Authorize*

Headers*

Validate request*

Request data validation*

Parameters that are used when processing the request

Configuration parameters

Dictionaries

Processing*

1. Using global parameters

Response structure*

Post-processing processes*

HTTP status codes

Backward compatibility