ЕСОЗ - публічна документація
RC_(CSI-3014) MC - Параметри сервісу postCompositionRequest
Діюча сторінка MC - Параметри сервісу postCompositionRequest
Внесена зміна в документації виділена зеленим кольором
Загальні відомості про сервіс
Сервіс “Отримання інформації про видачу свідоцтва про народження” створюється на стороні системи єЗдоровʼя ЗСЗУ МОЗ України з метою одержання інформації про видачу свідоцтва про народження для дитини, і внесення даних дитини в реєстр пацієнтів.
На стороні сервісів ДРАЦС створюється клієнт, за допомогую якого передається номер медвисновку і набір атрибутів, які визначають набір персональних даних для внесення особи в реєстра пацієнтів
Вхідні параметри сервісу
Вміст елементу postCompositionRequest
№ | Рівень вкладеності | Код поля | Опис поля | Формат | Спосіб заповнення / Тип даних | Обов’язко-вість заповнення полів ДРАЦС- ДФС (при виборі послуги Type Service8) |
| Загальні відомості про заяву | |||||
1 | 1 | requestID | Унікальний ідентифікатор заявки з порталу з додатковою ідентифікацією обміну між ДРАЦС та ЦОВВом | Номер заявки з додаванням коду обміну. Наприклад: 20191022-0001/1 | string | 1 |
2 | 1 | applicationDate | Вхідна дата заяви | рррр-мм-дд | date (рррр-мм-дд) | 0 |
3 | 1 | TypeService1 | Реєстрація народження дитини та визначення походження |
| string | 0 |
4 | 1 | TypeService2 | Реєстрація в ЄДДР |
| string | 0 |
5 | 1 | TypeService3 | Реєстрація в ДРФО |
| string | 0 |
6 | 1 | TypeService4 | Реєстрація місця проживання |
| string | 0 |
7 | 1 | TypeService5 | Призначення допомоги при народженні дитини |
| string | 0 |
8 | 1 | TypeService6 | Допомога на дітей (багатодітні) |
| string | 0 |
9 | 1 | TypeService7 | Видача посвідчень (багатодітні) |
| string | 0 |
10 | 1 | TypeService8 | Внесення відомостей про дитину до Реєстру пацієнтів |
| string | 1 |
11 | 1 | applicationReceivingOrgInfo | Відомості про орган ДРАЦС, до якого подається заява |
| object | 0 |
12 | 2 | RegionOrg | Регіон органу ДРАЦС | Орган, до якого подається заява | string | 0 |
13 | 2 | ComposeOrg | Територіальний орган ДРАЦС | Має бути вказано назву територіального органу, до якого подається заява | string | 0 |
14 | 1 | officialServantInfo | Відомості про особу, що прийняла заяву |
| object | 0 |
15 | 2 | authorityName | Відомство, співробітник якого прийняв заявку | Наразі можливі варіанти:
| string | 0 |
16 | 2 | officeBranchID | Територіальний орган | Має бути вказано назву територіального органу або інший чіткий його ідентифікатор (наприклад LegalEntity ID для ЗОЗ) | string | 0 |
17 | 2 | foaf_familyName | Прізвище |
| string | 0 |
18 | 2 | foaf_givenName | Ім’я |
| string | 0 |
19 | 2 | person_patronymicName | По батькові (за наявності) |
| string | 0 |
20 | 2 | certificate | Сертифікат | Вимога – ПІБ заповнювати за даними сертифіката та не надавати на ручне редагування | string | 0 |
21 | 1 | dracs:actRecordOfBirth | Актовий запис про народження |
| object | 0 |
22 | 2 | dracs:actRecordNumber | Номер |
| xs:string | 0 |
23 | 2 | cbc:IssueDate | Дата складання актового запису |
| xs:date | 0 |
24 | 2 | dracs:officeBranch | Назва територіального органу ДРАЦС |
| dracs:Official | 0 |
25 | 2 | dracs:officialServantInfo | Відомості про посадову особу органу ДРАЦС, яка склала актовий запис |
| xs:string | 0 |
26 | 3 | foaf:familyName | Прізвище |
| xs:string | 0 |
27 | 3 | foaf:givenName | Ім’я |
| xs:string | 0 |
28 | 3 | person:patronymic | По батькові | (за наявності) | xs:string | 0 |
29 | 1 | CBI | Свідоцтво про народження |
| object | 1 |
30 | 2 | CBIssuer | Орган державної реєстрації актів цивільного стану, що видав свідоцтво | Найменування органу державної реєстрації актів цивільного стану. В ДМС та в ДФС надається при другому зверненні (після отримання кодів) | string | 1 |
31 | 2 | CBIssueDate | Дата видачі свідоцтва |
| date (рррр-мм-дд) | 1 |
32 | 2 | documentSerial | Серія |
| string | 1 |
33 | 2 | documentNumber | Номер |
| string | 1 |
34 | 1 | RNOKPP | Реєстраційний номер облікової картки платника податків дитини | У разі відсутності РНОКПП, формувати ознаку «Відмова від РНОКПП» | string | 0..1 |
35 | 1 | UNZR | Унікальний номер запису в Єдиному державному демографічному реєстрі (за наявності) |
| string | 0..1 |
36 | 1 | notificationChannels | Спосіб інформування про результати надання |
| dracs:ParentPersonType | 0 |
37 | 2 | notificationPhone | Абонентський номер мобільного телефону |
| xs:string | 0 |
38 | 2 | notificationEmail | Адреса електронної пошти |
| xs:string | 0 |
39 | 1 | dracs_ChildBornCertReceive | Відомості про спосіб отримання свідоцтва про народження | Варіанти значень: «Compose_org» - у відділі ДРАЦС; «Legal_org» - у ЗОЗ; «ASC_org» - у ЦНАП; «National_mail» - відділення національного оператора поштового зв’язку за зареєстрованим місцем проживання матері чи батька | xs:string | 0 |
40 | 2 | dracsCBSPostChannelInfo | Реквізити для поштового переказу | Поле присутнє у разі, якщо dracs_ChildBornCertReceive має значення «National_mail» | object | 0 |
41 | 3 | dracsPostbox | Поштовий індекс поштового відділення |
| string | 0 |
42 | 3 | dracsPostalServiceBranchName | Повне найменування поштового відділення
|
| string | 0 |
|
| Відомості про дитину | ||||
43 | 1 | childInfo | Відомості про дитину |
| object | 1 |
44 | 2 | familyName | Прізвище |
| string | 1 |
45 | 2 | givenName | Ім’я |
| string | 1 |
46 | 2 | patronymicName | По батькові (за наявності) |
| string | 0..1 |
47 | 2 | birthDate | Дата народження | рррр-мм-дд | date (рррр-мм-дд) | 1 |
48 | 2 | placeOfBirthID | Місце народження (код адміністративно-територіальної одиниці) | Код згідно з КОАТУУ | string | 1 |
49 | 3 | ChildBirthState | Назва країни | Заповнюється відповідно до довідника АТУ | string | 1 |
50 | 3 | ChildBirthRegion | Назва області |
| string | 1 |
51 | 3 | ChildBirthDistrict | Назва району |
| string | 0..1 |
52 | 3 | ChildBirthLocalityType | Тип населеного пункту |
| string | 1 |
53 | 3 | ChildBirthLocality | Назва населеного пункту (у тому числі м. Київ та м. Севастополь) |
| string | 1 |
54 | 2 | gender | Стать | Інформація з форми 103/о хлопчик має значення: «http://purl.org/linked-data/sdmx/2009/code#sex-M»; дівчинка має значення: | string | 1 |
55 | 1 | childCitizenship | Громадянство дитини; Визначати автоматично за статтю дитини + послугу TypeService2 надавати лише, коли обидва батьки мають громадянство України (83 та 84) «83» - Громадянин України «84» - Громадянка України |
| string
| 1 |
56 | 2 | citizenCountry | Код країни громадянства (для негромадян України) | У відповідності до довідника країн ДРАЦС | string | 0..1 |
57 | 1 | childResidenceAddressRef | Місце проживання дитини | Посилання на місце проживання матері має значення «mother», Посилання на місце проживання батька має значення «father» | string | 0 |
58 | 1 | childBorn | Інформація із форми 103/о |
| object | 0 |
59 | 2 | childrenWereBorn | Народилося дітей |
| integer | 0 |
60 | 2 | childBornOrder | Яка за рахунком дитина народилася у матері, включаючи новонароджену |
| integer | 0 |
61 | 2 | childBornAlive | Живонароджена чи мертвонароджена |
| boolean | 0 |
62 | 1 | DocOfBirth | Документ, що підтверджує факт народження дитини |
| object | 1 |
63 | 2 | ChildDocName | Назва документу |
| string | 1 |
64 | 2 | ChildDocNumb | Номер документу |
| string | 1 |
65 | 2 | ChildDocDate | Дата видачі | рррр-мм-дд | date (рррр-мм-дд) | 1 |
66 | 2 | ChildDocOrgName | Назва органу, що видав документ |
| string | 1 |
|
| Відомості про матір | ||||
67 | 1 | motherInfo | Відомості про матір |
| object | 1 |
68 | 2 | familyName | Прізвище |
| string | 1 |
69 | 2 | givenName | Ім’я |
| string | 1 |
70 | 2 | patronymicName | По батькові (за наявності) |
| string | 0..1 |
71 | 2 | gender | Стать | Фіксоване значення «http://purl.org/linked-data/sdmx/2009/code#sex-F» | string | 1 |
72 | 2 | birthDate | Дата народження | рррр-мм-дд | date (рррр-мм-дд) | 1 |
73 | 2 | citizenship | Громадянство | Довідник ДРАЦС. Можливі значення: «83» - Громадянин України «84» - Громадянка України | string | 1 |
74 | 2 | citizenCountry | Код країни громадянства (для негромадян України) | У відповідності до довідника країн ДРАЦС | string | 0..1 |
75 | 2 | RegistrationAddress | Зареєстроване місце проживання |
| AddressType | 0 |
76 | 3 | cbc_Country | Країна |
| string | 0 |
77 | 3 | CountryID | Ідентифікатор країни у класифікаторі ДРАЦС |
| integer | 0 |
78 | 3 | cbc_Postbox | Індекс | П’ятизначний поштовий індекс | string | 0 |
79 | 3 | cbc_Region | Область | Назва області (не заповнюється для м. Київ та м. Севастополь) | string | 0 |
80 | 3 | RegionID | Ідентифікатор області у класифікаторі ДРАЦС |
| string | 0 |
81 | 3 | cbc_District | Район області | Назва району області (не зазначається для міст обласного значення) | string | 0 |
82 | 3 | DistrictID | Ідентифікатор району області у класифікаторі ДРАЦС |
| integer | 0 |
83 | 3 | cbc_CityName | Назва населеного пункту (у тому числі м. Київ та м. Севастополь) |
| string | 0 |
84 | 3 | CityID | Ідентифікатор населеного пункту у класифікаторі ДРАЦС |
| integer | 0 |
85 | 3 | CityKOATUU | Код за КОАУУ населеного пункту | Код згідно з КОАТУУ | string | 0 |
86 | 3 | CityType | Тип населеного пункту | Тип (скорочено: м. – місто, смт – селище міського типу, с. – село) | string | 0 |
87 | 3 | CityTypeID | Ідентифікатор типу населеного пункту у класифікаторі ДРАЦС |
| integer | 0 |
88 | 3 | cbc_StreetName | Назва вулиці | Стандартні обмеження ФЛК для адрес | string | 0 |
89 | 3 | StreetID | Ідентифікатор вулиці у класифікаторі ДРАЦС |
| integer | 0 |
90 | 3 | StreetTypeName | Тип вулиці | Тип (вулиця, бульвар, проспект, провулок, площа, проїзд, узвіз тощо) | string | 0 |
91 | 3 | StreetTypeID | Ідентифікатор типу вулиці у класифікаторі ДРАЦС |
| integer | 0 |
92 | 3 | cbc_BuildingNumber | Будинок | Номер будинку (стандартні обмеження ФЛК для адрес) | string | 0 |
93 | 3 | BuildingPart | Корпус | Номер корпусу (за наявності) | string | 0 |
94 | 3 | Apartment | Квартира/кімната | Номер квартири (за наявності) | string | 0 |
95 | 2 | identityDocument | реквізити паспорта або паспортного документа, що посвідчує особу |
| PassportDocumentType | 1 |
96 | 3 | passportTypeID | Тип документу | Довідник ДРАЦС. Можливі значення: 1 - Паспорт громадянина України; 2 - Дипломатичний паспорт України; 4 - Посвідчення особи моряка; 5 - Посвідчення особи на повернення в Україну; 6 - Посвідчення члена екіпажу; 7 - Тимчасове посвідчення громадянина України; 8 - Інший документ; 9 - Службовий паспорт України; 10 - Свідоцтво про народження. | integer | 1 |
97 | 3 | documentSerial | Серія документа (за наявності) |
| string | 0..1 |
98 | 3 | documentNumber | Номер документа |
| string | 1 |
99 | 3 | IssueDate | Дата видачі документа |
| date (рррр-мм-дд) | 1 |
100 | 3 | IssuerID | Уповноважений суб’єкт, що видав документ |
| string | 1 |
101 | 3 | ExpiryDate | Строк дії документа (за наявності) |
| date (рррр-мм-дд) | 0..1 |
102 | 2 | UNZR | Унікальний номер запису в Єдиному державному демографічному реєстрі (за наявності) |
| string | 0..1 |
103 | 2 | RNOKPP | Реєстраційний номер облікової картки платника податків | У разі відсутності РНОКПП, формувати ознаку «Відмова від РНОКПП» | string | 0..1 |
104 | 2 | RNOKPPRefusal | Ознака відмови від РНОКПП | У разі відмови суб’єкта від РНОКПП повинно мати фіксоване значення «Відмова від РНОКПП» | string | 0..1 |
|
| Відомості про батька | ||||
105 | 1 | fatherInfo | Відомості про батька |
| object | 0 |
106 | 2 | foaf_familyName | Прізвище |
| string | 0 |
107 | 2 | foaf_givenName | Ім’я |
| string | 0 |
108 | 2 | person_patronymicName | По батькові (за наявності) |
| string | 0 |
109 | 2 | schema_gender | Стать | Фіксоване значення «http://purl.org/linked-data/sdmx/2009/code#sex-F» | string | 0 |
110 | 2 | schema_birthDate | Дата народження | рррр-мм-дд | date (рррр-мм-дд) | 0 |
111 | 2 | citizenship | Громадянство | Довідник ДРАЦС. Можливі значення: «83» - Громадянин України «84» - Громадянка України | string | 0 |
112 | 2 | citizenCountry | Код країни громадянства (для негромадян України) | У відповідності до довідника країн ДРАЦС | string | 0 |
113 | 2 | RegistrationAddress | Зареєстроване місце проживання |
| AddressType | 0 |
114 | 3 | cbc_Country | Країна |
| string | 0 |
115 | 3 | CountryID | Ідентифікатор країни у класифікаторі ДРАЦС |
| integer | 0 |
116 | 3 | cbc_Postbox | Індекс | П’ятизначний поштовий індекс | string | 0 |
117 | 3 | cbc_Region | Область | Назва області (не заповнюється для м. Київ та м. Севастополь) | string | 0 |
118 | 3 | RegionID | Ідентифікатор області у класифікаторі ДРАЦС |
| string | 0 |
119 | 3 | cbc_District | Район області | Назва району області (не зазначається для міст обласного значення) | string | 0 |
120 | 3 | DistrictID | Ідентифікатор району області у класифікаторі ДРАЦС |
| integer | 0 |
121 | 3 | cbc_CityName | Назва населеного пункту |
| string | 0 |
122 | 3 | CityKOATUU | Код за КОАУУ населеного пункту | Код згідно з КОАТУУ | string | 0 |
123 | 3 | CityID | Ідентифікатор населеного пункту у класифікаторі ДРАЦС |
| integer | 0 |
124 | 3 | CityType | Тип населеного пункту | Тип (скорочено: м. – місто, смт – селище міського типу, с. – село) | string | 0 |
125 | 3 | CityTypeID | Ідентифікатору типу населеного пункту у класифікаторі ДРАЦС |
| integer | 0 |
126 | 3 | cbc_StreetName | Назва вулиці | Стандартні обмеження ФЛК для адрес | string | 0 |
127 | 3 | StreetID | Ідентифікатор вулиці у класифікаторі ДРАЦС |
| integer | 0 |
128 | 3 | StreetTypeName | Тип вулиці | Тип (вулиця, бульвар, проспект, провулок, площа, проїзд, узвіз тощо) | string | 0 |
129 | 3 | StreetTypeID | Ідентифікатор типу вулиці у класифікаторі ДРАЦС |
| integer | 0 |
130 | 3 | cbc_BuildingNumber | Будинок | Номер будинку (стандартні обмеження ФЛК для адрес) | string | 0 |
131 | 3 | BuildingPart | Корпус | Номер корпусу (за наявності) | string | 0 |
132 | 3 | Apartment | Квартира/кімната | Номер квартири (за наявності) | string | 0 |
133 | 2 | identityDocument | Реквізити паспорта або паспортного документа, що посвідчує особу |
| PassportDocumentType | 0 |
134 | 3 | passportTypeID | Тип документу | Довідник ДРАЦС. Можливі значення: 1 - Паспорт громадянина України; 2 - Дипломатичний паспорт України; 4 - Посвідчення особи моряка; 5 - Посвідчення особи на повернення в Україну; 6 - Посвідчення члена екіпажу; 7 - Тимчасове посвідчення громадянина України; 8 - Інший документ; 9 - Службовий паспорт України; 10 - Свідоцтво про народження | integer | 0 |
135 | 3 | documentSerial | Серія документа (за наявності) |
| string | 0 |
136 | 3 | documentNumber | Номер документа |
| string | 0 |
137 | 3 | cbc_IssueDate | Дата видачі документа |
| date (рррр-мм-дд) | 0 |
138 | 3 | cbc_IssuerID | Уповноважений суб’єкт, що видав документ |
| string | 0 |
139 | 3 | cbc_ExpiryDate | Строк дії документа (за наявності) |
| date (рррр-мм-дд) | 0 |
140 | 2 | eddr_UNZR | Унікальний номер запису в Єдиному державному демографічному реєстрі (за наявності) |
| string | 0 |
141 | 2 | tax_RNOKPP | Реєстраційний номер облікової картки платника податків | У разі відсутності РНОКПП, формувати ознаку «Відмова від РНОКПП» | string | 0 |
142 | 2 | tax_RNOKPPRefusal | Ознака відмови від РНОКПП | У разі відмови суб’єкта від РНОКПП повинно мати фіксоване значення «Відмова від РНОКПП» | string | 0 |
143 | 1 | FatherReason | Підстава запису відомостей про батька | Зазначається відомості про перебування батьків у шлюбі | object | 0 |
144 | 2 | marriageCert | Відомості про АЗ про шлюб |
| object | 0 |
145 | 3 | DocNumber | Номер АЗ |
| string | 0 |
146 | 3 | ComposeDate | Дата складання АЗ |
| date (рррр-мм-дд) | 0 |
147 | 3 | RegionOrg | Регіон органу ДРАЦС |
| string | 0 |
148 | 3 | ComposeOrg | Орган ДРАЦС |
| string | 0 |
|
| Відомості про спосіб отримання допомоги – обов’язковість заповнення визначається лише за умови вибору послуг 5-7 | ||||
149 | 1 | msp_childBornStipend | Відомості про отримання допомоги |
| object | 0 |
150 | 2 | msp_CBSParentRecipient | Особа отримувач | Вказується варіант: мати/батько | string | 0 |
151 | 2 | msp_CBSChannel | Відомості про спосіб отримання допомоги | Варіанти значень: «national_mail» - відділення національного оператора поштового зв’язку, «bank_account» - особовий рахунок в банку | string | 0 |
152 | 2 | msp_CBSPostChannelInfo | Реквізити для відділення національного оператора поштового зв’язку | Поле присутнє у разі, якщо msp_CBSChannel має значення «national_mail» | object | 0 |
153 | 3 | cbc_Postbox | Поштовий індекс поштового відділення |
| string | 0 |
154 | 3 | PostalServiceBranchName | Повне найменування поштового відділення |
| string | 0 |
155 | 2 | msp_CBSBankChannelInfo | Реквізити особового рахунку в банку | Поле присутнє у разі, якщо msp_CBSChannel має значення «bank_account» | object | 0 |
156 | 3 | msp_CBSBankAccount | Банківський рахунок одержувача |
| string | 0 |
157 | 3 | msp_CBSBankName | Повне найменування банку |
| string | 0 |
158 | 3 | msp_CBSBankEDRPOU | Код ЄДРПОУ |
| string | 0 |
159 | 3 | msp_CBSBankMFO | Код МФО |
| string | 0 |
|
| Відомості про дітей багатодітної сім’ї – обов'язковість заповнення визначаєтсья лише за умови вибору послуг 6-7 Дані не вводяться в заяві, а формуються автоматично за даними бази ДРАЦС по АЗ про народження при повному співпадінні даних батьків (ПІБ та дата народження) | ||||
160 | 1 | largeFamilyInfo | Інформація щодо багатодітності |
| object | 0 |
161 | 2 | otherChildrenInfo | Відомості про інших дітей | Інформація щодо всіх інших дітей | object | 0 |
162 | 3 | foaf_familyName | Прізвище |
| string | 0 |
163 | 3 | foaf_givenName | Ім’я |
| string | 0 |
164 | 3 | person_patronymicName | По батькові (за наявності) |
| string | 0 |
165 | 3 | schema_birthDate | Дата народження |
| date (рррр-мм-дд) | 0 |
166 | 3 | certificateOfBirthFull | Відомості, вказані у свідоцтві про народження
| Дані є обов’язковими для неповнолітніх дітей!!! Обов’язковість заповнення атрибутів блоку визначена для неповнолітньої дитини | object | 0 |
167 | 4 | CBIssuer | Орган державної реєстрації актів цивільного стану, що видав свідоцтво | Найменування органу державної реєстрації актів цивільного стану | string | 0 |
168 | 4 | CBIssueDate | Дата видачі свідоцтва |
| date (рррр-мм-дд) | 0 |
169 | 4 | documentSerial | Серія |
| string | 0 |
170 | 4 | documentNumber | Номер |
| string | 0 |
171 | 4 | ARDate | Дата складання актового запису про народження |
| date (рррр-мм-дд) | 0 |
172 | 4 | ARNumber | Номер актового запису про народження |
| string | 0 |
173 | 4 | ARIssuer | Місце державної реєстрації | Найменування органу державної реєстрації актів цивільного стану | string | 0 |
|
| Відомості про посвідчення багатодітної сім’ї – обов’язковість заповнення визначається лише за умови вибору послуг 7 | ||||
174 | 2 | LFCertificates | Посвідчення багатодітної сім’ї | Реквізити посвідчення зазначають щодо усіх членів родини (батько/мати, кожна дитина багатодітної сім’ї) | object | 0 |
175 | 3 | LFCertParents | Позначка про необхідність посвідчення батьків |
| boolean | 0 |
176 | 3 | LFCertChild | Позначка про необхідність посвідчення дітям |
| boolean | 0 |
177 | 3 | LFChildNames | Посвідчення багатодітної сім’ї – для дітей | Реквізити посвідчення зазначають для кожної дитини багатодітної сім’ї | object | 0 |
178 | 4 | foaf_familyName | Прізвище |
| string | 0 |
179 | 4 | foaf_givenName | Ім’я |
| string | 0 |
180 | 4 | person_patronymicName | По батькові (за наявності)
|
| string | 0 |
Вихідні параметри сервісу
Вміст елементу postCompositionRequestResult
№ | Рівень вкладеності | Код поля | Опис поля | Формат | Спосіб заповнення / Тип даних | Обов’язко-вість заповнення полів ДРАЦС- ДФС (при виборі послуги Type Service8) |
1 | 1 | processingID | Унікальний ідентифікатор опрацювання запитів інтеграції з ДРАЦС на стороні системи є Здоровʼя | UUID | string | 1 |
2 | 1 | ehealth:faultCode | Код статусу опрацювання системою єЗдоовʼя | Згідно таблиці кодів обробки запиту | string | 1 |
Коди обробки запиту
№ | Код статусу | Опис статусу опрацювання |
---|---|---|
1 | 200 | Запит успішно отримано |
2 | 500 | Внутрішня помилка сервера при обробці запиту |
ЕСОЗ - публічна документація