Table of Contents
minLevel1
maxLevel3

Required parameters are marked with "*"

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

Purpose*

This method allows to create new contract record in DB through the NHS IT system

...

Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

Developer

Розробник методу API. Наприклад, Edenlab

Project Manager

@Єлизавета Гессен-Дармштадська

Tech Lead

@Іоанн Воїнов

Product Owner

@Нікодім Святогорцев

Вusiness analyst

@Пантелеймон Нікомедійський

Status

Status
colourGreen
titleAPPROVED

Version

1.0

Date of release

Link

https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contracts/private.-create-contract

Resource

/api/admin/contracts

Scope

private_contracts:write

Components

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

Microservices

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

Protocol type

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

Request type

POST

Sync/Async

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

Logic*

API paragraph not found

Filters правильно ли атрибуты указаны в качестве фильтров?

...

Filter

...

Values

...

Type

...

Description

...

Example

...

start_date

...

string

...

contract start date

...

2017-04-20

...

end_date

...

string

...

contract end date

...

2017-04-20

...

status

...

string

...

contract status

...

VERIFIED

...

contractor_legal_entity_id

...

string

...

56440c03-e218-432a-b417-9574b2b287bd

...

contractor_owner_id

...

string

...

54fea667-62cf-4688-ae9e-31acc19d986d

...

contractor_base

...

string

...

documents which allows to represent clinic

...

на підставі закону про Медичне обслуговування населення

...

contractor_payment_details

...

как заполнять вложенные переменные ??

...

object

...

contractor_rmsp_amount

...

number

...

the amount of population which were served by this MSP

...

50000

...

external_contractor_flag

...

boolean

...

the existence of second appendix

...

true

...

external_contractors

...

как заполнять вложенные переменные ??

...

array

...

nhs_signer_id

...

string

...

da8cc932-7bca-4048-a3ff-9b07f901a860

...

nhs_signer_base

...

string

...

documents which allows to represent nhs

...

на підставі наказу

...

nhs_legal_entity_id

...

string

...

e5f76afb-4d96-4279-bcf1-0308457e6b64

...

nhs_payment_method

...

как заполнять вложенные переменные ??

...

enum

...

is_suspended

...

boolean

...

whether the contract is active or temporary suspended

...

false

...

issue_city

...

string

...

place of contract request

...

Київ

...

nhs_contract_price

...

number

...

contract price

...

50000

...

contract_number

...

string

...

human readable number of contract request

...

0000-9EAX-XT7X-3115

...

status_reason

...

string

...

The reason of terminated status

...

default

...

parent_contract_id

...

string

...

09106b70-18b0-4726-b0ed-6bda1369fd52

...

id_form

...

string

...

PMD

...

nhs_signed_date

...

string

...

Date when contract was signed by NHS

...

2017-04-20

...

type

...

string

...

CAPITATION

...

reason

...

string

...

additional the reason of terminated status

...

не було виконано умов контракту

...

signed_content_location

...

string

...

Location of the signed content in media storage

...

bucket_name/folder_identifier/file_name

...

medical_programs

...

как заполнять вложенные переменные ??

...

Request structure*

See on Apiary

...

Request to process the request using a token in the headers

Headers*

Наприклад:

  • Content-Type:application/json

  • api-key:c2778f3064753ea70de870a53795f5c9

...

Post-processing processes*

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

HTTP status codes*

HTTP status code

Message

What caused the error

 201

 

 

...