Table of Contents

minLevel	1
maxLevel	3

Required parameters are marked with "*"

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

Purpose*

...

Наприклад: This method WS allows to receive active person declarations issued by the current legal entity (based on access_token)get list of forbidden groups without details by legal entity employees. Used to get id and name of the forbidden group to achieve permissions on it with help of approval

Specification*

Page Properties

Project Name

COVID-certificate

Project abreviation

SVC

Developer

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

Project Manager

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

Tech Lead

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

Product Owner

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

Вusiness analyst

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

Status

Status

colour	Green
title	APPROVED

Version

1.0

Date of release

22 Jun 2022

Link

Посилання на Apiary або Swaggerhttps://ehealthmisapi1.docs.apiary.io/#reference/public.-forbidden-groups/get-forbidden-group-list/get-forbidden-group-list

Resource

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

Scope

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

Components

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

Microservices

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

Protocol type

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

Request type

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

Sync/Async

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

Logic*

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

Preconditions

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

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

Global and configurable 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”

...

_{(Example: CARE_PLAN_CLASS_1_ICD10_AM_CONDITIONS_ALLOWED)}

Input parameters

Потрібно вказати вхідні параметри запиту. Наприклад, для GET /patients/composition/job/{{asyncJobId}} вхідний параметр:

...

Input parameter

...

Values

...

Type

...

Description

...

Example

...

asyncJobId

...

String

...

Async Job Object ID

Filters

Потрібно вказати фільтри. Наприклад, для GET /api/medication_requests/{{id}}/dispenses?status=PROCESSED фільтр:

...

Filter

...

Values

...

Type

...

Description

...

Example

...

status

...

String

...

Optional

...

PROCESSED

...

This web service returns a catalog of all active forbidden groups in eHealth.

Preconditions

Key points

This is a REST method used by MIS
Authorization is not needed to get Forbidden group list (as dictionaries).

Input parameters

Input parameter	Type	Description	Example
name	String	Forbidden group name	`Some name`
page	Numbe	Page number	`2`
page_size	Numbe	A limit on the number of objects to be returned, between 1 and 100. Default: 50	`50`

Request structure*

API paragraph not found

Authorize*

Request to process the request using a token in the headers

Headers*

Наприклад:

Content-Type:application/json

Validate request*

API paragraph not found

Request data validation*

API paragraph not found

Processing*

Search params

forbidden group name

Service logic

Filter active forbidden_groups by search params
Render found forbidden_groups with following params only:
1. id
2. name

Response structure*

See on Apiary

Example:

Expand

title	Request Response example

Code Block

{
  "categorymeta": {
    "coding": [
      {
        "system": "eHealth/composition_categories",
        "code": "LIVE_BIRTH"
      }
    ]
  }200,
  "type": {     "codingurl": [
      {         "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",
    "https://example.com/resource",
     "code": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afa"
  },
  "encounter": {
    "type": {       "coding": [
        {
          "system": "eHealth/composition",
     "object",
    "coderequest_id": "string"
        }
      ],
      "text": "string"
    },
    "value": "e49abc30-6d17-11ea-b83c-673680173afareq-adasdoijasdojsda"
  },
  "author": {
    "type": {
      "codingdata": [
   
    {
          "systemid": "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

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",
    "status": "PENDING",
    "eta": "string",
    "doneAt": "string",
    "links": [
      {
        "entity": "eHealth/composition",
        "href": "composition/0daaad78-6cfb-11ea-9cd6-afab698838bc",
        "error": "string"
      }
    ]
  }
}

f7f817b2-3134-4625-b87d-e2d7fc8e9b90",
      "name": "Some name"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes*

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

HTTP status codes*

HTTP status code	Message	What caused the error

200

Backward compatibility

...

Versions Compared

Old Version 1

New Version 2

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Global and configurable parameters

Input parameters

Filters

Preconditions

Key points

Input parameters

Request structure*

Authorize*

Headers*

Validate request*

Request data validation*

Processing*

Search params

Service logic

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

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Required parameters are marked with "*"

Purpose*

Specification*

Logic*

Preconditions

Global and configurable parameters

Input parameters

Filters

Preconditions

Key points

Input parameters

Request structure*

Authorize*

Headers*

Validate request*

Request data validation*

Processing*

Search params

Service logic

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