REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This WS is designed to return rule engine rule details.

Key points

1. This is a REST method used by MIS.

2. Only authenticated and authorized employee with appropriate scope can get rule engine rule details.

Logic

1. Get data from rule_engine_rules collection (Mongo DB):

   1. rule_engine_rule by id

2. Render a response according to specification.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input parameters

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Headers

Request data validation

Validate rule engine rule

1. Check that rule engine rule with such ID exists in the system (is_active = true)

   1. In case of error - return 404 "Rule with id <rule_id> is not found", where rule_id - id of rule from request

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

{
  "data": {
    "id": "1f8444a0-e48b-440b-a082-c4703233efa2",
    "name": "Some name",
    "code": {
      "system": "eHealth/clinical_impression_patient_categories",
      "code": "insulin_1"
    },
    "description": "Some text",
    "is_active": true,
    "value": {
      "json": "Rule engine rule value in Json Logic format",
      "string": "Кількість з Діагнози де (Деякий з Діагноз.Кодування має Код з довідника = [E10.64, E11.64, E13.64, E14.64] та Клінічний статус = [активний] та Вид діагнозу = [заключний] та Дата створення запису >= NOW - 6 місяців) == 2"
    }
  },
  "meta": {
    "code": 200,
    "url": "http://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  }
}

HTTP status codes

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used