ЕСОЗ - публічна документація

[DRAFT] Get Rule engine rule details [API-005-005-001-0086]

Owned by Kateryna Yakovleva
Last updated: Nov 25, 2024 by Anastasiia Prokhorova (SoE eHealth)
1 min read

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

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

Properties of a REST API method document

Document type

Метод REST API

Document title

[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://medicaleventsmisapi.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

N/A

Dictionaries

N/A

Input parameters

Input parameter

Mandatory

Type

Description

Example

Input parameter

Mandatory

Type

Description

Example

1

id

 

String

 

1f8444a0-e48b-440b-a082-c4703233efa2

2

 

 

 

 

 

Request structure

See on API-specification

Headers

Headers

Request data validation

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

N/A

Response structure examples

See on API-specification

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

Response code

HTTP Status code

Message

Internal name

Description

Response code

HTTP Status code

Message

Internal name

Description

1

Базові

2

 

200

 

 

 

3

 

401

Invalid access token

 

 

4

 

403

Your scope does not allow to access this resource. Missing allowances: rule_engine_rule:read

 

 

5

 

404

Rule with id <rule_id> is not found

 

 

6

Специфічні

7

 

 

 

 

 

Post-processing processes

N/A

Technical modules where the method is used

Название

ID ТМ

Статус

Название

ID ТМ

Статус

RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом

TM0112

 

RC-V.2.1 [TM-011] Відхилення ЕР фармацевтом

 

 

 

ЕСОЗ - публічна документація