Required parameters are marked with "*"

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

Purpose*

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

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

Specification*

Project Name	COVID-certificate
Project abreviation	SVC
Developer	Розробник методу API. Наприклад, Edenlab
Project Manager	@Єлизавета Гессен-Дармштадська
Tech Lead	@Іоанн Воїнов
Product Owner	@Нікодім Святогорцев
Вusiness analyst	@Пантелеймон Нікомедійський
Status	APPROVED
Version	1.0
Date of release	22 Jun 2022
Link	https://uaehealthapi.docs.apiary.io/#reference/private.-contracts/private-contracts/private.-update-contract
Resource	/api/admin/contracts/{{id}}
Scope	private_contracts:write
Components	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	Перелік мікросервісів, які використовує метод API. Наприклад: Auth, ABAC
Protocol type	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PUT
Sync/Async	Метод є синхронним чи асинхронним?

Logic*

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

Input parameters

Input parameter	Values	Type	Description	Example
id		String		`801f37f5-52c8-477e-aba5-a1d01876d210`

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

Request structure*

See on Apiary

Example:

Request example

{
  "category": {
    "coding": [
      {
        "system": "eHealth/composition_categories",
        "code": "LIVE_BIRTH"
      }
    ]
  },
  "type": {
    "coding": [
      {
        "system": "eHealth/composition_types",
        "code": "NEWBORN"
      }
    ]
  },
  "event": [
    {
      "code": {
        "coding": [
          {
            "system": "eHealth/composition_events",
            "code": "COMPOSITION_VALIDITY_PERIOD"
          }
        ]
      },
      "period": {
        "start": "2020-06-26T15:22:53.403Z",
        "end": "2020-07-26T15:22:53.403Z"
      }
    }
  ],
  "subject": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "encounter": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "author": {
    "type": {
      "coding": [
        {
          "system": "eHealth/composition",
          "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "section": {
    "focus": {
      "type": {
        "coding": [
          {
            "system": "eHealth/composition",
            "code": "string"
          }
        ],
        "text": "string"
      },
      "value": "e49abc30-6d17-11ea-b83c-673680173afa"
    }
  },
  "extension": [
    {
      "valueCode": "AUTHORIZE_WITH",
      "valueUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    {
      "valueCode": "IS_ACCIDENT",
      "valueBoolean": true
    },
    {
      "valueCode": "TREATMENT_VIOLATION",
      "valueString": "late_arrival"
    },
    {
      "valueCode": "TREATMENT_VIOLATION_DATE",
      "valueDate": "2020-12-12"
    },
    {
      "valueCode": "IS_INTOXICATED",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FOREIGN_TREATMENT",
      "valueBoolean": true
    },
    {
      "valueCode": "IS_FORCE_RENEW",
      "valueBoolean": true
    }
  ]
}

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

JSON schema

{
  "$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*