ЕСОЗ - публічна документація
MC - Параметри сервісу getComposition 0.4
Загальні відомості про сервіс 0.4 - зміни порівняно з 0.3
Надано розширені значення кодів помилок у випадку відмові в авторизації доступу до документу
Загальні відомості про сервіс 0.3 - зміни порівняно з 0.2
(getCompositionRequest) Повернувся обʼєкт motherInfo - під ним агреговано опційні UNZR і DRFO
(getCompositionResponse) Додано обʼєкт Request, який повністю дублює дані вхідного запиту
(getCompositionResponse) Дані про адресу надання послуг обʼєднано в обʼєкт ChildAdressBirth
(getCompositionResponse) Додано placeOfBirthID - код КОАТУУ місця надання послуг
identityDocument опустився на один рівень вкладення і має бути частиною motherInfo
identityDocument став 0..1, а його атрибути documentNumber і passportTypeID - 1
Загальні відомості про сервіс 0.2 - зміни порівняно з 0.1
(getCompositionRequest) Прибрано IdentityDocument.no_tax_id - не використовується
(getCompositionRequest) Прибрано motherInfo.schema_birthDate - не використовується
(getCompositionResponse) Додано DocOfBirth.ChildDocOrgName - відповідає legalEntity.name
(getCompositionResponse) Додано набір параметрів стосовно місця надання сервісу ChildBirthState ChildBirthRegion ChildBirthDistrict ChildBirthLocalityType ChildBirthLocality
(getCompositionRequest) додано параметр UNZR
Загальні відомості про сервіс
Сервіс створюється на стороні системи єЗдоровʼя ЗСЗУ МОЗ України з метою одержання інформації про наявність медичного висновку про народження, виданого певній особі зазначеній у цьому висновку.
На стороні сервісів ДРАЦС і Дія створюється клієнт, за допомогую якого передається номер медвисновку і набір атрибутів, які характеризують за якими атрибутами і документами ідентифіковано особу, для якої виконується запит медвисновку.
Вхідні параметри сервісу
Вміст елементу getCompositionRequest
№ | Код параметру в системі єЗдоровʼя | Рівень вкладеності | Код параметру згідно WSDL | Спосіб, тип заповнення даних | Опис параметру | Обовʼязкове(так/ні) |
---|---|---|---|---|---|---|
1 |
| 1 | DocOfBirth | object |
| 1 |
2 | Composition.Title | 2 | ChildDocNumb | string | Ідентифікатор медичного висновку, що використовуються для ручних операцій визначення | 1 |
3 |
|
| motherInfo | object | Відомості про матір | 1 |
4 | tax_id | 2 | tax_RNOKPP | string | РНОКПП (за наявності) | 0..1 |
5 | unzr | 2 | UNZR | string | УНЗР | 0..1 |
6. | Composition.focus.person.document | 2 | IdentityDocument | object |
| 0..1 |
7 | document.serial | 3 | documentSerial | string | серія документа (за наявності) | 0..1 |
8 | document.number | 3 | documentNumber | string | номер документа | 1 |
9 | document.type | 3 | passportTypeID | integer | Довідник ДРАЦС. | 1 |
Вихідні параметри сервісу
Вміст елементу getCompositionResponse
№ | Код параметру в системі єЗдоровʼя | Рівень вкладеності | Код параметру згідно WSDL | Спосіб, тип заповнення даних | Опис параметру | Обовʼязкове(так/ні) |
---|---|---|---|---|---|---|
1 |
| 1 | GetCompositionRequest | object | Копія обʼєкту запиту, який надійшов | 1 |
2 |
| 2 | DocOfBirth | object |
| 1 |
3 |
| 3 | ChildDocNumb | string | Ідентифікатор медичного висновку, що використовуються для ручних операцій визначення | 1 |
4 |
| 2 | motherInfo | object | Відомості про матір | 1 |
5 |
| 3 | tax_RNOKPP | string | РНОКПП (за наявності) | 0..1 |
6 |
| 3 | UNZR | string | УНЗР | 0..1 |
7 |
| 3 | IdentityDocument | object |
| 0..1 |
8 |
| 4 | documentSerial | string | серія документа (за наявності) | 0..1 |
9 |
| 4 | documentNumber | string | номер документа | 1 |
10 |
| 4 | passportTypeID | integer | Довідник ДРАЦС. | 1 |
|
|
|
|
|
|
|
11 | Composition | 1 | DocOfBirth | object | Ідентифікатор в системі медичний висновків | 1 |
12 | відповідає Type | 2 | ChildDocName | string | завжди константа “Медичне свідоцтво про народження дитини” | 1 |
13 | Title | 2 | ChildDocNumb | string | Номер документу | 1 |
14 | Date | 2 | ChildDocDate | date (рррр-мм-дд) | Дата видачі документу медичного висновку | 1 |
15 | legalEntity.name | 2 | ChildDocOrgName | string | Назва органу, що видав документ | 1 |
16 | Composition.subject | 1 | childInfo | object | M/F - медично визначена стать дитини при народженні | 1 |
17 | Person.gender | 2 | schema_gender | string | хлопчик має значення: дівчинка має значення: | 1 |
18 |
| 2 | ChildAddressBirth | object | Адреса місця надання медичних послуг |
|
19 |
| 3 | placeOfBirthID | string | код адміністративно-територіальної одиниці – код населеного пункту | 0..1 |
20 |
| 3 | ChildBirthState | string | Назва країни | 0..1 |
21 | division.addresses.area | 3 | ChildBirthRegion | string | Назва області | 0..1 |
22 | division.addresses.region | 3 | ChildBirthDistrict | string | Назва району | 0..1 |
23 | division.addresses.settlement_type | 3 | ChildBirthLocalityType | string | Тип населеного пункту | 0..1 |
24 | division.addresses.settlement | 3 | ChildBirthLocality | string | Назва населеного пункту (у тому числі м. Київ та м. Севастополь) | 0..1 |
25 | Person.birth_date | 2 | schema_birthDate | date (рррр-мм-дд) | Дата народження | 1 |
26 |
| 1 | ehealth:faultCode | int | Код статусу опрацювання системою єЗдоровʼя | 1 |
27 |
| 1 | ehealth:Composition | bytes | Файловий p7s обʼєкт закодований base64, який відповідає документу медичного висновка, підписаний КЕП лікаря | 1 |
Коди помилок обробки запиту
№ | Код помилки | Опис помилки |
---|---|---|
1 | 404 | Медичний висновок не знайдено за параметрами наданими у запиті |
2 | 403 | У доступі до медичного висновку відмовлено за наданими параметрами матері |
3 | 400 | Помилка обробки вхідного запиту у випадку відсутності достатньої кількості обовʼязкових параметрів |
4 | 500 | Внутрішня помилка опрацювання на стороні сервісу медичних висновків |
5 | 200 | Висновок успішно знайдено і надано відповідний результат |
6 | 10910 | Недостатньо даних авторизації для надання доступу |
7 | 10911 | РНОКПП надано для авторизації доступу, але відсутнє в реєстрі пацієнтів |
8 | 10912 | РНОКПП надано для авторизації доступу, але не відповідає значенню в реєстрі пацієнтів |
9 | 10913 | УНЗР надано для авторизації доступу, але відсутнє в реєстрі пацієнтів |
10 | 10914 | УНЗР надано для авторизації доступу, але не відповідає значенню в реєстрі пацієнтів |
11 | 10915 | Документ наданий для авторизації доступу не дозволено для авторизації |
12 | 10916 | Документ наданий для авторизації, але документ такого типу відсутній в реєстрі пацієнтів |
13 | 10917 | Документ наданий для авторизації, але його номер не відповідає даним в реєстрі пацієнтів |
Опис структури обʼєкту Composition
Файл надається в полі eheatlh:Composition, закодований base64, контент представляє собою файловий конейнер p7s- файловий обʼєкт підписаний КЕП за методом внутрішнього підпису (дані і підпис в одному файлі).
Підписаний обʼєкт представляє собою json файл з наборов полів визначеним МОЗ/НСЗУ.
Опис полів надається в таблиці нижче.
№ | Код параметру в системі єЗдоровʼя | Рівень вкладенності | Тип | Опис |
---|---|---|---|---|
1 | author | 1 | object | Обʼєкт, який визначає автора документу |
2 | type | 2 | object | Опорний обʼєкт для визначення кодифікації |
3 | coding | 3 | array | Масив можливих значень кодифікації |
4 | code | 4 | string | Код обʼєкту, напр |
5 | system | 4 | string | Система кодифікацї, напр. |
6 | text | 3 | string | Текст пояснення до обʼєкту author (заповнюється опціонально) |
7 | value | 2 | uuid | Ідентифікатор автора документу в реєстрі співробітників |
8 | category | 1 | object | Обʼєкт, який визначає категорію медичного висновку |
9 | coding | 2 | object | Масив можливих значень кодифікації обʼєкту |
10 | code | 3 | string | Категорія, напр. |
11 | system | 3 | string | Система кодфікації , напр |
12 | date | 1 | date/iso | Дата реєстрації документу в системі єЗдоровʼя |
13 | encounter | 1 | object | Обʼєкт, який визначає медичну подію на основі якої створено даний медичний висновок |
14 | type | 2 | object | Опорний обʼєкт для визначення кодифікації |
15 | coding | 3 | array | Масив можливих значень кодифікації |
16 | code | 4 | string | Код обʼєкту, напр. |
17 | system | 4 | string | Система кодифікацїі, напр. |
18 | text | 3 | string | Текст пояснення до обʼєкту encounter (заповнюється опціонально) |
19 | value | 2 | uuid | Ідентифікатор медичної події в реєстрі медичних записів |
20 | event | 1 | array | Масив подій, що описують деталі документа |
21 | code | 2 | object | Опорний обʼєкт для визначення коду події |
22 | coding | 3 | array | Массив значень кодів події |
23 | code | 4 | string | Код обʼєкту події, напр. |
24 | system | 4 | string | Система кодифікації |
25 | period | 2 | object | Період зазначеної події |
26 | start | 3 | date/iso | Дата початку дії документу з вказанням часової зони згідно формату ISO |
27 | extension | 1 | array | Масив розширень. Завжди порожній у випадку медичних висновків про народження |
28 | identifier | 1 | object | Обʼєкт ідентифікатора медичного висновку |
29 | type | 2 | object | Опорний обʼєкт для визначення кодифікації |
30 | coding | 3 | array | Масив можливих значень кодифікації обʼєкту |
31 | code | 4 | string | Код обʼєкту, напр. |
32 | system | 4 | string | Система кодифікації, напр. |
33 | value | 2 | uuid | Ідентифікатор медичного висновку в реєстрі медичних висновків |
34 | section | 1 | object | Обʼєкт, який визначає набір даних повʼязаних з видачею медичного висновку субʼєкту |
35 | focus | 2 | object | Обʼєкт, який визначає субʼєкта, якому видано медичний висновок ( в більшості випадків - Мама новонародженого) |
36 | type | 3 | object | Обʼєкт, який визначає тип субʼєкта |
37 | coding | 4 | array | Масив можливих значень кодифікації обʼєкту |
38 | code | 5 | string | Код обʼєкту, напр. |
39 | system | 5 | string | Система кодифікації, напр. |
40 | text | 4 | string | Текст пояснення до обʼєкту focus (заповнюється опціонально) |
41 | value | 3 | uuid | Код субʼєкту, якому видано медичний висновок в Реєстрі пацієнтів |
42 | text | 2 | object | Обʼєкт медичного висновку для відображення |
43 | div | 3 | string | HTML текст медичного виновку |
44 | template | 3 | object | Обʼєкт, який визначає шаблон, згідно якого сгенеровано висновок |
45 | name | 4 | string | Ідендифкатор шаблону в системі єЗдоровʼя |
46 | status | 1 | string | Статус документу. Завжди має значення |
47 | subject | 1 | object | Обʼєкт, який визначає пацієнта в даному медичному висновку |
48 | type | 2 | object | Обʼєкт, який визначає тип пацієнта в системі єЗдоровя |
47 | coding | 3 | array | Масив можливих значень кодифікації обʼєкту |
48 | code | 4 | string | Код обʼєкту, напр. |
49 | system | 4 | string | Система кодифікації, напр. |
50 | text | 3 | string | Текст пояснення до обʼєкту subject (заповнюється опціонально) |
51 | value | 2 | uuid | Ідентифікатор пацієнта в реєстрі пацієнтів єЗдоровʼя |
52 | title | 1 | string | Ідентифікатор медичного висновку в реєстрі медичних висновків |
53 | type | 1 | object | Об'єкт, який визначає тип медичного висновку |
54 | coding | 2 | array | Масив можливих значень кодифікації обʼєкту |
55 | code | 3 | string | Код обʼєкту. Завжди має значення |
56 | system | 3 | string | Система кодифікації, напр |
ЕСОЗ - публічна документація