RC_REHAB_ Get dictionaries v2+

1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Filters
6 Authorize
7 Headers
8 Validation data request
9 Processing
10 Response structure
11 Post-processing processes
12 HTTP status codes
13 Backward compatibility

Purpose

This method is designed to retrieve a catalog of dictionaries that can be used in eHealth. This WS can represent hierarchical dictionaries with subordinate (child) values. Each value can be managed by ‘is_active’ flag.

Specification

Link	eHealth API · Apiary	Посилання на Apiary або Swagger
Resource	/api/v2/dictionaries	Посилання на ресурс, наприклад: /api/persons/create
Scope	dictionary:read	Scope для доступу
Components	Dictionaries	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	API paragraph not found	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	GET	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Public	Потрібно зазначити тип методу за ступенем доступності

Logic

Filter dictionaries by search params.
Render found dictionaries with all fields from PRM DB.

Input parameters

name - dictionary name
is_active - dictionary status
value_code - code of the dictionary value
value_description - description of the dictionary value
value_is_active - status of the dictionary value

Filters

No

Authorize

API paragraph not found

Headers

API paragraph not found

Validation data request

API paragraph not found

Processing

API paragraph not found

Response structure

Each dictionary is an object that contains code, description and status of the value. It can be represented by a hierarchical structure with subordinate (child) values. Each dictionary has a definite dictionary’s labels and flag ‘is_active’ that define a dictionary status

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "name": "eHealth/ICF/classifiers",
      "description": "Класифікатори МКФ",
      "values": [
        {
          "code": "b1142",
          "description": "Орієнтація в особі",
          "is_active": true,
          "child_values": [
            {
              "code": "b11429",
              "description": "Орієнтація в особі неуточнена",
              "is_active": true,
              "child_values": []
            }
          ]
        }
      ],
      "labels": [
        "SYSTEM",
        "EXTERNAL"
      ],
      "is_active": true
    },
    {
      "name": "eHealth/ICPC2/condition_codes",
      "description": "Коди станів за ICPC2",
      "values": [
        {
          "code": "D88",
          "description": "Апендицит",
          "is_active": true,
          "child_values": []
        }
      ],
      "labels": [
        "SYSTEM",
        "EXTERNAL"
      ],
      "is_active": true
    }
  ]
}

Post-processing processes

API paragraph not found

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200	Response

Backward compatibility

API paragraph not found