1f7e1Довідники (настанова) (видаліть блок з посиланням перед публікацією документа)
Властивості документа довідника (простого)
Загальна інформація
Довідник використовується для визначення типу адреси фізичної або юридичної особи.
Методологія кодування
Відсутня ієрархія. Використовується буквене кодування (унікальна комбінація символів англійського алфавіту, дозволяється використання символу “нижнє підкреслення”)
Опис структури довідника
Назва довідника міститься в таблиці dictionaries БД prm https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/724402230/PRM#dictionaries
Дані довідника містяться в таблиці dictionary_values БД prm https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/724402230/PRM#dictionary_values
Назва поля | Опис поля | Тип даних | Обов'язковість* | Вимоги до валідації | Коментар |
|---|---|---|---|---|---|
id | Ідентифікатор в системі | uuid | M | При вставці запису скриптом вказати значення: uuid_generate_v4() | |
dictionary_id | Ідентифікатор словника | uuid | M | Унікальний індекс dictionary_id + code | |
code | Ключ значення | varchar(255) | M |
| |
value | Опис значення | text | M |
|
|
is_active | Активний | boolean | M | ||
parent_id | Ідентифікатор батьківського запису значення (dictionary_values.id) в системі | uuid | O | ||
inserted_by | Користувач, який створив запис | uuid | O | При вставці/оновленні запису скриптом вказати значення: '4261eacf-8008-4e62-899f-de1e2f7065f0' | |
inserted_at | Час створення | timestamp | O | При вставці запису скриптом вказати значення: now() | |
updated_by | Останній користувач, який оновив запис | uuid | O | При вставці/оновленні запису скриптом вказати значення: '4261eacf-8008-4e62-899f-de1e2f7065f0' | |
updated_at | Останнє оновлення | timestamp | O | При оновленні запису скриптом вказати значення: now() |
M - mandatory (обов'язковий); O - optional (не обов'язковий)
Значення довідника
КЛЮЧ | Значення | Опис | DEMO | PREPROD | STAGE | PROD | REVIEW | Коментар | |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BIRTH_CERTIFICATE | Свідоцтво про народження (для осіб, які не досягли 14-річного віку) | + | + | + | + | + | ||
| 2 | BIRTH_CERTIFICATE_FOREIGN | Свідоцтво про народження іноземного зразку | + | + | + | + | + | ||
| 3 | COMPLEMENTARY_PROTECTION_CERTIFICATE | Посвідчення особи, яка потребує додаткового захисту | + | + | + | + | + | ||
| 4 | NATIONAL_ID | Біометричний паспорт громадянина України | |||||||
| 5 | PASSPORT | Паспорт громадянина України | |||||||
| 6 | PERMANENT_RESIDENCE_PERMIT | Посвідка на постійне проживання в Україні | |||||||
| 7 | REFUGEE_CERTIFICATE | Посвідка біженця | |||||||
| 8 | TEMPORARY_CERTIFICATE | Посвідка на тимчасове проживання | |||||||
| 9 | TEMPORARY_PASSPORT | Тимчасове посвідчення громадянина України |
Файл | DEMO | PREPROD | STAGE | PROD | REVIEW | |
|---|---|---|---|---|---|---|
| 1 | ||||||
| 2 |
Довідник доступний за наступним методом:
PreProd: https://api-preprod.ehealth.gov.ua/api/v2/dictionaries?name=ADDRESS_TYPE (вхід з вказанням значення ключа для header)
Prod: https://api.ehealth.gov.ua/api/v2/dictionaries?name=ADDRESS_TYPE