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

Вимоги до набору даних персони

 Назва поля

Опис

Обов’язкове

Формат

Редагування пацієнтом

Валідації

 Назва поля

Опис

Обов’язкове

Формат

Редагування пацієнтом

Валідації

first_name

Ім'я пацієнта

так

string

Так

 

last_name

Прізвище пацієнта

так

string

Так

 

second_name

По батькові пацієнта

ні

string

Так

 

birth_date

Дата народження пацієнта

так

string

Так

 

birth_country

Країна народження пацієнта

так

string

Так

 

birth_settlement

Населений пункт народження пацієнта

так

string

Так

 

gender

Стать пацієнта

так

enum

Так

  • Значення зі словника GENDER

email

Адреса електронної пошти пацієнта

ні

string

Так

 

no_tax_id

Відсутність РНОКПП у пацієнта

ні

boolean

Може бути встановленим, не може бути зміненим

  • якщо вік персони до 14 років, параметр має бути відсутнім

tax_id

Значення РНОКПП

ні

string

Може бути встановленим, не може бути зміненим

  • має відповідати шаблону ^[0-9]{10}$

  • довжина від 10 до 255 символів

  • якщо no_tax_id = false, параметр обов'язковий

secret

Секретне слово

так

string

Так

 

documents

Документи пацієнта

так

array

 

 

type

Тип документу (паспорт, свідоцтво про народження та ін.) 

так

string

Так

  • Значення зі словника DOCUMENT_TYPE

  • Як мінімум один із документів для персон, старших за 14 років має мати один із перелічених типів:

    • NATIONAL_ID

    • PASSPORT

    • BIRTH_CERTIFICATE

    • BIRTH_CERTIFICATE_FOREIGN

    • COMPLEMENTARY_PROTECTION_CERTIFICATE

    • PERMANENT_RESIDENCE_PERMIT

    • REFUGEE_CERTIFICATE

    • TEMPORARY_CERTIFICATE

    • TEMPORARY_PASSPORT

  • Для персон, молодших за 14 років тип документу може бути тільки одним з перелічених:

    • BIRTH_CERTIFICATE

    • BIRTH_CERTIFICATE_FOREIGN

number

Номер документу, наприклад, серія та номер паспорта

так

string

Так

  • максимальна довжина менша за 25 символів

  • має відповідати шаблону залежно від типу:

    • PASSPORT - ^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$`

    • NATIONAL_ID - ^[0-9]{9}$

    • BIRTH_CERTIFICATE - ^(?![ЫЪЭЁыъэё@%&$^#`~:,.*|}{?!])[A-ZА-ЯҐЇІЄ0-9№\\/()-]+$

    • COMPLEMENTARY_PROTECTION_CERTIFICATE - ^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$

    • REFUGEE_CERTIFICATE - ^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$

    • TEMPORARY_CERTIFICATE - ^((?![ЫЪЭЁ])([А-ЯҐЇІЄ])){2}[0-9]{6}$

    • TEMPORARY_PASSPORT - ^(?![ЫЪЭЁыъэё@%&$^#`~:,.*|}{?!])[A-ZА-ЯҐЇІЄ0-9№\\/()-]+$

issued_by

Орган, який видав документ. Наприклад, Рокитнянським РВ ГУ МВС Київської області

так

string

Так

 

issued_at

Дата видачі документа

так

string

Так

  • має бути менше або дорівнювати поточній даті

  • має бути бульше або дорівнювати даті народження персони

expiration_date

Дата закінчення терміну дії документа. Необхідна для тих документів, які мають цю дату.

ні

string

Так

  • має бути більшим за поточну дату

  • обов'язково, якщо тип документу один з:

    • NATIONAL_ID

    • COMPLEMENTARY_PROTECTION_CERTIFICATE

    • PERMANENT_RESIDENCE_PERMIT

    • REFUGEE_CERTIFICATE

    • TEMPORARY_CERTIFICATE

    • TEMPORARY_PASSPORT

addresses

Адреса пацієнта

так

array

 

 

type

Тип адреси

так

string

Так

  • Значення зі словника ADDRESS_TYPE

country

Країна проживання пацієнта. Перелік країн, на даний момент, містить тільки значення UA 

так

enum

Так

  • Значення зі словника COUNTRY

area

Одна з областей України

так

string

Так

  • має відповідати шаблону: ^(?!.*[ЫЪЭЁыъэё@%&$^#])[a-zA-ZА-ЯҐЇІЄа-яґїіє0-9№\\\"!\\^\\*)\\]\\[(._-].*$

region

Район

ні

string

Так

  • має відповідати шаблону: ^(?!.*[ЫЪЭЁыъэё@%&$^#])[a-zA-ZА-ЯҐЇІЄа-яґїіє0-9№\\\"!\\^\\*)\\]\\[(._-].*$

settlement

Населений пункт

так

string

Так

  • має відповідати шаблону: ^(?!.*[ЫЪЭЁыъэё@%&$^#])[a-zA-ZА-ЯҐЇІЄа-яґїіє0-9№\\\"!\\^\\*)\\]\\[(._-].*$

settlement_type

Тип населеного пункту

так

string

Так

  • значення зі словника SETTLEMENT_TYPE

settlement_id

Ідентифікатор населеного пункту з uaadresses

так

string

Так

  • має выдповыдати шаблону: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

street_type

Тип вулиці

ні

string

Так

  • значення зі словника STREET_TYPE

street

Назва вулиці

ні

string

Так

  • має відповідати шаблону: ^(?!.*[ЫЪЭЁыъэё@%&$^#])[a-zA-ZА-ЯҐЇІЄа-яґїіє0-9№\\\"!\\^\\*)\\]\\[(._-].*$

building

Номер будинку

ні

string

Так

  • має відповідати шаблону: ^[1-9]((?![ЫЪЭЁыъэё])()([А-ЯҐЇІЄа-яґїіє \\/\\'\\-0-9])){0,20}$

apartment

Номер квартири

ні

string

Так

 

zip

Поштовий індекс

ні

string

Так

  • має відповідати шаблону ^[0-9]{5}$

phones

Номери телефонів пацієнта

так

array

 

  • Повинен бути присутнім принаймні один запис

  • Кожен тип може бути представлений лише один раз

type

Тип телефону: стаціонарний або мобільний

так

string

Так

  • значення зі словника PHONE_TYPE

number

Номер телефона

так

string

Так

  • має відповідати шаблону ^\\+38[0-9]{10}$

unzr

Унікальний номер запису в Єдиному демографічному реєстрі

ні

string

Може бути встановленим, не може бути зміненим

  • має відповідати шаблону ^[0-9]{8}-[0-9]{5}$

  • перші 8 символів мають дорівнювати даті народження персони

  • якщо тип документу дорівнює NATIONAL_ID, параметр обов'язковий

emergency_contact

Контакт для екстреного зв'язку

так

object

 

 

first_name

Ім'я 

так

string

Так

 

last_name

Прізвище

так

string

Так

 

second_name

По батькові 

ні

string

Так

 

phones

Номери телефонів для екстреного зв'язку

так

array

 

  • Повинен бути присутнім принаймні один тип

  • Кожен тип може бути представлений лише один раз.

type

Тип телефону: стаціонарний або мобільний

так

string

Так

  • значення зі словника PHONE_TYPE

number

Номер телефону

так

string

Так

  • має відповідати шаблону ^\\+38[0-9]{10}$

preferred_way_communication

Бажаний спосіб спілкування

ні

enum

Так

  • Може приймати значення: email, phone

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