Purpose

This method is designed to retrieve eHealth dictionaries

Specification

...

...

Using Microservices

...

Logic

API paragraph not found

Preconditions

API paragraph not found

Global and configuration parameters

API paragraph not found

Input parameters

None

Filters

None

Request structure

See on Apiary

Example

curl --include \
'http://ehealth.com/api/dictionaries'

Logic

1. Filter dictionaries by search params.

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

Input parameters

• name - dictionary name

• is_active - dictionary status

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 {key}:{value} pairs where:

• {key} is a dictionary record

• {value} is a dictionary record description

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": "DOCUMENT_TYPE",
      "values": {
        "key": "value"
      },
      "labels": [
        "SYSTEM",
        "EXTERNAL"
      ],
      "is_active": true
    }
  ]
}

Post-processing processes

API paragraph not found

HTTP status codes

Backward compatibility

API paragraph not found

Segmentation of dictionaries

Due to the increase in the size of the reference dictionaries for the Get dictionaries endpoint, it was decided to segment the dictionary for values that exceed the normal ones (the maximum size of the dictionary could be 24 MB, which creates problems when working with reference dictionaries). Currently, the functionality of the endpoint has been changed, which means that when accessing it without passing filtering parameters, a reference dictionary with such a list of values is returned (https://uaehealthapi.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/dictionaries/get-dictionaries ). In order to get values that belong to a large reference dictionary, including:

• eHealth/ICD10_AM/condition_codes

• eHealth/ICD10_AM_FULL/condition_codes

• eHealth/ICD10/condition_codes

You must pass the name of the dictionary in the name parameter, e.g: https://api.ehealth.gov.ua/api/dictionaries?name=eHealth/ICD10_AM_FULL/condition_codes
In the future, it is expected that this approach will be maintained when building new types of directories.