Versions Compared

Old Version 3

changes.mady.by.user Anzhela Kovalenko (SoE eHealth)

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Prokhorova (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.

/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)

Properties of a REST API method document

Document type

Метод REST API

Document title

[Document status] REST API [Назва методу] [ID методуDRAFT] Get Rule engine rule details [API-005-005-001-0086]

Guideline ID

GUI-0011

Author

@

Document version

1

Document status

DRAFT

Date of creation

ХХ.ХХ.ХХХХ (дата фінальної версії документа – RC або PROD)

Date of update

ХХ.ХХ.ХХХХ (дата зміни версії)

Method API ID

API-005-005-001-0086

Microservices (namespace)

IL

Component

Dictionaries and Registers

Component ID

COM-005-005

Link на API-специфікацію

https://ehealthmedicaleventsapimedicaleventsmisapi.docs.apiary.io/#reference/rule-engine-rules/get-rule-engine-rule-details/get-rule-engine-rule-details

Resource

{{host}}/api/rule_engine_rules/{{id}}

Scope

rule_engine_rule:read

Protocol type

REST

Request type

GET

Sync/Async

Sync

Public/Private

Public

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 ConfluenceN/A

Dictionaries

N/A

Input parameters

Description of input parameters

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

 

1f8444a0-e48b-440b-a082-c4703233efa2

2

 

 

 

 

 

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Expand
titleExample
Code Block
Headers
...
Headers 
...
Request data validation
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
 
...
 
...
 
...
 
...
 
...
Authorize
  • Verify the validity of the access token
    • in case of error - return 401 (“Invalid access token”)
  • Verify that token is not expired
    • in case of error - return 401 (“Invalid access token”)
  • Check user scopes in order to perform this action (scope = 'rule_engine_rule:read')
    • in case of invalid scope(s) - return 403 (“Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read”)
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 APIN/A
Response structure examples
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API response structure, example
 Expand
titleExample
 Code Block
{
  "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
1000 
Response code
HTTP Status code
Message
Internal name
Description
1
Базові
2
200
3
401
Invalid access token
4
 
401
Unauthorized
 
Помилка підтвердження
5
403
Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read
65
404Composition not found
COMPOSITION_NOT_FOUND_404
Не знайдено медичний висновок
7
404
Rule with id <rule_id> is not found
86
Специфічні
9
 
422
Only for active MPI record can be created medication request!
7
 
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Название
ID ТМ
Статус
/wiki/spaces/ESOZ/pages/17378181218
TM0112
/wiki/spaces/YK/pages/17837688354