Назначение сервиса

Сервис Терминологии предназначен для автоматизации процессов консолидации, первичной обработки и ведения нормативно-справочной информации. Данный компонент предоставляет собой механизм управления процессом ведения нормативно-справочной информации и обеспечивает функции ее интеграции между различными учетными и информационными системами, являясь единым источником непротиворечивой информации о справочниках.

Сценарии работы сервиса

Обмен данными между внешними системами и сервисом Терминологии осуществляется в рамках следующих сценариев:

  1. Поиск справочника.

    Сервис Терминологии возвращает найденный справочник и метаинформацию по нему.

  2. Запрос версий справочника.

    Сервис Терминологии возвращает список версий справочника по идентификатору.

  3. Запрос значений справочника.

    Сервис Терминологии возвращает код и значение из справочника. Если в запросе указана версия справочника, то сервис возвращает значения этой версии справочника. Если версия не указана, то сервис возвращает значения из актуальной версии.

  4. Запрос дополнительной информации о значении (поиск значения).

    Сервис Терминологии возвращает дополнительную информацию о значении из справочника. Если в запросе указана версия справочника, то сервис возвращает значения этой версии справочника. Если версия не указана, то сервис возвращает значения из актуальной версии.

  5. Валидация значения в справочнике.

    Сервис Терминологии возвращает информацию о вхождении запрошенного значения в указанный справочник. Если в запросе указана версия справочника, то сервис возвращает значения этой версии справочника. Если версия не указана, то сервис возвращает значения из актуальной версии.

Базовая схема информационного взаимодействия приведена на [Рисунок 1].

Рисунок 1. Базовая схема информационного взаимодействия

Описание протокола взаимодействия

Общая информация

Информационный обмен осуществляется в соответствии со стандартом FHIR® (Fast Healthcare Interoperability Resources), разработанным организацией HL7. Подробное описание стандарта доступно по следующим ссылкам:

