Properties of a REST API method document

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.

Logic

1. Filter dictionaries by search params.

2. Render found dictionaries with all fields from PRM DB.

Configuration parameters

N/A

Dictionaries

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

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

Request structure

See on API-specification

Headers

Headers

Request data validation

N/A

Processing

N/A

Response structure examples

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 API-specification

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

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used