Механизм выгрузки ВИМИС

Механизм выгрузки ВИМИС построена на базе сервиса "Региональная ИЭМК" и полностью наследует все объекты и методы (http://api.n3med.ru/api/iemk/).

Формирование СЭМД / СЭМД beta происходит на основании полученных СМО (Случая медицинского обслуживания), поступившего в региональную ИЭМК от МИС МО.

Передача СМО может происходить следующими методами: AddCase, CreateCase и CloseCase, UpdateCase. Примеры запросов.

Для передачи дополнительных параметров, не входящих в объектную модель ИЭМК, используется расширение объекта MedDocument типа Observation. Расширенный набор ЭМД в рамках объекта MedDocument допустимо передавать на уровне СМО (объекта CaseBase интерфейса ИЭМК http://api.n3med.ru/api/iemk/). В случае, если пациент перемещается между структурными подразделениями (например, документа «Выписной эпикриз из стационара по отдельным профилям медицинской помощи») или в рамках случая был произведен осмотр несколькими врачами - передавать MedDocument следует на уровне эпизода обслуживания (Step).

Способы передачи документов

Далее указаны два возможных способа передачи документов в ВИМИС. Для обоих способов важно:

  1. Наличие диагноза в кейсе.
  2. Корректное указание типа отправляемого документа.

Диагнозы следует передавать в объекте Diagnosis интерфейса ИЭМК с указанием MkbCode в соответствии с протоколом информационного взаимодействия. Все валидные диагнозы ВИМИС вынесены в региональные справочники по нозологиям:

  • «ВИМИС АКиНЕО. Диагнозы МКБ-10» 1.2.643.2.69.1.1.1.165
  • «ВИМИС ОНКО. Диагнозы МКБ-10» 1.2.643.2.69.1.1.1.167
  • «ВИМИС ССЗ. Диагнозы МКБ-10» 1.2.643.2.69.1.1.1.168
  • «ВИМИС Профилактическая медицина. Диагнозы МКБ-10» 1.2.643.2.69.1.1.1.229
  • «ВИМИС Инфекционные заболевания. Диагнозы МКБ-10  1.2.643.2.69.1.1.1.247

При передаче контейнера MedDocument должен быть указан его тип, который соответствует типу формируемого документа ВИМИС. Для задания типа контейнера MedDocument используется параметр IdMedDocumentType, значение которого должно соответствовать значениям справочника 1.2.643.2.69.1.1.1.195. 

Поле «Версия типа документа» указывает на новую редакцию документов, согласно протоколам информационного взаимодействия по нозологиям.

Таблица 1. Коды документов (выдержка из справочника 1.2.643.2.69.1.1.1.195)

Тип СЭМД beta-версии
\Тип СЭМД
Наименование
IdMed
Document
Type
Онко
ССЗ
АКиНЕО
Проф
Инфекционка
Версия 
типа
документа

1

Направление на оказание медицинских услуг (ВИМИС СМС1)

125

+






2


Протокол инструментального исследования


164

+

+


+

+

3

190



+



2

3

Протокол лабораторного исследования

179

+

+

+

+

+

3

4

Протокол прижизненного патологоанатомического исследования биопсийного (операционного) материала

184

+





3

5

Прием (осмотр) врача-специалиста

159

+

+

+

+

+

3

6

Протокол консилиума врачей

160


+



+

3

7

Контрольная карта диспансерного наблюдения

282

+



+


1

8

Выписной эпикриз из стационара по отдельным профилям медицинской помощи

161

+

+

+

+

+

3

9

Протокол цитологического исследования

180

+



+


3

10

Протокол хирургической операции

162

+

+




3

11

Протокол на случай выявления у больного запущенной формы злокачественного новообразования

187

+





3

13

Медицинское свидетельство о смерти

174

+

+

+

+

+

3

14

Лист исполненных (выполненных) лекарственных назначений

163

+

+



+

3

15

Талон на оказание высокотехнологичной медицинской помощи

188

+





1

16

«Ретроспективные данные по пациентам с онкологической патологией»

189

+





3

17

Выписной эпикриз родильного дома

191



+



2

18

Карта вызова скорой медицинской помощи

166


+


+


3

19

Медицинское свидетельство о перинатальной смерти

175



+



3

20

Протокол консультации

181

+






21

Протокол консультации в рамках диспансерного наблюдения

182

+






22

Извещение о критическом акушерском состоянии

144



+




23

Протокол анкетирования

194




+


3

24

Эпикриз по результатам диспансеризации/профилактического медицинского

195




+


3

25

Протокол медицинской манипуляции

168



+

+


3

27

Направление на консультацию и во вспомогательные кабинеты

167

+

+

+

+

+

3

28

Направление на программу ВРТ

169



+



3

29

Справка о выполнении программы ВРТ

170



+



3

30

Протокол выполнения программы ВРТ

171



+



3

31

Заключение по результатам расчета индивидуального риска

172



+



3

32

Протокол родов

173



+



3

33

Протокол анкетирования из иных информационных систем

196




+


3

36

Протокол патолого-анатомического вскрытия

177

+






37

Извещение о больном с впервые в жизни установленным диагнозом

178

+






38

Экстренное извещение об инфекционном заболевании, пищевом, остром профессиональном отравлении, необычной реакции на прививку

283





+

3

48

Направление на проведение неонатального скрининга

263



+



3


Способ 1. Готовый CDA.

В данном случае МИС формирует документ (Правила формирования и передачи СЭМД\СЭМД beta приведены в ПИВ ВИМИС «Профилактическая медицина. Профилактика инфекционных болезней» с внешними информационными системами) самостоятельно и передает его как вложение (DocumentAttachment) в MedDocument. В таком случае должны быть выполнены следующие условия:

  • в кейсе должен быть указан диагноз или пациент должен иметь статус мониторинг ВИМИС;
  • у документа должен быть указан IdMedDocumentType согласно справочнику 1.2.643.2.69.1.1.1.195;
  • тип вложения MimeType - text/xml;
  • во вложении должен быть медицинский документ, соответствующий федеральным регламентам, закодированный в base64.

Способ 2. Формирование CDA на стороне шины (Observation)

В данном случае МИС формирует документ с использованием Observation. Формирование итогового документа происходит автоматически, на основании переданных данных. Условия формирования документа

  • в кейсе должен быть указан диагноз или пациент должен иметь статус мониторинг  ВИМИС;
  • у документа должен быть указан IdMedDocumentType согласно справочнику 1.2.643.2.69.1.1.1.195;
  • должен быть передан минимальный набор Observation(указан в ОИП к каждому документу, смотри внизу страницы).

Коды объектов Observation приведены в приложении к ОИП, код указан по справочнику 1.2.643.2.69.1.1.1.127.

Для объектов, имеющих сложную структуру (для которых в приложениях в графе «Порядок наполнения» указано «Является составной частью структуры витального параметра») приведено описание и пример передачи в отдельном документе «JSON, используемые при формировании СМС» (одноименный файл в формате doc/pdf, являющийся неотъемлемой частью к ОИП).


Важно! Формирование CDA на стороне шины (Observation) доступно по следующим версиям:

  1. ВИМИС «Онкология» 4.0 (ссылка)
  2. ВИМИС "АкиНео" 2.0 (ссылка)
  3. ВИМИС "ССЗ" 2.0 (ссылка)
  4. ВИМИС "Профилактика" 2.0 (ссылка)

Исключения

1. Для формирования лабораторных, инструментальных, цитологических и патологоанатомических исследований, а так же направления на неонатальный скрининг используются данные, передаваемые внешними информационными системами в сервисы (при их наличии) ОДЛИ и ОДИИ интеграционной шины (http://api.n3med.ru/api/odli/).

2. Документы «Медицинское свидетельство о смерти» и «Медицинское свидетельство о перинатальной смерти» передаются в региональную ИЭМКа методом AddMedRecord, который должен содержать MedDocument с вложением (Attachments) и типом (MimeType) text/xml. Во вложении должен быть медицинский документ, соответствующий федеральным регламентам, закодированным в base64.

Получение пациентом статуса Мониторинг ВИМИС

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

  1. Поступил документ с диагнозом соответствующим одной из нозологий и типом документа по 195 справочнику.
  2. Поступил документ без учета диагноза в СМО
    1. ВИМИС АКИНЕО - смс 28, 29, 30
    2. ВИМИС Профилактическая медицина - смс 5, 8, 23, 24, 25, 33  отправляются в ВИМИС Профилактическая медицина, если IdCasetype = 4, 6, 7(или IdCasetype = 2, 4, 6, 7 + IdCasePurpose =4)
    3. ВИМИС Профилактика инфекционных болезней - смс 38
    4. При отправке направления и результата неонатального скрининга в сервис ОДЛИ получение пациентом статуса МВ происходит при получении документа смс 48 либо смс 3  
  3. При получением пациентом статуса мониторинг ВИМИС, все отправленые документы подходящие под выгрузку в ВИМИС, будут выгружены в подходящую нозологию(или массив нозологий) без проверки диагноза СМО.

Важно! Пациент не получает статус МВ по документам отправленным через ОДЛИ/ОДИИ(за исключением направления и результата неонатального скрининга  ) и УО.

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

Отправка документа в несколько нозологии происходит по следующим условиям:

  1. Документы на пациента получены впервые, но диагноз подходит в несколько нозологий.
  2. Пациент имеет статусы МВ по разным нозологиям

Важно! При наличии нескольких статусов Мониторинг ВИМИС выгрузчик сам проверяет перечень документов, подходящих под нозологию. Например, документы ВРТ не будут направлены в ОНКО.

Снятие статуса Мониторинг ВИМИС

Мониторинг ВИМИС снимается при достижении одного из условий

Условие 1. Произошла выгрузка документа "Медицинское свидетельство о смерти" или "Медицинское свидетельство о перинатальной смерти" (idmeddocumenttype=137, 147, 192, 193, 174, 175) в федеральный сервис.

Условие 2. Прекращение мониторинга ВИМИС производится согласно пункта 7.1.3 ПИВ ВИМИС «Профилактическая медицина. Профилактика инфекционных болезней» с внешними информационными системами


Важно! После снятие Мониторинга ВИМИС документы на пациента принимаются в течении 14 дней. МСС принимается 180 дней.


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

  1. ВИМИС «Онкология» 4.0 (ссылка)
  2. ВИМИС "АкиНео" 2.0 (ссылка) и  ВИМИС «АКиНЕО» в части создания СЭМД-бета «Направление на неонатальный скрининг» (ссылка)
  3. ВИМИС "ССЗ" 2.0 (ссылка)
  4. ВИМИС "Профилактика" 2.0 (ссылка)
  5. ВИМИС «Профилактическая медицина. Профилактика инфекционных болезней» с внешними информационными системами (ссылка)

ОИП

Далее приведено актуальное описание ОИП ВИМИС

  • Перетащите для загрузки или обзор файлов
  • Лист изменений.pdf


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

    Обучающее видео "ВИМИС. Отправка документов"

    Отправка документа

    Что значит "успешная отправка"?

    Документ считается успешно отправленном, если федеральный сервис принял документ и вернул колбек со статусом 4.

    Отправили документ в ИЕМКа, но в в Eventlog документ не появился. Почему?

    Следует проверить следующие моменты:

    • в кейсе был передан ClinicMainDiagnosis c MkbCode соответствующий справочникам
      • 1.2.643.2.69.1.1.1.165 "ВИМИС АКиНЕО. Диагнозы МКБ-10"
      • 1.2.643.2.69.1.1.1.167 "ВИМИС ОНКО. Диагнозы МКБ-10"
      • 1.2.643.2.69.1.1.1.168 "ВИМИС ССЗ. Диагнозы МКБ-10 "
      • 1.2.643.2.69.1.1.1.229 "ВИМИС Профилактическая медицина. Диагнозы МКБ-10"
    • в документе IdMedDocumentType соответствует справочнику 1.2.643.2.69.1.1.1.195 "Виды электронных медицинских документов"
    • если в документе присутствует вложение Attachment c типом text/xml
    • у пациента не завершен Контроль ВИМИС

    Как понять по справочнику 1.2.643.2.69.1.1.1.195 какой документ нам следует выгружать?

    В данном справочнике для ВИМИС есть 2 ключевых поля "vimis_code" и "Версия типа документа"

    • vimis_code должен быть заполнен номером смс, которую необходимо выгрузить.
      • По федеральному регламенту "Протокол информационного взаимодействия", данное поле соответствует полю "Тип СЭМД beta-версии (тег «docType» в теле SOAP пакета)"
    • "Версия типа документа" должна соответствовать версии отправляемого документа
      • По федеральному регламенту "Протокол информационного взаимодействия", данное поле соответствует полю "Версия типа СЭМД beta-версии (тег «docTypeVersion» в теле SOAP пакета)"

    Контроль ВИМИС

    В какой момент проставляется контроль ВИМИС?

    Контроль ВИМИС проставляется при любой отправке документа в сервис ВИМИС.

    Для нозологии АКиНЕО важно, чтобы даты открытия / закрытия случая (OpenDate и CloseDate) были текущим годом.

    В какой момент снимается контроль ВИМИС?

    Контроль ВИМИС для нозологии АКиНЕО снимается по истечении 365 дней со дня простановки контроля.

    Для всех нозологий контроль снимается в случае успешной отправки документа "Медицинское свидетельство о смерти" на пациента, либо Медицинское свидетельство о пренатальной смерти.


    Ошибки FLK (статус 5)

    Ошибка "FLK-003 Не удалось выполнить проверку идентификаторов структурных подразделений"?

    Ошибка возникает из-за отсутствия в справочнике НСИ - "ФРМО. Справочник структурных подразделений" структурного подразделения. Следует проверить было ли передано структурное подразделение, а не отделение. Для добавления значений в справочник "ФРМО.

    Ошибка "FLK-005 Не удалось выполнить проверку медицинских работников "?

    Ошибка возникает из-за отсутствия медицинских работников в ФРМР.

    Ошибка "FLK-005 Не удалось выполнить проверку медицинских работников. PostCode: 58 Должность отсутствует в списке должностей мед. работника на указанную в СЭМД"?

    Ошибка возникает, так как в ФРМР отсутствует передаваемая должность у оказанного мед.работника. Следует откорректировать должности у мед.работника или указать корректную дату отправки.


    Ошибки сборки (статус 2)

    Ошибка "Object reference not set to an instance of an object."?

    Ошибка возникает из-за отсутствия обязательного витального параметра. Просьба написать в ОТРС о такой ошибке, так как мы стараемся все ошибки сделать читабельными для пользователя.

    Ошибка вида "The JSON value could not be converted to System.Nullable`1[System.Int32]. Path: $[0].Type | LineNumber: 1 | BytePositionInLine: 53."?

    Ошибка возникает из-за некорректно переданного значения в json. Необходимо обратиться к ОИП и удостоверится, что данные переданы в соответствии с необходимым типом.

    Ошибка "Value cannot be null. (Parameter 'source')"?

    Ошибка возникает из-за того, что не удалось считать данные из витального параметра. Необходимо проверить верно ли указан тип витального параметра

    Ошибка вида "JsonToken EndArray is not valid for closing JsonType Object. Path '[0]', line 1, position 176."

    Проверьте json на наличие закрывающейся скобки } или ]

    В данном разделе описаны методы взаимодействия с региональной МИС посредством REST (Postman) для МИС

    Авторизация в сервисе и адрес сервиса

    Адрес сервиса - Адрес Модуля приема документов от МИС (Cda-gen)

    Пример:

    http://rc-test/CDAGen/api/Vimis

    В зависимости от типа запроса, в адресную строку запроса добавляется эндпоинт:

    • IsControl для получения статуса "Контроль ВИМИС"
    • clinrecList - для получения списка клинических рекомендаций
    • clinrec/id - для получения клинической рекомендации
    • ompList - для получения списка ОМП
    • omp/id - для получения ОМП
    • KAS - для получения идентификатора КАС
    • checkstatus - для получения статуса выгрузки ВИМИС в региональную ВИМИС;

    Авторизация осуществляется посредством передачи авторизационного ключа, значение которого соответствует значению авторизационного ключа Сервиса ИЭМК. Ключ выдается администратором интеграционной платформы. Авторизационные данные  указывается в заголовке REST-сообщения в следующем формате:

    Authorization:N3[пробел][GUID передающей МИС]

    Пример передачи Авторизационного ключа

    Authorization:N3 479414DE-8830-4487-A560-0A22E23C89B4M

    Получение статуса "Контроль ВИМИС"

    Данный метод предназначен для получения статуса "Контроль ВИМИС" по пациенту. Статус "Контроль ВИМИС" устанавливается пациенту, если данные по его СМО были успешно переданы в федеральный сервис ВИМИС. В настоящее время поддерживается передача данных в ВИМИС "АкиНео", "Онкология", "ССЗ", "Профилактическая медицина". Статус "Контроль ВИМИС" можно получить как по всем ВИМИС одновременно, так и только в разрезе выбранной нозологии, например, "ССЗ".

    Метод реализуется контроллером Vimis, входящего в состав компонента CDA Generator сервиса Региональная ИЭМКа.

    Метод

    Запрос на проверку осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/$IsControl

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

    Для получения статуса "Контроль ВИМИС" необходимо отправить запрос со следующими параметрами:

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

    Параметр

    Кратность

    Тип

    Описание

    idPerson

    1..*

    string

    Идентификатор пациента MPI, по которым требуется выполнить поиск 

    idRecipientSystem

    0..*

    int

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


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

    Параметр Тип Кратность Описание
    idPerson  string 1..1 Идентификатор пациента MPI
    startDate datetime 0..1 Дата получения статуса Мониторинг ВИМИС
    idRecipientSystem int 1..1 Идентификатор нозологии ВИМИС
    description string 1..1 Наименование нозологии ВИМИС
    confirmed bool 1..1 Подтверждение успешной выгрузки (значение true, если был получен статус 4 по смс)

    finishDate

    datetime 0..1 Дата снятия статуса Мониторинг ВИМИС

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

    {
        "resourceType": "Parameters",
        "parameter": [
            {
                "name": "idPerson",
                "valueString": "aa58b7ae-362f-4f4b-aeeb-f550806382b1, f4bd6b85-1400-4375-ba79-08854f2acf5b"
            }
        ]
    }

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

    [{
      "idPerson": "f4bd6b85-1400-4375-ba79-08854f2acf5b",
      "startDate": "2018-07-17T21:00:00.000Z",
      "idRecipientSystem": 2,
      "Description": "Онкология",
      "confirmed": false
    },
    {
      "idPerson": "aa58b7ae-362f-4f4b-aeeb-f550806382b1",
      "startDate": "2018-07-17T21:00:00.000Z",
      "idRecipientSystem": 1,
      "Description": "Акинео"
      "confirmed": false
    }]

    Метод работает следующим образом:

    1. Получение массива карт пациента.
    2. Проверка принадлежность всех карт к 1 пациенту.
      1. В случае отсутствия карт в системе, вернется статус 400 "Отсутствуют данные о пациенте".
      2. В случае отсутствия данных по пациенту, вернется статус 200 "По указанным параметрам ничего не найдено"
    3. Отбор записей в БД по заданным параметрам.

    Примечание. Соответствие кода и названия ВИМИС (idRecipientSystem):

    1. АкиНео
    2. Онкология
    3. ССЗ
    4. Профилактическая медицина


    Получение клинических рекомендаций

    Ниже приведен пример добавления случая медицинского обслуживания методом AddCase с необходимыми витальными параметрами для дальнейшего формирования СМС 5 АКиНЕО

    Клинические рекомендации хранятся в сервисе «Региональная ИЭМК» и передаются в МИС МО по запросу к компоненту REST API CDA Generator. Ниже указзаны методы, использующиеся в запросе.

    Метод clinrecList

    Запрос на получение списка клинических рекомендаций осуществляется с помощью метода GET, в качестве адреса указывается URL в формате [base]/api/Vimis/clinrecList

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

    Для получения получения списка клинических рекомендаций используется метод ClinrecList без указания дополнительных параметров.

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

    Параметр Тип Кратность Описание
    id int 1..1 Идентификатор документа
    name string 1..1 Название документа
    mkb10 string 1..1 Список диагнозов, к которым относится КР
    age_group string 1..1 Возрастная группа
    revision_id int 1..1 Идентификатор редакции документа КР
    revision_begin_date datetime 1..1 Дата вступления в силу редакции документа КР
    revision_end_date datetime 0..1 Дата утраты силы редакции документа КР

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

    [
     {
      "id": 366,
      "name": "Клинические рекомендации "Хроническая сердечная недостаточность"",
      "mkb10": "I50.9,I50.1,I50.0",
      "age_group": "0",
      "revision_id": 604,
      "revision_begin_date": "2020-01-01",
      "revision_end_date": "null"
      }
    ]

    В ответе возрващется массив рекомендаций с уникальным идентификатором id.

    Метод clinrec

    Запрос на получение клинических рекомендаций осуществляется с помощью метода GET, в качестве адреса указывается URL в формате [base]/api/Vimis/clinrec/id

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

    Для получения структурированной информации по документу клинических рекомендаций используется метод clinrec с идентификатором документа клинических рекомендаций id.

    • id – идентификатор документа клинических рекомендаций, полученный в методе clinrecList 

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

    [{
      "clinrec": "декодированное сообщение в base64"
    }]

    В ответе возвращаются сообщение, зашифрованное в Base64, содержащее клинические рекомендации.

    Метод ompList

    Запрос на получение списка документов порядков ОМП осуществляется с помощью метода GET, в качестве адреса указывается URL в формате [base]/api/Vimis/ompList

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

    Для получения списка документов порядков ОМП используется метод ompList без указания дополнительных параметров.

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

    Параметр Тип Кратность Описание
    id int 1..1 Идентификатор документа
    name string 1..1 Название документа
    profile string 1..1 Профиль ОМП
    revision_id int 1..1 Идентификатор редакции документа порядка ОМП
    revision_begin_date datetime 1..1 Дата вступления в силу редакции документа порядка ОМП
    revision_end_date datetime 0..1 Дата утраты силы редакции документа порядка ОМП

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

    [{
      "id": 393,
       "name": "Приказ Министерства здравоохранения Российской Федерации от 20 октября 2020 г. N 1130н "Об утверждении Порядка оказания медицинской помощи по профилю "акушерство и гинекология",   
       "profile" : "2",   
       "revision_id" : 604,   
       "revision_begin_date" : "2020-01-01",   
       "revision_end_date" : "null"   
    }]

    В ответе возвращается массив порядков ОМП с уникальным идентификатором id.

    Метод omp

    Запрос на получение структурированной информации порядка ОМП осуществляется с помощью метода GET, в качестве адреса указывается URL в формате [base]/api/Vimis/omp/id

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

    Для получения структурированной информации по порядку ОМП используется метод omp с идентификатором порядка ОМП id.

    • id – идентификатор документа клинических рекомендаций, полученный в методе ompList 

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

    [{
      "clinrec": "декодированное сообщение в base64"
    }]

    В ответе возвращается сообщение, зашифрованное в Base64, содержащее порядок OMP.


    Получение КАС для смс 22 "Извещение о критическом акушерском состоянии"

    Критическое акушерское состояние – заболевания, синдромы и симптомы, требующие проведения мероприятий по реанимации и интенсивной терапии женщин в период беременности и в течение 42 дней после ее окончания.

    Метод

    Для получения идентификатора КАС необходимо выполнить POST запрос в cdagen. В качестве адреса указывается URL в формате [base]/api/Vimis/KAS

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

    Параметр

    Тип

    Кратность

    Описание

    mo_oid

    string

    1..1

    oid медицинской организации

    year

    int

    1..1

    год случая

    region

    string

    1..1

    регион нахождения медицинской организации


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

    Параметр Тип Кратность Описание
    data datetime 1..1

    Содержит результат обработки запроса в случае успеха.
    null в случае неуспеха

    number string 0..1

    Уникальный идентификатор случая КАС
    Формат: "хх-хх-ххххх"

    is_success bool 1..1 Статус обработки запроса
    errors array 1..1 Возникшие ошибки в случае неуспеха


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

    {
      "mo_oid": "1.2.643.5.1.13.13.12.2.23.104004",
      "year": 2022,
      "region": "23"
    }

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

    {
        "data": {
            "number": "22-23-00659"
        },
        "is_success": true,
        "errors": []
    }

    Метод получения статуса документа

    Данный метод предназначен для получения статусов документов из региональной ВИМИС.

    Метод реализуется контроллером Vimis, входящего в состав компонента CDA Generator сервиса Региональная ИЭМКа.

    ВАЖНО!

    Метод работает только с одним набором параметров. Следует передавать msg_id или связку IdDocumentMis + IdLpu(это идентификатор МО) + IdMedDocumentType. Если будут переданы все параметры, то поиск будет осуществляться по msg_id.

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/checkstatus

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

    Параметр Кратность Тип Описание
    MsgId [1..*] string Идентификатор документа в ВИМИС
    ИЛИ
    IdMedDocumentType 1...1 int Тип ЭМД - федеральный код (значения по справочнику 1.2.643.2.69.1.1.1.195).
    id_med_document_type в registry_sms.sms_info
    Organization 1...1 uuid Идентификатор МО, отправителя данных (IdLpu - поле Код по справочнику 1.2.643.2.69.1.1.1.64)  - id_lpu_source
    IdDocumentMis 1...1 string Идентификатор источника данных в МИС. Фильтр по id_document_mis
    Take 1..1 string

    Параметр порядка отбора данных, допустимы значения last или all:

    • last - вывод данных записи последней попытки выгрузки документа (преимущество при отборе, у записей с успешной выгрузкой)
    • all - вывод данных всех попыток выгрузки документа, в порядке убывания даты выгрузки. 


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

    Параметр Тип Кратность Описание
    RegisterDate datetime 1..1 Дата отправки запроса на регистрацию СМС
    CallbackDeliveryDate datetime 0..1 Дата получения ответа от федерального сервиса, на попытку зарегистрировать СМС
    IdMedDocumentType int 1..1 Тип медицинского документа ( по справочнику 1.2.643.2.69.1.1.1.195)
    IdCondition int 1..1 Номер смс
    condition string 0..1 Наименование смс
    IdDocumentMis string
    Идентификатор мед. документа в МИС
    RecipientSystem
    1..1 нозология
    1- Акинео
    2- Онко
    3- ССЗ
    4- Профилактическая медицина
    Status string 1..1 Статус
    description string 1..1 Описание статуса


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

    { "MsgId": ["01636143-600e-42ac-927c-6cda4f45dd39"] }

    ИЛИ

    {
        "IdMedDocumentType": 159,
        "Organization": "e87fb003-9c57-4637-99e2-0e0accb9d229",
        "IdDocumentMis": "2536_1417602",
        "Take": "all"
    } 


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

    [{    
    "RegisterDate":"2023-01-11 14:12:12.878 +0300",
    "CallbackDeliveryDate":"2023-01-11 14:12:20.539 +0300",
    "IdMedDocumentType":"159",
    "IdCondition":"5"  ,
    "condition": "Прием (осмотр) врача-специалиста",
    "IdDocumentMis": "2536_1417602",
    "RecipientSystem": "ССЗ",
    "Status": "4",
    "description": "Запись в базу данных выполнена успешно"
    }] 

    Взаимодействие с сервисом СППВР

    Данный метод предназначен для получения архивных файлов с обезличенными СЭМД (СЭМД beta-версии) информационными системами СППВР. 

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/sppvr/region/year/month/day.zip.

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

    Параметр

    Тип

    Обязательность

    Описание

    region

    число

    Да

    Код субъекта РФ (по справочнику федерального реестра НСИ «Субъекты Российской Федерации»,
    OID: 1.2.643.5.1.13.13.99.2.206)

    year

    число

    Да

    Год получения СЭМД

    month

    число

    Да

    Месяц получения СЭМД

    day

    число

    Да

    День получения СЭМД

    В ответ синхронно возвращается результат в виде архивного файла в формате zip, содержащий обезличенные СЭМД в виде xml-файлов.

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

    /api/Vimis/sppvr/Year=2023/Month=8/Day=1

    Получение результатов лексического разбора

    Данный метод предназначен для получения МИС результатов лексического разбора текстового описания диагноза в электронных медицинских документах в формате JSON от компоненты платформы ВИМИС «Онкология». 

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/lexicalAnalysisResult/{msgId}

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

    Параметр

    Тип

    Обязательность

    Описание

    msg_id

    текст

    Да

    Идентификатор, присвоенный исходному запросу в ответ на метод sendDocument

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

    Параметр

    Тип

    Обязательность

    Описание

    description

    текст

    Да

    Комментарий по статусу лексического разбора

    result

    массив

    Да

    Результат лексического разбора текстового описания диагноза в электронных медицинских документах в формате JSON

    Описание содержимого параметра result

    Параметр

    Тип

    Обязательность

    Описание

    coded_part

    объект

    Да

    Набор данных по лексическому разбору, направленному на отбор и анализ совпадений текстового описания диагноза с кодированной частью


    description

    текст

    Да

    Комментарий к набору данных


    coded_part_result

    массив

    Да

    Набор данных результата лексического разбора



    nsi

    текст

    Да

    OID справочника федерального реестра НСИ



    nsi_name

    текст

    Да

    Наименование справочника федерального реестра НСИ



    code

    текст

    Да

    Код значения из справочника федерального реестра НСИ



    name

    текст

    Да

    Наименование значения из справочника федерального реестра НСИ



    diagnosis_text

    массив

    Да

    Отобранные значения из текстового описания диагноза



    match

    Логическое значение

    Да

    Признак совпадений отобранных значений из текстового описания диагноза с кодированной частью

    not_coded_part

    объект

    Да

    Набор данных по лексическому разбору, направленному на отбор и анализ медицинских понятий текстового описания диагноза, отсутствующих в кодированной части


    description

    текст

    Да

    Комментарий к набору данных


    not_coded_part_result

    массив

    Да

    Набор данных результата лексического разбора



    nsi

    текст

    Да

    OID справочника федерального реестра НСИ



    nsi_name

    текст

    Да

    Наименование справочника федерального реестра НСИ



    diagnosis_text

    массив

    Да

    Отобранные значения из текстового описания диагноза



    variants

    массив

    Да

    Возможные варианты справочных значений медицинских понятий




    code

    текст

    Да

    Код значения из справочника федерального реестра НСИ




    name

    текст

    Да

    Наименование значения из справочника федерального реестра НСИ

    Проверка уникального идентификатора случая КАС 

    Метод проверки уникального идентификатора случая КАС.

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/checkKasNumber/{kasNumber}

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

    Параметр

    Тип

    Обязательность

    Описание

    number

    строка

    Да

    Уникальный идентификатор случая КАС

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

    Параметр

    Тип

    Обязательность

    Описание

    data

    объект

    Нет

    Содержит результат обработки запроса в случае успеха.
    Может отсутствовать в случае ошибок доступа, некорректного JWT-токена в запросе.


    data

    массив объектов

    Да

    Содержит набор данных по идентификатору уникального случая КАС указанного в запросе идентификатора.

    Пустой в случае отсутствия в «ВИМИС АКиНЕО» идентификатора уникального случая КАС,  указанного в запросе.



    created_on

    строка

    Нет

    Дата генерации уникального идентификатора случая КАС.

    Формат:  yyyy-mm-ddThh:mm:ss+hh:mm

    Пример: 2022-11-11T10:39:30+00:00



    pref_year

    строка

    Нет

    Год случая КАС



    pref_subject

    строка

    Нет

    Регион нахождения медицинской организации



    numb

    число

    Нет

    Порядковый номер случая КАС



    oid

    строка

    Нет

    oid медицинской организации

    is_success

    логическое значение

    Да

    Статус обработки запроса

    errors

    массив

    строк

    Да

    Возникшие ошибки в случае неуспеха

    Получение маршрута пациента

    Данный метод предназначен для получения маршрута пациента с возможными нарушениями и отклонениями от клинических рекомендаций и порядков оказания медицинской помощи.

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/patientRoute

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

    Параметр

    Тип

    Обязательность

    Описание

    snils

    строка

    Да

    СНИЛС пациента в формате ххххххххххх

    mkb

    строка

    Нет

    Код диагноза пациента по справочнику МКБ-10

    vmcl

    числовой

    Нет

    Код направления ВИМИС

    nosology_code

    числовой

    Нет

    Код заболевания или состояния на контроле ВИМИС

    birth_date

    строка

    Нет

    Дата рождения пациента,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00

    gender_code

    числовой

    Нет

    Пол пациента

    child_number

    числовой

    Нет

    Порядковый номер новорождённого

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

    Параметр

    Тип

    Описание

    data

    объект

    Набор данных


    routes

    массив объектов

    Набор данных по маршрутам пациента

    Пустой массив в случае отсутствия маршрутов



    vmcl

    число

    код направления ВИМИС



    nosology_code

    число

    код заболевания или состояния на контроле ВИМИС



    nosology_name

    строка

    наименование заболевания или состояния на контроле ВИМИС



    graph_name

    строка

    наименование маршрута заболевания или состояния на контроле ВИМИС



    doc_number

    строка

    наименование документа, на основе которого построен маршрут пациента



    route

    строка

    Визуальное отображение маршрута в html с набором стилей, кодированное в формате base64



    route_type

    строка

    Тип маршрута: bpmn, brief



    occasion_begin_on

    строка

    Дата начала случая,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00



    occasion_end_on

    строка

    Дата окончания случая,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00



    occasion_patient_id

    число

    Идентификатор случая пациента



    birth_date

    строка

    Дата рождения пациента,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00



    gender_code

    число

    Пол пациента



    child_number

    число

    Порядковый номер новорождённого



    route_data

    объект

    Данные по маршруту




    stage_list

    массив объектов

    Список этапов





    stage_code

    строка

    Код (uuid) этапа эталонного графа





    stage_name

    строка

    Наименование этапа маршрута




    point_list

    массив объектов

    Список подэтапов





    mo_oid

    строка

    oid медицинской организации





    mo_name

    строка

    Наименование медицинской организации





    is_dead

    логическое значение

    Признак подэтапа, на котором умер пациент





    begin_on

    строка

    Дата начала подэтапа,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00





    week_num

    число

    Номер недели (актуально для маршрута беременной)





    route_num

    число

    Код маршрута (актуально для маршрута беременной)





    point_name

    строка

    Наименование подэтапа





    stage_code

    строка

    Код (uuid) этапа эталонного графа





    state_code

    строка

    Код (uuid) подэтапа эталонного графа





    is_current_point

    логическое значение

    Признак текущего этапа маршрута пациента





    deviation_count

    число

    Количество отклонений по подэтапу (всего, всех видов)





    cr_deviation_count

    число

    Количество отклонений по КР (всего)





    pgg_deviation_count

    число

    Количество отклонений по ПГГ (всего)





    pomp_deviation_count

    число

    Количество отклонений по порядку ОМП (всего)





    critical_deviation_count

    число

    Количество критичных отклонений (всего, всех видов)





    cr_critical_deviation_count

    число

    Количество критических отклонений по КР





    pgg_critical_deviation_count

    число

    Количество критичных отклонений по ПГГ





    pomp_critical_deviation_count

    число

    Количество критичных отклонений по порядку ОМП





    recommendation_date

    строка

    Дата анкетирования,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00





    recommendation_list

    массив объектов

    Список рекомендаций для подэтапа Анкетирование






    recommendation_text

    строка

    Текст рекомендации






    question_list

    массив объектов

    Список связанных вопросов анкеты







    question_code

    число

    Код вопроса по справочнику 1.2.643.5.1.13.13.99.2.801







    question_text

    строка

    Текст вопроса







    answer

    строка

    Текст ответа




    deviation_list

    массив объектов

    Список отклонений





    mo_oid

    строка

    oid медицинской организации





    mo_name

    строка

    Наименование медицинской организации





    stage_code

    строка

    Код (uuid) этапа эталонного графа





    state_code

    строка

    Код (uuid) подэтапа эталонного графа





    completed_on

    строка

    Дата отклонения,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00





    deviation_kind

    число

    Вид (источник) отклонения
    (1-Порядок ОМП, 2-ПГГ, 3-Клинические рекомендации, 4-Патология/важная информация)





    deviation_level

    число

    Уровень отклонения
    (0 - некритичное, 1 - критичное)





    warning_message

    строка

    Описание отклонения




    route_list

    массив объектов

    Список связанных маршрутов





    route_num

    число

    Код маршрута





    occasion_patient_id

    число

    Идентификатор случая пациента





    occasion_begin_on

    строка

    Дата начала случая,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00





    occasion_end_on

    строка

    Дата окончания случая,
    формат: yyyy-mm-ddThh:mm:ss+hh:mm
    Пример: 1987-11-10T00:00:00+00:00





    nosology_code

    число

    Код заболевания или состояния на контроле ВИМИС





    nosology_name

    строка

    Наименование заболевания или состояния на контроле ВИМИС

    is_success

    логическое значение

    Статус формирования ответа: true|false

    error

    строка

    Описание ошибок, если они возникли при формировании ответа

    ChecDO

    ИИС для определения необходимости уведомления о повторном заполнении анкетирования гражданина, ранее заполнившего анкету, может получить его статус обращения в медицинскую организацию. Для этого вызывается метод checkDO с параметром msg_id, присвоенным Платформой ВИМИС исходному запросу с протоколом анкетирования от ИИС.

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/checkKasNumber/CheckDO

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

    Параметры Наименование Тип
    msg_id Уникальный идентификатор, присвоенный исходному запросу, в ответ на метод sendDocument Строка

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

    Параметры Наименование Тип
    status

    Статус обращения в МО гражданина, ранее заполнившего анкету в ИИС

    Возможные значения:

    0 – нет данных об обращении в МО

    1 – есть записи об обращении в МО
    Число
    description

    Текстовое описание наличия записей об обращении в МО

    Строка

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

    {
      "msgId": "ed74677b-203c-4e79-9a05-743ac67f2688"
    }

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

    {
        "Status": 0,
        "Description": "Нет данных об обращении в МО"
    }

    Снятие статуса у пациента мониторинг ВИМИС

    В связи с наступлением отдельных событий и/или условий. Перечень событий/условий для каждого компонента ВИМИС представлены в справочнике 1.2.643.2.69.1.1.1.183

    В случае наступления представленных событий и/или условий в отношении пациентов, а также передачи в ВИМИС соответствующих СЭМД/СЭМД beta-версии статус – «МОНИТОРИНГ соответствующим Компонентом Платформы ВИМИС» для пациента должен быть снят.

    Метод

    Запрос предоставление номера осуществляется с помощью метода POST, в качестве адреса указывается URL в формате [base]/api/Vimis/checkKasNumber/$stopMonitoringPatient

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

    Параметр Наименование Тип Комментарий
    idPerson Идентификатор пациента MPI, по которым требуется убрать статус Мониторинг КВ string
    idCause Идентификатор причины прекращения мониторинга по справочнику 1.2.643.2.69.1.1.1.183 int При указании причины необходимо учитывать что, причины прекращения мониторинга делятся по нозологиям
    date Дата прекращения мониторинга date дата прекращения мониторинга не может быть ранее даты начала мониторинга

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

    Параметр Наименование

    Message

    Сообщение о статусе обработки входящего запроса

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

    {
      "idPerson": "383f09e7-a962-4418-8a2f-3f2c3b29f979",
      "idCause": "5",
      "date": "2023-12-19"
    }

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

    {
        "Message": [
            "Успешно снят КВ с IdVimisControl = [916] по нозологии [Akineo], по причине [5 - Наступление смерти пациента, подлежащего мониторингу в «ВИМИС АКиНЕО»]"
        ]
    }
    Наверх