В качестве протокола взаимодействия используется REST (использование REST-протокола в FHIR® – см. http://fhir-ru.github.io/http.html).

Авторизация в сервисе и формат обмена

Для обращения к сервису Терминологии необходимо указать в заголовке сообщения авторизационный ключ в формате:

Authorization: N3[пробел][GUID передающей системы]

Авторизационный ключ системе-клиенту сервиса выдается администратором интеграционной платформы.

В качестве формата обмена требуется указать:

Content-Type: application/json

Операции со справочниками

Сервис Терминологии поддерживает следующие операции:

  1. Запрос справочника
  2. Запрос списка версий справочника
  3. Запрос значений справочника ($expand)
  4. Поиск значения в справочнике ($lookup)
  5. Валидация значения в справочнике ($validate-code)

Более подробно об операциях со справочниками можно ознакомиться по адресу: http://fhir-ru.github.io/valueset-operations.html

Описание операций сервиса

Запрос справочника

Получение информации о справочнике осуществляется с помощью GET-запроса. В качестве адреса должен быть указан URL в формате [base]/ValueSet?_format=json&url=urn:oid:[OID справочника]. Например,

[base]/ValueSet?_format=json&url=urn:oid:1.2.643.5.1.13.2.1.1.181

Метод возвращает детальную информацию о справочнике. Параметры ответа, которые используются в дальнейшей работе с сервисом приведены в [Таблица 1].

Таблица 1. Параметры ответа

Параметр Тип Описание
1. resource.id guid Идентификатор справочника в сервисе терминологии (используется при запросе списка версий справочника)
2. resource.meta.lastUpdated datetime Дата-время последнего обновления
3. resource.url string url-адрес справочника (используется в операциях запроса, поиска и валидации значения)
4. resource.version integer Значение актуальной версии справочника (используется в операциях запроса, поиска и валидации значения)

Запрос списка версий справочника

Получение информации о списке версий справочника осуществляется с помощью GET-запроса. В качестве адреса должен быть указан URL в формате [base]/ValueSet/[идентификатор справочника в сервисе Терминологии] /_history?_format=json. Например,

[base]/ValueSet/c52c91e3-ffea-4665-83c8-5f429349e48c/_history?_format=json

Метод возвращает массив с информацией по каждой версии справочника. Параметры ответа, которые используются в дальнейшей работе с сервисом приведены в [Таблица 2].

Таблица 2. Параметры ответа

Параметр Тип Описание
1. resource.id guid Идентификатор справочника в сервисе терминологии (используется при запросе списка версий справочника)
2. resource.meta.lastUpdated datetime Дата-время последнего обновления
3. resource.url string url-адрес справочника (используется в операциях запроса, поиска и валидации значения)
4. resource.version integer Значение актуальной версии справочника (используется в операциях запроса, поиска и валидации значения)

Запрос значений справочника ($expand)

Получение значений заданного справочника осуществляется с помощью POST-запроса по URL в формате [base]/ValueSet/$expand. Параметры запроса приведены ниже.

Описание параметров

Перечень параметров для получения значений справочника приведен в [Таблица 3].

Таблица 3. Параметры запроса

Параметр Тип Кратность Описание
1. system string 1..1 Значение кодовой системы (url-адрес справочника)
2. version integer 0..1 Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

Пример запроса

При запросе значений справочника в качестве адреса указывается URL в формате [base]/ValueSet/$expand?_format=json. В ответе сервис возвращает json с общей информацией о справочнике и массивом значений справочника в соответствии со значением кодовой системы.

Пример POST-запроса приведен в разделе примеры запросов.

Параметры ответа

Метод возвращает метаинформацию о справочнике и пары код-значение. Параметры ответа, которые используются в дальнейшей работе с сервисом приведены в [Таблица 2].

Таблица 4. Параметры ответа

Параметр Тип Описание
1. resource.id guid Идентификатор справочника в сервисе терминологии (используется при запросе списка версий справочника)
2. resource.meta.lastUpdated datetime Дата-время последнего обновления
3. resource.url string url-адрес справочника (используется в операциях запроса, поиска и валидации значения)
4. resource.version integer Значение актуальной версии справочника (используется в операциях запроса, поиска и валидации значения)
5. resource.expansion.contains.code string Код значения
6. resource.expansion.contains.display string Значение, соответствующее коду
7. resource.expansion.contains.version string Номер версии значения
8. resource.expansion.contains.contains   Для иерархических справочников дочерние объекты имеют структуру, как у головной. Вложенные дочерние объекты передаются в параметре contains (содержит также code, display, version и contains для передачи дочернего объекта)

Поиск значения в справочнике ($lookup)

Метод предназначен для получения дополнительной информации о значении справочника по коду этого значения. Поиск заданного значения в справочнике осуществляется с помощью POST-запроса по URL в формате [base]/ValueSet/$lookup. Параметры запроса приведены ниже.

Описание параметров

Перечень параметров для получения дополнительной информации о значении справочника приведен в [Таблица 5].

Таблица 5. Параметры запроса

Параметр Тип Кратность Описание
1. system string 1..1 Значение кодовой системы (url-адрес справочника)
2. code string 1..1 Код значения в справочнике
3. version integer 0..1 Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

Пример запроса

При поиске данных о значении в справочнике в качестве адреса указывается URL в формате [base]/ValueSet/$lookup?_format=json. В ответе сервис возвращает json с детализированной информацией о значении, которое соответствует коду значения из запроса.

Пример запроса приведен в разделе примеры запросов.

Параметры ответа

Метод возвращает массив дополнительных параметров значения справочника, соответствующего коду. Параметры ответа приведены в [Таблица 6].

Таблица 6. Параметры ответа

Параметр Тип Описание
1. parameter.name string Наименование дополнительного параметра для запрошенного значения справочника
2. parameter.valueString string Значение дополнительного параметра

Валидация значения в справочнике ($validate-code)

Метод предназначен для проверки: принадлежит ли код значения из запроса указанному справочнику. Валидация значения в справочнике осуществляется с помощью POST-запроса по URL в формате [base]/ValueSet/$validate-code. Параметры запроса приведены ниже.

Описание параметров

Перечень параметров для валидации кода значения в справочнике приведен в [Таблица 7].

Таблица 7. Параметры запроса

Параметр Тип Кратность Описание
1. system string 1..1 Значение кодовой системы (url-адрес справочника)
2. code string 1..1 Код значения в справочнике
3. version integer 0..1 Номер версии справочника. Если номер версии не указан, то возвращаются значения из актуальной версии

Пример запроса

При валидации значений справочника в качестве адреса указывается URL в формате [base]/ValueSet/$validate-code?_format=json. В ответе сервис возвращает json с указанием, найден ли код из запроса в соответствующем справочнике.

Пример POST-запроса приведен в разделе примеры запросов.

Параметры ответа

Метод возвращает результат проверки значения справочника. Параметры ответа приведены в [Таблица 8].

Таблица 8. Параметры ответа

Параметр Тип Описание
1. parameter.name string Наименование параметра (result)
2. parameter.valueBoolean boolean Результат проверки (true / false)

Доступные справочники

Федеральные справочники

Код Справочник
1.2.643.5.1.13.2.1.1.581 Классификатор целей посещения амб. организации
1.2.643.5.1.13.2.1.1.607 Номенклатура должностей медицинских работников и фармацевтических работников
1.2.643.5.1.13.2.1.1.181 Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения
1.2.643.5.1.13.2.1.1.635 Реестр страховых медицинских организаций (ФОМС)
1.2.643.5.1.13.2.7.1.30 Справочник «Роль в оказании помощи»
1.2.643.5.1.13.2.1.1.573 Классификатор жителя города или села
1.2.643.5.1.13.2.1.1.156 Справочник «Классификатор половой принадлежности»
1.2.643.5.1.13.2.7.1.15 Справочник «Отношение к пациенту»
1.2.643.5.1.13.2.1.1.104 Классификатор посещений по видам оплаты
1.2.643.5.1.13.2.7.1.41 Справочник «Статус оплаты услуги»
1.2.643.5.1.13.2.1.1.80 Классификатор единиц учета медицинской помощи
1.2.643.5.1.13.2.7.1.36 Справочник «Тип выдачи препарата»
1.2.643.5.1.13.2.7.1.64 Справочник «Способ применения медикамента»
1.2.643.5.1.13.2.1.1.118 Справочник «Группы здоровья»
1.2.643.5.1.13.2.7.1.2 Справочник «Вид направления»
1.2.643.5.1.13.2.7.1.15 Справочник «Отношение к пациенту (по уходу)»
1.2.643.5.1.13.2.7.1.9 Справочник «Уровни конфиденциальности»
1.2.643.5.1.13.2.1.1.688 Справочник «Исход заболевания»
1.2.643.5.1.13.2.1.1.106 Справочник «Цель обращения»
1.2.643.5.1.13.2.1.1.555 Классификатор состояний опьянения, в котором был доставлен в медицинскую организацию
1.2.643.5.1.13.2.1.1.111 Классификатор состояний при обращении (поступлении) в медицинскую организацию
1.2.643.5.1.13.2.1.1.537 Справочник времени доставки больного в стационар от начала заболевания (получения травмы)
1.2.643.5.1.13.2.1.1.281 Классификатор каналов госпитализации в лечебно-профилактическую организацию
1.2.643.5.1.13.2.1.1.56 Справочник "Анатомо-терапевтическо-химическая классификация"
1.2.643.5.1.13.2.1.1.221 Номенклатура коечного фонда медицинской организации
1.2.643.5.1.13.2.1.1.473 Номенклатура медицинских услуг
1.2.643.5.1.13.2.1.1.331 Классификатор лекарственных форм
1.2.643.5.1.13.2.1.1.180 Классификатор единиц измерения

Региональные справочники

Код Справочник
1.2.643.2.69.1.1.1.1 Региональные коды тестов по LOINC
1.2.643.2.69.1.1.1.2 МКБ10 региональной редакции
1.2.643.2.69.1.1.1.3 Справочник «Код группы крови»
1.2.643.2.69.1.1.1.4 Справочник «Код социальной группы (группы взрослого населения)»
1.2.643.2.69.1.1.1.5 Классификатор социальных статусов
1.2.643.2.69.1.1.1.6 Справочник «Тип документа»
1.2.643.2.69.1.1.1.7 Классификатор категорий льгот
1.2.643.2.69.1.1.1.8 Справочник «Классификатор характера заболевания»
1.2.643.2.69.1.1.1.9 Справочник «Причина изменения диагноза»
1.2.643.2.69.1.1.1.10 Справочник «Этап установления диагноза»
1.2.643.2.69.1.1.1.11 Классификатор состояния диспансерного учета по диагнозу (заболеванию)
1.2.643.2.69.1.1.1.12 Справочник «Классификатор травм по способу получения»
1.2.643.2.69.1.1.1.13 Справочник «Особенности выполнения стандарта»
1.2.643.2.69.1.1.1.14 Справочник «Статус документа временной нетрудоспособности»
1.2.643.2.69.1.1.1.15 Справочник «Причины выдачи документа временной нетрудоспособности»
1.2.643.2.69.1.1.1.16 Справочник «Вид медицинского обслуживания»
1.2.643.2.69.1.1.1.17 Справочник «Результат обращения»
1.2.643.2.69.1.1.1.18 Классификатор мест обслуживания
1.2.643.2.69.1.1.1.19 Классификатор целей посещения амбулаторно-поликлинической организации
1.2.643.2.69.1.1.1.20 Справочник «Первичность/повторность»
1.2.643.2.69.1.1.1.21 Справочник «Экстренность/плановость госпитализации»
1.2.643.2.69.1.1.1.22 Справочник «Вид транспортировки»
1.2.643.2.69.1.1.1.23 Справочник «Исход госпитализации»
1.2.643.2.69.1.1.1.24 Справочник «Дефекты догоспитального этапа»
1.2.643.2.69.1.1.1.25 Справочник «Режимы лечения»
1.2.643.2.69.1.1.1.26 Справочник «Статус диагноза»
1.2.643.2.69.1.1.1.27 Справочник «Тип контакта»
1.2.643.2.69.1.1.1.28 Справочник «Тип адреса»
1.2.643.2.69.1.1.1.29 Справочник "Стандарты учета оказания медицинской помощи"
1.2.643.2.69.1.1.1.30 Приоритет выполнения заявки (отметка срочности)
1.2.643.2.69.1.1.1.31 Код услуги заявки
1.2.643.2.69.1.1.1.32 Справочник «Источники финансирования»
1.2.643.2.69.1.1.1.33 Тип биоматериала
1.2.643.2.69.1.1.1.34 Тип контейнера
1.2.643.2.69.1.1.1.35 Справочник «Тип случая обслуживания»
1.2.643.2.69.1.1.1.36 Категория ресурса Condition
1.2.643.2.69.1.1.1.37 Тип ресурса Observation
1.2.643.2.69.1.1.1.38 Причина, по которой результат отсутствует
1.2.643.2.69.1.1.1.39 Тип Condition
1.2.643.2.69.1.1.1.40 Код пола пациента
1.2.643.2.69.1.1.1.41 Тип адреса
1.2.643.2.69.1.1.1.42 Статус DiagnosticOrder
1.2.643.2.69.1.1.1.43 Статус Encounter
1.2.643.2.69.1.1.1.44 Тип Encounter
1.2.643.2.69.1.1.1.45 Статус OrderResponse
1.2.643.2.69.1.1.1.46 Статус DiagnosticReport
1.2.643.2.69.1.1.1.47 Статус Observation
1.2.643.2.69.1.1.1.48 Виды полиса
1.2.643.2.69.1.1.1.49 Источник аннулирования
1.2.643.2.69.1.1.1.50 Статус направления
1.2.643.2.69.1.1.1.51 Регион
1.2.643.2.69.1.1.1.52 Вид медицинской помощи
1.2.643.2.69.1.1.1.53 Условия медицинской помощи
1.2.643.2.69.1.1.1.54 Форма медицинской помощи
1.2.643.2.69.1.1.1.55 Тип направления
1.2.643.2.69.1.1.1.56 Составной профиль помощи
1.2.643.2.69.1.1.1.57 Вид исследования
1.2.643.2.69.1.1.1.58 Область исследования
1.2.643.2.69.1.1.1.59 Составной тип документа
1.2.643.2.69.1.1.1.60 Причина аннулирования
1.2.643.2.69.1.1.1.61 Справочник МЭСов
1.2.643.2.69.1.1.1.62 Статус Condition
1.2.643.2.69.1.1.1.63 Справочник «Стандарты учета оказания медицинской помощи (ТФОМС)»
1.2.643.2.69.1.1.1.64 Справочник МО региона
1.2.643.2.69.1.1.1.65 Справочник «Отношение к пациенту (по уходу)»
1.2.643.2.69.1.1.1.66 Роль в направлении пациента