Versions Compared

Old Version 1

changes.mady.by.user Mariana Veremeieva (UA SoE eHealth)

Saved on

compared with

New Version 2

changes.mady.by.user Mariana Veremeieva (UA SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Загальні відомості про сервіс - зміни порівняно з 0.1

  1. (getCompositionRequest) Прибрано IdentityDocument.no_tax_id - не використовується

  2. (getCompositionRequest) Прибрано motherInfo.schema_birthDate - не використовується

  3. (getCompositionResponse) Додано DocOfBirth.ChildDocOrgName - відповідає legalEntity.name

  4. (getCompositionResponse) Додано набір параметрів стосовно місця надання сервісу ChildBirthState ChildBirthRegion ChildBirthDistrict ChildBirthLocalityType ChildBirthLocality

  5. (getCompositionRequest) додано параметр UNZR

Загальні відомості про сервіс

Сервіс створюється на стороні системи єЗдоровʼя ЗСЗУ МОЗ України з метою одержання інформації про наявність медичного висновку про народження, виданого певній особі зазначеній у цьому висновку.

На стороні сервісів ДРАЦС і Дія створюється клієнт, за допомогую якого передається номер медвисновку і набір атрибутів, які характеризують за якими атрибутами і документами ідентифіковано особу, для якої виконується запит медвисновку.

Вхідні параметри сервісу

Вміст елементу getCompositionRequest

№

Код параметру в системі єЗдоровʼя

Рівень вкладеності

Код параметру згідно WSDL
(із зазначенням простору імен)

Спосіб, тип заповнення даних

Опис параметру

Обовʼязкове(так/ні)

1

1

DocOfBirth

object

1

2

Composition.Title

2

ChildDocNumb

string

Ідентифікатор медичного висновку, що використовуються для ручних операцій визначення

1

5

Composition.focus.person.document

1

IdentityDocument

object

1

6

tax_id

2

tax_RNOKPP

string

У разі відсутності РНОКПП, формувати ознаку "Відмова від РНОКПП"

0..1

7

unzr

UNZR

string

УНЗР

0..1

8

document.serial

2

documentSerial

string

серія документа (за наявності)

0..1

9

document.number

2

documentNumber

string

номер документа

0..1

10

document.type

2

passportTypeID

integer

Довідник ДРАЦС.
Можливі значення:
1 - Паспорт громадянина України;
2 - Дипломатичний паспорт України;
4 - Посвідчення особи моряка;
5 - Посвідчення особи на повернення в Україну;
6 - Посвідчення члена екіпажу;
7 - Тимчасове посвідчення громадянина України;
8 - Інший документ;
9 - Службовий паспорт України;
10 - Свідоцтво про народження.

0..1

Вихідні параметри сервісу

Вміст елементу getCompositionResponse

№

Код параметру в системі єЗдоровʼя

Рівень вкладеності

Код параметру згідно WSDL
(із зазначенням простору імен)

Спосіб, тип заповнення даних

Опис параметру

Обовʼязкове(так/ні)

1

Composition

1

DocOfBirth

object

Ідентифікатор в системі медичний висновків

1

2

відповідає Type

2

ChildDocName

string

завжди константа “Медичне свідоцтво про народження дитини”

1

3

Title

2

ChildDocNumb

string

Номер документу

1

4

Date

2

ChildDocDate

date (рррр-мм-дд)

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

1

legalEntity.name

2

ChildDocOrgName

string

Назва органу, що видав документ

1

5

Composition.subject

1

childInfo

object

M/F - медично визначена стать дитини при народженні

1

6

Person.gender

2

schema_gender

string

хлопчик має значення:
«http://purl.org/linked-data/sdmx/2009/code#sex-M»

дівчинка має значення:
«http://purl.org/linked-data/sdmx/2009/code#sex-F»

1

2

ChildBirthState

Назва країни

Завжди константа “Україна”

1

division.addresses.area

2

ChildBirthRegion

Назва області

1

division.addresses.region

2

ChildBirthDistrict

Назва району

1

division.addresses.settlement_type

2

ChildBirthLocalityType

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

1

division.addresses.settlement

2

ChildBirthLocality

Назва населеного пункту (у тому числі м. Київ та м. Севастополь)

1

7

Person.birth_date

2

schema_birthDate

date (рррр-мм-дд)

Дата народження

1

8

1

ehealth:faultCode

 int

Код статусу опрацювання системою єЗдоровʼя

1

9

1

ehealth:Composition

bytes
base64

Файловий p7s обʼєкт закодований base64, який відповідає документу медичного висновка, підписаний КЕП лікаря

1

Коди помилок обробки запиту

№

Код помилки

Опис помилки

1

404

Медичний висновок не знайдено за параметрами наданими у запиты

2

403

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

3

400

Помилка обробки вхідного запиту у випадку відсутності достатньої кількості обовʼязкових параметрів

4

500

Внутрішня помилка опрацювання на стороні сервісу медичних висновків

5

200

Висновок успішно знайдено і надано відповідний результат

Опис структури обʼєкту Composition

Файл надається в полі eheatlh:Composition, закодований base64, контент представляє собою файловий конейнер p7s- файловий обʼєкт підписаний КЕП за методом внутрішнього підпису (дані і підпис в одному файлі).

Підписаний обʼєкт представляє собою json файл з наборов полів визначеним МОЗ/НСЗУ.
Опис полів надається в таблиці нижче.

№

Код параметру в системі єЗдоровʼя

Рівень вкладенності

Тип

Опис

1

author

1

object

Обʼєкт, який визначає автора документу

2

type

2

object

Опорний обʼєкт для визначення кодифікації

3

coding

3

array

Масив можливих значень кодифікації

4

code

4

string

Код обʼєкту, напр
employee

5

system

4

string

Система кодифікацї, напр.
eHealth/resources

6

text

3

string

Текст пояснення до обʼєкту author (заповнюється опціонально)

7

value

2

uuid

Ідентифікатор автора документу в реєстрі співробітників

8

category

1

object

Обʼєкт, який визначає категорію медичного висновку

9

coding

2

object

Масив можливих значень кодифікації обʼєкту

10

code

3

string

Категорія, напр. LIVE_BIRTH

11

system

3

string

Система кодфікації , напр eHealth/composition_categories

12

date

1

date/iso

Дата реєстрації документу в системі єЗдоровʼя
з вказанням часової зони згідно формату ISO
2020-07-15T18:32:12.398Z

13

encounter

1

object

Обʼєкт, який визначає медичну подію на основі якої створено даний медичний висновок

14

type

2

object

Опорний обʼєкт для визначення кодифікації

15

coding

3

array

Масив можливих значень кодифікації

16

code

4

string

Код обʼєкту, напр. encounter

17

system

4

string

Система кодифікацїі, напр. eHealth/resources

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

Код обʼєкту події, напр. COMPOSITION_VALIDITY_PERIOD

24

system

4

string

Система кодифікації
eHealth/composition_events

25

period

2

object

Період зазначеної події

26

start

3

date/iso

Дата початку дії документу з вказанням часової зони згідно формату ISO
2020-07-15T18:32:12.398Z

27

extension

1

array

Масив розширень. Завжди порожній у випадку медичних висновків про народження

28

identifier

1

object

Обʼєкт ідентифікатора медичного висновку

29

type

2

object

Опорний обʼєкт для визначення кодифікації

30

coding

3

array

Масив можливих значень кодифікації обʼєкту

31

code

4

string

Код обʼєкту, напр. composition

32

system

4

string

Система кодифікації, напр. eHealth/Composition

33

value

2

uuid

Ідентифікатор медичного висновку в реєстрі медичних висновків

34

section

1

object

Обʼєкт, який визначає набір даних повʼязаних з видачею медичного висновку субʼєкту

35

focus

2

object

Обʼєкт, який визначає субʼєкта, якому видано медичний висновок ( в більшості випадків - Мама новонародженого)

36

type

3

object

Обʼєкт, який визначає тип субʼєкта

37

coding

4

array

Масив можливих значень кодифікації обʼєкту

38

code

5

string

Код обʼєкту, напр. person

39

system

5

string

Система кодифікації, напр. eHealth/resources

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

Статус документу. Завжди має значення FINAL на цьому прикладному запиті

47

subject

1

object

Обʼєкт, який визначає пацієнта в даному медичному висновку

48

type

2

object

Обʼєкт, який визначає тип пацієнта в системі єЗдоровя

47

coding

3

array

Масив можливих значень кодифікації обʼєкту

48

code

4

string

Код обʼєкту, напр. pre_person

49

system

4

string

Система кодифікації, напр. eHealth/resources

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

Код обʼєкту. Завжди має значення NEWBORN для висновків про народження

56

system

3

string

Система кодифікації, напр eHealth/composition_types