СЗПВ

Описание решения

Общие положения

Сервис предназначен для предоставления электронной услуги «Запись на прием» и передачи данных в Федеральную электронную регистратуру, посредством информационного взаимодействия информационных систем через API Интеграционной платформы N3.Здравоохранение.

Клиентами Интеграционной платформы могут быть следующие информационные системы:

  1. Медицинская информационная система.
  2. Портал записи на прием.
  3. Рабочее место оператора Центра телефонного обслуживания (ЦТО).
  4. Мобильное приложение.

 

Сервисы Интеграционной платформы обеспечивают следующие возможности:

  1. Обмен данными о пациентах.
  2. Передачу данных о сотрудниках медицинских учреждений.
  3. Обмен данными о медицинских учреждениях и их ресурсах.
  4. Получение расписания работы специалистов медицинских учреждений, предварительной записи и отмены записи.
  5. Передачу информации о посещениях в медицинских учреждениях (реализуется со стороны МИС).
  6. Передачу информации в ФЭР федеральной ЕГИСЗ о расписании врачей и оказанных услугах.

 

В рамках оказания Услуги информационные системы взаимодействуют с Интеграционной платформой через стандартизированные интерфейсы для взаимодействия, реализованные в виде Web-сервисов, основанных на протоколе SOAP 1.1 и 1.2.

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

Описание методов, используемых в типовых решениях, приведено в разделе Описание протокола взаимодействия и методов.

ФЭР (в разделе Описание протокола взаимодействия и методов)

Для того, чтобы данные передавались в федеральную ЕГИСЗ необходимо выполнить следующие условия:

  1. Реализовать методы согласно API. Для работы МИС с модулем ФЭР требуются методы: CheckPatient, GetPositionList, GetDoctorList2, GetAvaibleAppointments, SetAppointment, CreateClaimForRefusal, SendNotificationAboutAppointment, SendNotificationAboutAppointmentStatus.
  2. ЛПУ должно быть внесено в единый регистр медицинских организаций;
  3. Врачи ЛПУ должны быть внесены в единый регистр медицинских работников).

 

Типовое решение для ЦТО

Отличия функциональности Типового решения для записи на прием через ЦТО от Типового решения для записи через Портал, Инфоматы и Мобильные приложения заключается в следующем:

  1. Используется нестрогая идентификация пациентов (для оператора предоставляется список пациентов, которые попадают под критерии поиска). Соответственно, для идентификации пациента используется другой метод – SearchTop10patient;
  2. В случае отсутствия пациента в базе данных целевой МИС при осуществлении записи на прием используется метод добавления пациента в МИС – AddNewPatient;
  3. Содержится возможность обновления номера телефона пациента (как мобильного, так и домашнего) – метод UpdatePhoneByIdPat;
  4. Присутствует возможность просмотра расписания врачей без оформления записи на прием, достигающаяся в Типовом решении для Порталов, Инфоматов и Мобильных приложений методом GetWorkingTime.

 

Аналогично Типовому решению для записи через Портал, Инфоматы и Мобильные приложения, целевым ЛПУ при получении запросов рекомендуется использовать метод «Определение пользователя по его GUID (GetHubUserByGuid)» для определения запрашивающей системы и получения сведений о ней (описание пользователя и его роль). С учетом полученных сведений целевая ЛПУ может управлять передаваемым результирующим списком, предоставляя запрашивающей системе только доступные для нее ресурсы (специальности, врачи, талоны и т.д.).

Схема Типового решения для ЦТО приведена на Рисунке 2.

Рисунок 2. Схема Типового процесса записи через ЦТО

Алгоритм тестирования системы передачи данных от ЛПУ

SoapUI это кроссплатформенное клиентское оконное приложение, написанное на языке Java. Использовать основной функционал приложения можно бесплатно. В платной версии программы, которая называется SoapUI Pro, вы сможете делать чуть больше, например, устанавливать плагины с помощью менеджера плагинов, проводить тесты драйверов данных, перехватывать трафик, оценивать покрытие ваших веб-сервисов тестами и создавать отчёты. Официальная страничка проекта находится по адресу https://www.soapui.org/, скачать дистрибутив бесплатной версии программы можно по адресу https://sourceforge.net/projects/soapui/files/. Если бесплатной версии вам не хватает, вы можете скачать пробную версию SoapUI Pro здесь https://www.soapui.org/downloads/download-soapui-pro-trial.html. Установка на компьютер под управлением Windows проходит быстро и обычно не вызывает вопросов.

Руководство по тестированию МИС для сервисов записи пациента и автоматизированного рабочего места оператора центра телефонного обслуживания

Для того, чтобы скачать тестовый файл необходимо кликнуть левой клавишей мыши на ссылку «Файл для проведения тестирования»

Инструкция по подключению ВОЗ

SoapUI это кроссплатформенное клиентское оконное приложение, написанное на языке Java. Использовать основной функционал приложения можно бесплатно. В платной версии программы, которая называется SoapUI Pro, вы сможете делать чуть больше, например, устанавливать плагины с помощью менеджера плагинов, проводить тесты драйверов данных, перехватывать трафик, оценивать покрытие ваших веб-сервисов тестами и создавать отчёты. Официальная страничка проекта находится по адресу https://www.soapui.org/, скачать дистрибутив бесплатной версии программы можно по адресу https://sourceforge.net/projects/soapui/files/. Если бесплатной версии вам не хватает, вы можете скачать пробную версию SoapUI Pro здесь https://www.soapui.org/downloads/download-soapui-pro-trial.html. Установка на компьютер под управлением Windows проходит быстро и обычно не вызывает вопросов.

Руководство по тестированию МИС для сервисов записи пациента и автоматизированного рабочего места оператора центра телефонного обслуживания

Для того, чтобы скачать тестовый файл необходимо кликнуть левой клавишей мыши на ссылку «Файл для проведения тестирования»

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

Для взаимодействия с сервисом Интеграционной платформы используется протокол SOAP 1.1 и 1.2. (cм. http://www.w3.org/TR/soap/).

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

Сервис «Запись на прием» содержит следующие методы:

  1. Выбор района (GetDistrictList).
  2. Выбор ЛПУ (GetLPUList).
  3. Идентификация пациента (CheckPatient).
  4. Выбор специальности (GetSpesialityList).
  5. Выбор врача (GetDoctorList).
  6. Выбор даты приема (GetAvailableDates).
  7. Выбор времени приема (GetAvaibleAppointments).
  8. Подтверждение записи (SetAppointment).
  9. Поиск пациента (SearchTop10patient).
  10. Добавление пациента в стороннюю МИС (AddNewPatient).
  11. Уточнение телефона пациента (UpdatePhoneByIdPat).
  12. Просмотр предстоящих записей пациента (GetPatientHistory).
  13. Подача заявки на отмену записи (CreateClaimForRefusal).
  14. Просмотр расписаний (без записи) (GetWorkingTime).
  15. Получение списка врачей, сгруппированных по специальности (GetDocListFullTree).
  16. Определение пользователя по его GUID (GetHubUserByGuid).
  17. Уведомление о записи на прием (SendNotificationAboutAppointment).
  18. Уведомление о изменении статуса записи на прием (SendNotificationAboutAppointmentStatus).
  19. Получение доступных врачей для записи пациента на прием (GetAvailableDoctors).
  20. Получение списка должностей (GetPositionList).
  21. Получение списка врачей по должности (GetDoctorList2).
  22. Получение списка услуг (GetServiceList).

 

В методах GetSpesialityList, GetDoctorList, GetAvailableDates и GetAvailableAppointments в рамках параметра IdPat возможно использование служебного идентификатора (-2147483647) для получения неотфильтрованных наборов данных (для определенных сценариев, таких как «получение справочной информации» или «синхронизация данных с ФЭР»). Значение этого параметра в указанных методах можно игнорировать, если МИС не ограничивает доступ к возвращаемым методами данным, например, в зависимости от прикрепления пациента к определенному врачебному участку и т.п.. Если МИС при прочих равных для разных пациентов может возвращать различные ответы в указанных методах — значение параметра необходимо обрабатывать, как «снятие фильтра по пациенту».

Обязательность параметров, используемых в запросах, указана в соответствующих таблицах. При этом используются следующие обозначения:

Параметр «Кратность» означает количество возможных значений реквизита:

 

Формат даты

Значения параметров методов, имеющих тип Datetime, необходимо передавать в формате UTC или с указанием таймзоны. Если таймзона не указана, то в рамках сервиса считается, что передано локальное время (региональное), и сервис работает с переданным значением как с «датой, для которой не указана таймзона».

Пример времени по Москве: 2021-01-18T12:20:12.2508719+03:00

Выбор района (GetDistrictList)

Данный метод используется для получения значений справочника «Районы» Интеграционной платформы.

Метод должен поддерживаться МИС в рамках типового решения «Запись на прием из одной МИС в другую».

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

Структура запроса GetDistrictList представлена на Рисунке 10.

Рисунок 10. Структура запроса метода GetDistrictList

В Таблице 3 представлено описание параметров запроса метода GetDistrictList.

Таблица 3 — Описание параметров запроса метода GetDistrictList.
Контейнер Параметры Обязательность Тип Описание
Root      
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetDistrictList представлена на Рисунке 11.

Рисунок 11. Структура ответа метода GetDistrictList

В Таблице 4 представлено описание выходных данных метода GetDistrictList.

Таблица 4 — Описание выходных данных метода GetDistrictList
Контейнер Параметры Тип Описание Возможные значения
/GetDistrictListResult/District      
/District DistrictName String Наименование района Значение наименования района из справочника «Районы» Интеграционной платформы
/District IdDistrict Int Идентификатор района Значение идентификатора из справочника «Районы» Интеграционной платформы
/District Okato Int Код ОКАТО района Значение кода ОКАТО района из справочника «Районы» Интеграционной платформы

Запрос

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

Ответ

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

Выбор ЛПУ (GetLPUList)

Данный метод используется для получения списка ЛПУ в районе, указанном в запросе. В запросе необходимо указать идентификатор района из справочника «Районы». Если идентификатор района не указан, то метод в выходных данных вернет полный список ЛПУ.

Метод должен поддерживаться МИС в рамках типового решения «Запись на прием из одной МИС в другую».

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

Структура запроса GetLPUList представлена на Рисунке 12.

Рисунок 12. Структура запроса метода GetLPUList

В Таблице 5 представлено описание параметров запроса метода GetLPUList.

Таблица 5 — Описание параметров запроса метода GetLPUList.
Контейнер Параметры Обязательность Тип Описание
Root      
/ IdDistrict 0..1 Int Идентификатор района из справочника «Районы» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetLPUList представлена на Рисунке 13.

Рисунок 13. Структура ответа метода GetLPUListResponse

В Таблице 6 представлено описание выходных данных метода GetLPUList.

Таблица 6 — Описание выходных данных метода GetLPUList.
Контейнер Параметры Тип Описание Возможные значения
/GetLPUListResult      
/GetLPUListResult IdHistory Int Идентификатор сессии (транзакции)  
/GetLPUListResult Success Boolean Результат выполнения запроса True; False
/GetLPUListResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetLPUListResult/ListLPU/Clinic      
/Clinic Description String Описание  
/Clinic District Int Идентификатор района Значение идентификатора из справочника «Районы» Интеграционной платформы
/Clinic IdLPU Int Идентификатор ЛПУ в справочнике Значение идентификатора ЛПУ в справочнике «ЛПУ» Интеграционной платформы
/Clinic LPUFullName String Юридическое наименование ЛПУ  
/Clinic LPUShortName String Аббревиатура (краткое наименование ЛПУ)  
/Clinic LPUType Int Тип ЛПУ Значение идентификатора из справочника «Тип ЛПУ» Приложение 3
/Clinic PartOf Int Идентификатор родительского ЛПУ Значение идентификатора родительского ЛПУ в справочнике «ЛПУ» Интеграционной платформы

Запрос

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

Ответ

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

Идентификация пациента (CheckPatient)

Данный метод используется для идентификации пациента в МИС ЛПУ.

Результаты выполнения запроса:

  • Если пациентов с заданными параметрами не найдено, то возвращается ошибка;
  • Если найдено более 1 пациента, то необходимо уточнить параметры запроса (например, если в запросе не было указано отчество пациента, то необходимо указать его);
  • Если найден 1 пациент, то метод возвращает идентификатор этого пациента из справочника МИС.

 

Идентификация пациента может производиться по следующим наборам параметров:

  • Фамилия, Имя, Дата рождения;
  • СНИЛС пациента, Дата рождения;
  • Номер полиса пациента, Дата рождения;
  • Номер полиса пациента;
  • Идентификатор пациента.

 

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

Структура запроса CheckPatient представлена на Рисунке 14.

Рисунок 14. Структура запроса метода CheckPatient

В Таблице 7 представлено описание параметров запроса метода CheckPatient.

Таблица 7 – Описание параметров запроса метода CheckPatient
Контейнер Параметры Обязательность Тип Описание
/pat      
/pat AriaNumber 0..1 String Номер врачебного участка в запрашивающей МИС
/pat Birthday 0..1 datetime Дата рождения
/pat CellPhone 0..1 String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)
/pat Document_N 0..1 String Номер документа
/pat Document_S 0..1 String Серия документа
/pat HomePhone 0..1 String Номер домашнего телефона (формат передачи: «XXXXXXX» – 7 знаков без разделителей)
/pat IdPat 0..1 String Идентификатор пациента
/pat Name 0..1 String Имя пациента
/pat Polis_N 0..1 String Номер полиса
/pat Polis_S 0..1 String Серия полиса
/pat SecondName 0..1 String Отчество пациента
/pat Snils 0..1 String СНИЛС пациента
/pat Surname 0..1 String Фамилия пациента
/pat Document_Type 0..1 String Идентификатор типа документа (в соответствии со справочником Классификатор документов, удостоверяющих личность гражданина Российской Федерации, OID 1.2.643.5.1.13.2.1.1.498)
/pat Gender 0..1 String Пол пациента (в соответствии с Классификатором половой принадлежности, OID 1.2.643.5.1.13.2.1.1.156)
/pat Polis_InsuranceCompany 0..1 String Страховая компания полиса ОМС
/pat Polis_IssueDate 0..1 datetime Дата выдачи страхового полиса ОМС
/pat PolisDMS_InsuranceCompany 0..1 String Страховая компания полиса ДМС
/pat PolisDMS_N 0..1 String Номер полиса ДМС
/pat PolisDMS_S 0..1 String Серия полиса ДМС
/pat PolisDMS_Validity 0..1 datetime Срок действия страхового полиса ДМС
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа CheckPatient представлена на Рисунке 15.

Рисунок 15. Структура ответа метода CheckPatient

В Таблице 8 представлено описание выходных данных метода CheckPatient.

Таблица 8 — Описание выходных данных метода CheckPatient
Контейнер Параметры Тип Описание Возможные значения
/CheckPatientResult      
/CheckPatientResult IdHistory Int Идентификатор сессии (транзакции)  
/CheckPatientResult Success Boolean Результат выполнения запроса True; False
/CheckPatientResult IdPat String Идентификатор пациента Значение идентификатора пациента из соответствующего справочника целевой МИС
/CheckPatientResult /ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Выбор специальности (GetSpesialityList)

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

Параметры CountFreeTicket и CountFreeParticipantIE ответа метода обнуляемые. При этом NULL означает отсутствие приема у врача (отпуск, больничный и т.д.). В противном случае, при отсутствии доступных талончиков, соответствующих параметру, должен передаваться «0».

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

Структура запроса GetSpesialityList представлена на Рисунке 16.

Рисунок 16. Структура запроса метода GetSpesialityList

В Таблице 9 представлено описание параметров запроса метода GetSpesialityList.

Таблица 9 – Описание параметров запроса метода GetSpesialityList
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetSpesialityList представлена на Рисунке 17.

Рисунок 17. Структура ответа метода GetSpesialityList

В Таблице 10 представлено описание выходных данных метода GetSpesialityList.

Таблица 10 — Описание выходных данных метода GetSpesialityList
Контейнер Параметры Тип Описание Возможные значения
/GetSpesialityListResult      
/GetSpesialityListResult IdHistory Int Идентификатор сессии (транзакции)  
/GetSpesialityListResult Success Boolean Результат выполнения запроса True; False
/GetSpesialityListResult LPUChanges String Информация об изменении в работе ЛПУ  
/GetSpesialityListResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetSpesialityListResult/ListSpesiality/Spesiality      
/Spesiality CountFreeParticipantIE Int Количество доступных участнику информационного обмена для записи талонов по врачебной специальности  
/Spesiality CountFreeTicket Int Общее количество свободных талонов по врачебной специальности  
/Spesiality FerIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике специальностей Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/Spesiality IdSpesiality String Идентификатор врачебной специальности Значение идентификатора врачебной специальности из соответствующего справочника целевой МИС
/Spesiality LastDate Datetime Дата приема по последнему свободному талону врачебной специальности  
/Spesiality NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности из соответствующего справочника целевой МИС
/Spesiality NearestDate Datetime Дата приема по ближайшему свободному талону врачебной специальности  

Запрос

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

Ответ

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

Выбор врача (GetDoctorList)

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

Параметры CountFreeTicket и CountFreeParticipantIE ответа метода обнуляемые. При этом NULL означает отсутствие приема у врача (отпуск, больничный и т.д.). В противном случае, при отсутствии доступных талончиков, соответствующих параметру, должен передаваться «0».

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

Структура запроса GetDoctorList представлена на Рисунке 18.

Рисунок 18. Структура запроса метода GetDoctorList

В Таблице 11 представлено описание параметров запроса метода GetDoctorList.

Таблица 11 – Описание параметров запроса метода GetDoctorList
Контейнер Параметры Обязательность Тип Описание
Root      
/ idSpesiality 1..1 String Идентификатор врачебной специальности в справочнике целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetDoctorList представлена на Рисунке 19.

Рисунок 19. Структура ответа метода GetDoctorList

В Таблице 12 представлено описание выходных данных метода GetDoctorList.

Таблица 12 — Описание выходных данных метода GetDoctorList
Контейнер Параметры Тип Описание Возможные значения
/GetDoctorListResult      
/GetDoctorListResult IdHistory Int Идентификатор сессии (транзакции)  
/GetDoctorListResult Success Boolean Результат выполнения запроса True; False
/GetDoctorListResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetDoctorListResult/Docs/Doctor      
/Doctor AriaNumber String Номер врачебного участка Значение идентификатора врачебного участка из соответствующего справочника целевой МИС
/Doctor Comment String Комментарий Дополнительная информация о враче (например, информация о причинах и сроках отсутствия приема врача)
/Doctor CountFreeParticipantIE Int Количество доступных участнику информационного обмена талонов для записи к врачу  
/Doctor CountFreeTicket Int Общее количество свободных талонов к врачу  
/Doctor IdDoc String Идентификатор врача в справочнике Значение идентификатора врача из соответствующего справочника целевой МИС
/Doctor LastDate Datetime Дата приема по последнему свободному талону к врачу  
/Doctor Name String ФИО врача (полностью) ФИО врача из соответствующего справочника целевой МИС
/Doctor NearestDate Datetime Дата приема по ближайшему свободному талону к врачу  
/Doctor Snils String СНИЛС врача СНИЛС врача из соответствующего справочника целевой МИС

Запрос

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

Ответ

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

Выбор даты (GetAvailableDates)

Данный метод используется для определения дат, на которые возможна запись к указанному в запросе врачу (возвращает даты, на которые есть, как минимум, один талон для записи), доступных для указанного в запросе пациента. Список дат, запись на которые доступна для пациента, определяется на стороне МИС ЛПУ.

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

Структура запроса GetAvailableDates представлена на Рисунке 20.

Рисунок 20. Структура запроса метода GetAvailableDates

В Таблице 13 представлено описание параметров запроса метода GetAvailableDates.

Таблица 13 – Описание параметров запроса метода GetAvailableDates
Контейнер Параметры Обязательность Тип Описание
Root      
/ idDoc 1..1 String Идентификатор врача в справочнике целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ visitStart 1..1 Datetime Дата начала диапазона поиска свободных дней для записи
/ visitEnd 1..1 Datetime Дата окончания диапазона поиска свободных дней для записи
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetAvailableDates представлена на Рисунке 21.

Рисунок 21. Структура ответа метода GetAvailableDates

В Таблице 14 представлено описание выходных данных метода GetAvailableDates.

Таблица 14 — Описание выходных данных метода GetAvailableDates
Контейнер Параметры Тип Описание Возможные значения
/GetAvailableDatesResult      
/GetAvailableDatesResult IdHistory Int Идентификатор сессии (транзакции)  
/GetAvailableDatesResult Success Boolean Результат выполнения запроса True; False
/GetAvailableDatesResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetAvailableDatesResult/AvailableDateList      
/AvailableDateList dateTime Datetime Даты, на которые есть свободные талоны для записи Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs

Запрос

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

Ответ

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

Выбор времени приема (GetAvaibleAppointments)

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

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

Структура запроса GetAvaibleAppointments представлена на Рисунке 22.

Рисунок 22. Структура запроса метода GetAvaibleAppointments

В Таблице 15 представлено описание параметров запроса метода GetAvaibleAppointments.

Таблица 15 – Описание параметров запроса метода GetAvaibleAppointments
Контейнер Параметры Обязательность Тип Описание
Root      
/ idDoc 1..1 String Идентификатор врача в справочнике целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ visitStart 1..1 Datetime Дата начала диапазона поиска свободных талонов
/ visitEnd 1..1 Datetime Дата окончания диапазона поиска свободных талонов
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetAvaibleAppointments представлена на Рисунке 23.

Рисунок 23. Структура ответа метода GetAvaibleAppointments

В Таблице 16 представлено описание выходных данных запроса метода GetAvaibleAppointments.

Таблица 16 — Описание выходных данных метода GetAvaibleAppointments
Контейнер Параметры Тип Описание Возможные значения
/GetAvailableAppointmentsResult      
/GetAvailableAppointmentsResult IdHistory Int Идентификатор сессии (транзакции)  
/GetAvailableAppointmentsResult Success Boolean Результат выполнения запроса True; False
/GetAvailableAppointmentsResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetAvailableAppointmentsResult/ListAppointments/Appointment      
/Appointment Address String Адрес приема врача Указывается адрес приема врача (место оказания услуги) в случае, если данный адрес отличается от адреса МО/подразделения МО
/Appointment IdAppointment String Идентификатор талона для записи Значение идентификатора талона на прием из соответствующего справочника целевой МИС
/Appointment Num Int Номер талона в очереди  
/Appointment Room String Номер кабинета Номер кабинета, где будет производиться врачебный прием
/Appointment VisitStart Datetime Дата и время начала приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs
/Appointment VisitEnd Datetime Дата и время окончания приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs

Запрос

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

Ответ

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

Подтверждение записи (SetAppointment)

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

Если в запросе метода заполнен параметр idAppointmentPrev, то осуществляется перенос даты и времени приема по ранее оформленной записи.

В случае, если запись осуществляется по направлению (заполнен параметр doctorsReferal), в запросе к целевой ЛПУ дополнительно передаются данные по направлению, полученные в сервисе УО.

На Рисунке 24 представлена схема информационного взаимодействия в случае оформления записи по направлению в рамках метода «Подтверждение записи (SetAppointment)».

Рисунок 24. Схема информационного взаимодействия в случае оформления записи по направлению в рамках метода «Подтверждение записи (SetAppointment)»

Описание схемы:

  1. Клиент СЗнП отправляет запрос метода «Подтверждение записи (SetAppointment)» в СЗнП. Состав параметров запроса представлен в Таблице 17.
  2. СЗнП отправляет запрос метода SearchOne в сервис УО для получения данных о направлении.
  3. УО передает ответ метода SearchOne в СЗнП с данными о направлении.
  4. В случае, если направление имеет статус 1, 2, 3, 4, 5 или 6 (по данным из шага 3), СЗнП отправляет запрос метода «Подтверждение записи (SetAppointment)» в целевое ЛПУ, определенное на шаге 3, с указанием данных о направлении, полученных в УО. Состав параметров запроса представлен в Таблице 17.
  5. Целевое ЛПУ передает ответ метода «Подтверждение записи (SetAppointment)» в СЗнП. Состав выходных данных ответа метода представлен в Таблица 18.
  6. СЗнП передает ответ метода «Подтверждение записи (SetAppointment)» клиенту СЗнП. Состав выходных данных ответа метода представлен в Таблица 18.

 

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

Структура запроса SetAppointment представлена Рисунке 25.

Рисунок 25. Структура запроса метода SetAppointment

В Таблице 17 представлено описание параметров запроса метода SetAppointment.

Таблица 17 – Описание параметров запроса метода SetAppointment
Контейнер Параметры Обязательность Тип Описание
Root      
/ idAppointment 1..1 String Идентификатор талона для записи из соответствующего справочника целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ doctorsReferal 0..1 String Номер направления
/ attachedReferral 0..1 XML-объект Объект SearchOneResponse сервиса УО ([base] /MqService.svc?wsdl). Наполняется при передаче запроса от СЗнП к поставщику данных
/ idAppointmentPrev 0..1 String Идентификатор талона записи на прием, по которой необходимо произвести перенос даты и времени (указывается идентификатор талона по существующей записи на прием)
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ CommentForAppointment 0..1 String Комментарий к записи (от клиента, оформляющего запись на прием)
/ ListService2/Service2 0..*    
/ IdService 1..1 String Идентификатор услуги
/ CommentForService 0..1 String Комментарий к услуге (от клиента, оформляющего запись на прием)

Описание выходных данных

Структура ответа SetAppointment представлена на Рисунке 26.

Рисунок 26. Структура ответа метода SetAppointment

В Таблице 18 представлено описание выходных данных запроса метода SetAppointment.

Таблица 18 — Описание выходных данных метода SetAppointment
Контейнер Параметры Тип Описание Возможные значения
/SetAppointmentsResult      
/SetAppointmentsResult IdHistory Int Идентификатор сессии (транзакции)  
/SetAppointmentsResult Success Boolean Результат выполнения запроса True; False
/SetAppointmentsResult Type String Тип специалиста, к которому записался пациент Значение справочника «Тип специалиста (врача)» Приложение 4
/SetAppointmentsResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Поиск пациента (SearchTop10patient)

Данный метод используется для поиска первых 10-ти пациентов, подходящих по введенным параметрам поиска.

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

Структура запроса SearchTop10Patient представлена на Рисунке 27.

Рисунок 27. Структура запроса метода SearchTop10Patient

В Таблице 19 представлено описание параметров запроса метода SearchTop10Patient.

Таблица 19 – Описание параметров запроса метода SearchTop10Patient
Контейнер Параметры Обязательность Тип Описание
/pat      
/pat AriaNumber 0..1 String Номер врачебного участка в запрашивающей МИС
/pat Birthday 0..1 datetime Дата рождения
/pat CellPhone 0..1 String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)
/pat Document_N 0..1 String Номер документа
/pat Document_S 0..1 String Серия документа
/pat IdPat 0..1 String Идентификатор пациента
/pat Name 0..1 String Имя пациента
/pat Polis_N 0..1 String Номер полиса ОМС
/pat Polis_S 0..1 String Серия полиса ОМС
/pat SecondName 0..1 String Отчество пациента
/pat Snils 0..1 String СНИЛС пациента
/pat Surname 0..1 String Фамилия пациента
/pat Document_Type 0..1 String Идентификатор типа документа (в соответствии со справочником Классификатор документов, удостоверяющих личность гражданина Российской Федерации, OID 1.2.643.5.1.13.2.1.1.498)
/pat Gender 0..1 String Пол пациента (в соответствии с Классификатором половой принадлежности, OID 1.2.643.5.1.13.2.1.1.156)
/pat Polis_InsuranceCompany 0..1 String Страховая компания полиса ОМС
/pat Polis_IssueDate 0..1 datetime Дата выдачи страхового полиса ОМС
/pat PolisDMS_InsuranceCompany 0..1 String Страховая компания полиса ДМС
/pat PolisDMS_N 0..1 String Номер полиса ДМС
/pat PolisDMS_S 0..1 String Серия полиса ДМС
/pat PolisDMS_Validity 0..1 datetime Срок действия страхового полиса ДМС
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа SearchTop10Patient представлена на Рисунке 28.

Рисунок 28. Структура ответа метода SearchTop10Patient

В Таблице 20 представлено описание выходных данных метода SearchTop10Patient.

Таблица 20 — Описание выходных данных метода SearchTop10Patient
Контейнер Параметры Тип Описание Возможные значения
/SearchTop10PatientResult      
/SearchTop10PatientResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/SearchTop10PatientResult IdHistory Int Идентификатор сессии (транзакции)  
/SearchTop10PatientResult Success Boolean Результат выполнения запроса True; False
/SearchTop10PatientResult/ListPatient/Patient      
/Patient AriaNumber String Номер врачебного участка Значение идентификатора врачебного участка из соответствующего справочника целевой МИС
/Patient Birthday datetime Дата рождения  
/Patient CellPhone String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)  
/Patient Document_N String Номер документа  
/Patient Document_S String Серия документа  
/Patient HomePhone String Номер домашнего телефона (формат передачи: «XXXXXXX» – 7 знаков без разделителей)  
/Patient IdPat String Идентификатор пациента Значение идентификатора пациента из соответствующего справочника целевой МИС
/Patient Name String Имя пациента  
/Patient Polis_N String Номер полиса ОМС  
/Patient Polis_S String Серия полиса ОМС  
/Patient SecondName String Отчество пациента  
/Patient Snils String СНИЛС пациента  
/Patient Surname String Фамилия пациента  
/Patient Document_Type String Тип документа  
/Patient Gender String Пол пациента  
/Patient PolisDMS_InsuranceCompany String Страховая компания полиса ДМС  
/Patient PolisDMS_N String Номер полиса ДМС  
/Patient PolisDMS_S String Серия полиса ДМС  
/Patient PolisDMS_Validity datetime Срок действия страхового полиса ДМС  
/Patient Polis_InsuranceCompany String Страховая компания полиса ОМС  
/Patient Polis_IssueDate datetime Дата выдачи страхового полиса ОМС  

Запрос

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

Ответ

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

Добавление пациента в стороннюю МИС (AddNewPatient)

Данный метод используется для добавления пациента в стороннюю МИС (в случае, если пациент отсутствует в базе данных МИС) при осуществлении записи на прием к врачу.

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

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

Структура запроса AddNewPatient представлена на Рисунке 29.

Рисунок 29. Структура запроса метода AddNewPatient

В Таблице 21 представлено описание параметров запроса метода AddNewPatient.

Таблица 21 – Описание параметров запроса метода AddNewPatient
Контейнер Параметры Обязательность/ кратность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ approvedByTfoms 0..1 boolean Прикреплен ли пациент к МО согласно сведениям ТФОМС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/patient 1..1   Информация о пациенте
/patient AriaNumber 0..1 String Номер врачебного участка в запрашивающей МИС
/patient Birthday 1..1 datetime Дата рождения
/patient CellPhone 0..1 String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)
/patient Document_N 0..1 String Номер документа
/patient Document_S 0..1 String Серия документа
/patient HomePhone 0..1 String Номер домашнего телефона (формат передачи: «XXXXXXX» – 7 знаков без разделителей)
/patient IdPat 0..1 String Идентификатор пациента
/patient Name 1..1 String Имя пациента
/patient Polis_N 0..1 String Номер полиса
/patient Polis_S 0..1 String Серия полиса
/patient SecondName 0..1 String Отчество пациента
/patient Snils 0..1 String СНИЛС пациента
/patient Surname 1..1 String Фамилия пациента
/patient Document_Type 0..1 String Идентификатор типа документа (в соответствии со справочником Классификатор документов, удостоверяющих личность гражданина Российской Федерации, OID 1.2.643.5.1.13.2.1.1.498)
/patient Gender 0..1 String Пол пациента (в соответствии с Классификатором половой принадлежности, OID 1.2.643.5.1.13.2.1.1.156)
/patient Polis_InsuranceCompany 0..1 String Страховая компания полиса ОМС
/patient Polis_IssueDate 0..1 datetime Дата выдачи страхового полиса ОМС
/patient PolisDMS_InsuranceCompany 0..1 String Страховая компания полиса ДМС
/patient PolisDMS_N 0..1 String Номер полиса ДМС
/patient PolisDMS_S 0..1 String Серия полиса ДМС
/patient PolisDMS_Validity 0..1 datetime Срок действия страхового полиса ДМС

Описание выходных данных

Структура ответа AddNewPatient представлена на Рисунке 30.

Рисунок 30. Структура ответа метода AddNewPatientResponse

В Таблице 22 представлено описание выходных данных метода AddNewPatient.

Таблица 22 — Описание выходных данных метода AddNewPatient
Контейнер Выходные данные Тип Описание Возможные значения
/AddNewPatientResult      
/AddNewPatientResult IdHistory Int Идентификатор сессии (транзакции)  
/AddNewPatientResult Success Boolean Результат выполнения запроса True; False
/AddNewPatientResult IdPat String Идентификатор пациента Значение идентификатора пациента из соответствующего справочника целевой МИС
/AddNewPatientResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Передача в МИС номера телефона пациента (UpdatePhoneByIdPat)

Данный метод используется для обновления номера телефона пациента на основании его идентификатора. Этот метод использует ЦТО, когда операторы обновляют телефонный номер (домашний или мобильный) пациента в базе на основе того, с которого пациент позвонил (предварительно спросив его, со своего ли номера звонит пациент).

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

Структура запроса UpdatePhoneByIdPat представлена Рисунке 31.

Рисунок 31. Структура запроса метода UpdatePhoneByIdPat

В Таблице 23 представлено описание параметров запроса метода UpdatePhoneByIdPat.

Таблица 23 – Описание параметров запроса метода UpdatePhoneByIdPat
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника МИС
/ homePhone 0..1 String Номер домашнего телефона (формат передачи: «XXXXXXX» – 7 знаков без разделителей)
/ cellPhone 0..1 String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа UpdatePhoneByIdPat представлена на Рисунке 32.

Рисунок 32. Структура ответа метода UpdatePhoneByIdPat

В Таблице 24 представлено описание выходных данных метода UpdatePhoneByIdPat.

Таблица 24 — Описание выходных данных метода UpdatePhoneByIdPat
Контейнер Параметры Тип Описание Возможные значения
/UpdatePhoneByIdPatResult      
/UpdatePhoneByIdPatResult IdHistory Int Идентификатор сессии (транзакции)  
/UpdatePhoneByIdPatResult Success Boolean Результат выполнения запроса True; False
/UpdatePhoneByIdPatResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Просмотр предстоящих записей пациента (GetPatientHistory)

Данный метод используется для получения списка записей пациента на прием и отказов от записи на прием в указанном в запросе ЛПУ, даты по которым еще не наступили.

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

Структура запроса GetPatientHistory представлена Рисунке 33.

Рисунок 33. Структура запроса метода GetPatientHistory

В Таблице 25 представлено описание параметров запроса метода GetPatientHistory.

Таблица 25 – Описание параметров запроса метода GetPatientHistory
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetPatientHistory представлена на Рисунке 34.

Рисунок 34. Структура ответа метода GetPatientHistory

В Таблице 26 представлено описание выходных данных метода GetPatientHistory.

Таблица 26 — Описание выходных данных метода GetPatientHistory
Контейнер Параметры Тип Описание Возможные значения
/GetPatientHistoryResult      
/GetPatientHistoryResult IdHistory Int Идентификатор сессии (транзакции)  
/GetPatientHistoryResult Success Boolean Результат выполнения запроса True; False
/GetPatientHistoryResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetPatientHistoryResult
/ListHistoryRefusal/HistoryRefusal
  Информация о записях на прием к врачу, по которым произведен отказ  
/HistoryRefusal DateCreatedAppointment datetime Дата создания записи на прием  
/HistoryRefusal IdAppointment String Идентификатор талона на запись Идентификатор талона для записи из соответствующего справочника МИС
/HistoryRefusal VisitStart datetime Дата начала приема  
/GetPatientHistoryResult/ListHistoryRefusal
/HistoryRefusal/DoctorBringReferal
  Информация о враче, направившем на прием  
/DoctorBringReferal AriaNumber String Номер врачебного участка  
/DoctorBringReferal IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorBringReferal Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryRefusal
/HistoryRefusal/DoctorRendingConsultation
  Информация о враче, к которому произведена запись на прием  
/DoctorRendingConsultation AriaNumber String Номер врачебного участка  
/DoctorRendingConsultation IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorRendingConsultation Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryRefusal
/HistoryRefusal/SpecialityBringReferal
  Информация о специальности врача, направившего на прием  
/SpecialityBringReferal FerIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/SpecialityBringReferal IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityBringReferal NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryRefusal
/HistoryRefusal/SpecialityRendingConsultation
  Информация о специальности врача, к которому произведена запись на прием  
/SpecialityRendingConsultation FerIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/SpecialityRendingConsultation IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityRendingConsultation NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryRefusal
/HistoryRefusal/UserCreatedAppointment
  Информация о пользователе, записавшем на прием  
/UserCreatedAppointment UserName String Пользователь, записавший на прием  
/UserCreatedAppointment UserPosition String Роль пользователя, записавшего на прием Значение справочника «Роль пользователя» Приложение 5
/GetPatientHistoryResult
/ListHistoryVisit/HistoryVisit
  Информация об актуальных предстоящих записях пациента на прием  
/HistoryVisit DateCreatedAppointment datetime Дата создания записи на прием  
/HistoryVisit IdAppointment String Идентификатор талона на запись Идентификатор талона для записи из соответствующего справочника МИС
/HistoryVisit VisitStart datetime Дата начала приема  
/GetPatientHistoryResult/ListHistoryVisit
/HistoryVisit/DoctorBringReferal
  Информация о враче, направившем на прием  
/DoctorBringReferal AriaNumber String Номер врачебного участка  
/DoctorBringReferal IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorBringReferal Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryVisit
/HistoryVisit/DoctorRendingConsultation
  Информация о враче, к которому произведена запись на прием  
/DoctorRendingConsultation AriaNumber String Номер врачебного участка  
/DoctorRendingConsultation IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorRendingConsultation Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryVisit
/HistoryVisit/SpecialityBringReferal
  Информация о специальности врача, направившего на прием  
/SpecialityBringReferal FerIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/SpecialityBringReferal IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityBringReferal NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryVisit
/HistoryVisit/SpecialityRendingConsultation
  Информация о специальности врача, к которому произведена запись на прием  
/SpecialityRendingConsultation FerIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/SpecialityRendingConsultation IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityRendingConsultation NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryVisit
/HistoryVisit/UserCreatedAppointment
  Информация о пользователе, записавшем на прием  
/UserCreatedAppointment UserName String Пользователь, записавший на прием  
/UserCreatedAppointment UserPosition String Роль пользователя, записавшего на прием Значение справочника «Роль пользователя» Приложение 5

Запрос

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

Ответ

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

Подача заявки на отмену записи (CreateClaimForRefusal)

Данный метод позволяет создавать заявки на отмену записи на прием. Используется в типовом решении для записи на прием через ЦТО.

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

Структура запроса CreateClaimForRefusal представлена на Рисунке 35.

Рисунок 35. Структура запроса метода CreateClaimForRefusal

В Таблице 27 представлено описание параметров запроса метода CreateClaimForRefusal.

Таблица 27 – Описание параметров запроса метода CreateClaimForRefusal
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ IdAppointment 1..1 String Идентификатор талона для записи из соответствующего справочника МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа CreateClaimForRefusal представлена на Рисунке 36.

Рисунок 36. Структура ответа метода CreateClaimForRefusal

В Таблице 28 представлено описание выходных данных метода CreateClaimForRefusal.

Таблица 28 — Описание выходных данных метода GetPatientHistory
Контейнер Параметры Тип Описание Возможные значения
/CreateClaimForRefusalResult      
/CreateClaimForRefusalResult IdHistory Int Идентификатор сессии (транзакции)  
/CreateClaimForRefusalResult Success Boolean Результат выполнения запроса True; False
/CreateClaimForRefusalResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Просмотр расписаний (без записи) (GetWorkingTime)

Данный метод используется для получения информации о времени работы врача (возвращает часы приема врача), идентификатор которого указан в запросе.

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

Структура запроса GetWorkingTime представлена на Рисунке 37.

Рисунок 37. Структура запроса метода GetWorkingTime

В Таблице 29 представлено описание параметров запроса метода GetWorkingTime.

Таблица 29 – Описание параметров запроса метода GetWorkingTime
Контейнер Параметры Обязательность Тип Описание
Root      
/ idDoc 1..1 String Идентификатор врача в справочнике целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ visitStart 1..1 Datetime Дата начала диапазона поиска для получения информации о расписании
/ visitEnd 1..1 Datetime Дата окончания диапазона поиска для получения информации о расписании
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetWorkingTime представлена на Рисунке 38.

Рисунок 38. Структура ответа метода GetWorkingTime

В Таблице 30 представлено описание выходных данных метода GetWorkingTime.

Таблица 30 — Описание выходных данных метода GetWorkingTime
Контейнер Параметры Тип Описание Возможные значения
/GetWorkingTimeResult      
/GetWorkingTimeResult IdHistory Int Идентификатор сессии (транзакции)  
/GetWorkingTimeResult Success Boolean Результат выполнения запроса True; False
/GetWorkingTimeResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetWorkingTimeResult/WorkingTimeList/WorkingTime      
/WorkingTime DenyCause String Описание причины отсутствия записи Обычный текст. Наполнение определяется на стороне МИС. Максимальное количество символов- 50.
/WorkingTime RecordableDay Boolean Возможна ли запись на прием True; False
/WorkingTime VisitStart Datetime Дата и время начала приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs
/WorkingTime VisitEnd Datetime Дата и время окончания приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs

Запрос

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

Ответ

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

Получение списка врачей, сгруппированных по специальности (GetDocListFullTree)

Данный метод используется для получения списков врачей по каждой специальности запрашиваемого ЛПУ и возвращает двухуровневый объект. Первый уровень – список врачебных специальностей ЛПУ, второй уровень – список врачей по каждой специальности ЛПУ.

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

Структура запроса GetDocListFullTree представлена Рисунке 42.

Рисунок 42. Структура запроса метода GetDocListFullTree

В Таблице 33 представлено описание параметров запроса метода GetDocListFullTree.

Таблица 33 – Описание параметров запроса метода GetDocListFullTree
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetDocListFullTree представлена на Рисунке 41.

Рисунок 41. Структура ответа метода GetDocListFullTree

В Таблице 34 представлено описание выходных данных метода GetDocListFullTree.

Таблица 34 — Описание выходных данных метода GetDocListFullTree
Контейнер Параметры Тип Описание Возможные значения
/GetDocListFullTreeResult      
/GetDocListFullTreeResult IdHistory Int Идентификатор сессии (транзакции)  
/GetDocListFullTreeResult Success Boolean Результат выполнения запроса True; False
/GetDocListFullTreeResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetDocListFullTreeResult/ListDoctor/Essence      
/Essence Description String Комментарий Указывается важная информация для осуществления записи на прием к врачам данной специальности
/Essence IdEssence String Идентификатор врачебной специальности в МИС Значение идентификатора врачебной специальности в справочнике целевой МИС
/Essence NameEssence String Наименование врачебной специальности Значение наименования врачебной специальности в справочнике целевой МИС
/GetDocListFullTreeResult/ListDoctor/Essence
/ListEssence/Essence
     
/Essence Description String Комментарий Указывается важная информация для осуществления записи на прием к данному врачу. Для участковых врачей обязательно указывать врачебные участки, по которым осуществляется прием
/Essence IdEssence String Идентификатор врача в МИС Значение идентификатора врача в справочнике целевой МИС
/Essence NameEssence String ФИО врача  

Запрос

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

Ответ

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

Определение пользователя по его GUID (GetHubUserByGuid)

Данный метод используется для получения информации о пользователе по его GUID. Если в запросе GUID пользователя не указан, то выводится весь список пользователей.

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

Структура запроса GetHubUserByGuid представлена на Рисунке 44.

Рисунок 44. Структура запроса метода GetHubUserByGuid

В Таблице 35 представлено описание параметров запроса метода GetHubUserByGuid.

Таблица 35 – Описание параметров запроса метода GetHubUserByGuid
Контейнер Параметры Обязательность Тип Описание
Root      
/ usersGuid 0..1 GUID GUID пользователя
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetHubUserByGuid представлена на Рисунке 45.

Рисунок 45. Структура ответа метода GetHubUserByGuid

В Таблице 36 представлено описание выходных данных метода GetHubUserByGuid.

Таблица 36 — Описание выходных данных метода GetHubUserByGuid
Контейнер Параметры Тип Описание Возможные значения
/GetHubUserByGuidResult      
/GetHubUserByGuidResult IdHistory Int Идентификатор сессии (транзакции)  
/GetHubUserByGuidResult Success Boolean Результат выполнения запроса True; False
/GetHubUserByGuidResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/GetDocListFullTreeResult/HubUserList/HubUser      
/HubUser UserName String ФИО пользователя  
/HubUser UserPosition String Роль пользователя Значение справочника «Роль пользователя» Приложение 5
/HubUser IdDistrict Int Идентификатор района Значение идентификатора из справочника «Районы» Интеграционной платформы
/HubUser PublicGuid GUID GUID пользователя  

Запрос

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

Ответ

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

Уведомление о записи на прием (SendNotificationAboutAppointment)

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

Предполагаются 2 сценария использования метода:

  1. Передача уведомлений «онлайн» (единовременно по наступлении события) о произведенной записи на прием. В этом случае данные передаются в контейнере Appointment.
  2. Передача уведомлений о произведенных записях на прием «постфактум». Данные передаются в контейнере NoticeAppointment.

 

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

Структура запроса SendNotificationAboutAppointment представлена на Рисунке 46.

Рисунок 46. Структура запроса SendNotificationAboutAppointment

В Таблице 37 представлено описание параметров запроса метода SendNotificationAboutAppointment.

Таблица 37 — Описание параметров запроса метода SendNotificationAboutAppointment.
Контейнер Параметры Условие Обязательность/ кратность Тип Описание
Root        
/ idLpu   1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid   1..1 GUID Авторизационный токен
/ idHistory   0..1 Int Идентификатор сессии (транзакции)
/ doctorsReferal   0..1 String Номер направления или номер заявки ЖОЗ
/ appointmentSource   1..1 String Источник записи. Значения Приложение 7
/ member Для значения «Прочее» об источнике записи 1..1 GUID Участник информационного взаимодействия, осуществивший запись
Для остальных значений об источнике записи 0..1
/ fedIdPosition   1..1 String Идентификатор врачебной должности в федеральном справочнике должностей (ФРМР. Должности медицинского персонала (OID 1.2.643.5.1.13.13.11.1102))
Должно соответствовать коду должности, расположенной в папках:

  • «Должности работников медицинских организаций» -> «Должности медицинских работников» -> «Должности специалистов с высшим профессиональным (медицинским) образованием (врачи)» -> «врачи-специалисты»

  • «Должности работников медицинских организаций» -> «Должности медицинских работников» -> «Должности специалистов со средним профессиональным (медицинским) образованием (средний медицинский персонал)»

Пример: 13

/doctor        
/doctor AriaNumber   0..1 String Номер врачебного участка
/doctor Comment   0..1 String Дополнительная информация о враче (например, информация о причинах и сроках отсутствия приема врача)
/doctor CountFreeParticipantIE   0..1 Int Количество доступных участнику информационного обмена талонов для записи к врачу
/doctor CountFreeTicket   0..1 Int Общее количество свободных талонов к врачу
/doctor IdDoc   1..1 String Идентификатор врача в соответствующем справочнике МИС
/doctor LastDate   0..1 Datetime Дата приема по последнему свободному талону к врачу
/doctor Name   1..1 String ФИО врача
/doctor NearestDate   0..1 Datetime Дата приема по ближайшему свободному талону к врачу
/doctor Snils   1..1 String СНИЛС врача
/spesiality        
/spesiality CountFreeParticipantIE   0..1 Int Количество доступных участнику информационного обмена для записи талонов по врачебной специальности
/spesiality CountFreeTicket   0..1 Int Общее количество свободных талонов по врачебной специальности
/spesiality FerIdSpesiality   1..1 String Идентификатор специальности в справочнике ФЭР
/spesiality IdSpesiality   1..1 String Идентификатор врачебной специальности в справочнике МИС
/spesiality LastDate   0..1 Datetime Дата приема по последнему свободному талону врачебной специальности
/spesiality NameSpesiality   1..1 String Наименование врачебной специальности в справочнике МИС
/spesiality NearestDate   0..1 Datetime Дата приема по ближайшему свободному талону врачебной специальности
/patient        
/patient AriaNumber   0..1 String Номер врачебного участка
/patient Birthday   1..1 dateTime Дата рождения пациента
/patient CellPhone   0..1 String Номер мобильного телефона (формат передачи: «XXXXXXXXXX» – 10 знаков без разделителей)
/patient HomePhone   0..1 String Номер домашнего телефона (формат передачи: «XXXXXXX» – 7 знаков без разделителей)
/patient Document_S   0..1 String Серия паспорта
/patient Document_N   0..1 String Номер паспорта
/patient IdPat   1..1 String Идентификатор пациента из соответствующего справочника МИС
/patient Name   1..1 String Имя пациента
/patient Surname   1..1 String Фамилия пациента
/patient SecondName   0..1 String Отчество пациента
/patient Polis_S   0..1 String Серия полиса
/patient Polis_N   0..1 String Номер полиса
/patient Snils   0..1 String СНИЛС полиса
/Аppointment При передаче уведомлений «онлайн» 1..1  
  При передаче уведомлений «постфактум» 0..0  
/Аppointment Address   0..1 String Указывается адрес приема врача (место оказания услуги) в случае, если данный адрес отличается от адреса МО/подразделения МО
/Аppointment IdAppointment   1..1 String Идентификатор талона для записи из соответствующего справочника МИС.
Значение идентификатора талона должно быть уникальным в рамках МИС МО
/Аppointment Num   0..1 Int Номер талона в очереди
/Аppointment Room   0..1 String Номер кабинета, где будет производиться врачебный прием
/Аppointment VisitStart   1..1 dateTime Начало приема.
Дата начала приема должна быть больше
или равна дате отправки запроса. Дата и время начала приема должна быть меньше
или равна дате и времени окончания приема
/Аppointment VisitEnd   1..1 dateTime Окончание приема
/NoticeAppointment При передаче уведомлений «онлайн» 0..0  
  При передаче уведомлений «постфактум» 1..1  
/NoticeAppointment Address   0..1 String Указывается адрес приема врача (место оказания услуги) в случае, если данный адрес отличается от адреса МО/подразделения МО
/NoticeAppointment IdAppointment   1..1 String Идентификатор талона для записи из соответствующего справочника МИС
/NoticeAppointment Num   0..1 Int Номер талона в очереди
/NoticeAppointment Room   0..1 String Номер кабинета, где будет производиться врачебный прием
/NoticeAppointment VisitStart   1..1 dateTime Начало приема
/NoticeAppointment VisitEnd   1..1 dateTime Окончание приема
/NoticeAppointment EventDateTime   1..1 dateTime Дата осуществления записи на прием.
Дата осуществления записи на прием должна быть меньше или равна Дате начала приема.
Дата осуществления записи на прием должна быть меньше или равна дате отправки запроса.

Описание выходных данных

Структура ответа SendNotificationAboutAppointment представлена на Рисунке 47.

Рисунок 47. Структура ответа метода SendNotificationAboutAppointment

В Таблице 38 представлено описание выходных данных метода SendNotificationAboutAppointment.

Таблица 38 — Описание выходных данных метода SendNotificationAboutAppointment
Контейнер Параметры Тип Описание Возможные значения
/SendNotificationAboutAppointmentResult      
/SendNotificationAboutAppointmentResult IdHistory Int Идентификатор сессии (транзакции)  
/SendNotificationAboutAppointmentResult Success Boolean Результат выполнения запроса True; False
/SendNotificationAboutAppointmentResult IdNotification Long Идентификатор уведомления о записи  
/SendNotificationAboutAppointmentResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Уведомление о изменении статуса записи на прием (SendNotificationAboutAppointmentStatus)

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

Предполагается следующий сценарий использования метода:

  1. МИС передает сведения в Интеграционную платформу, обо всех записях на прием, путем вызова метода SendNotificationAboutAppointment для каждой записи.
  2. Интеграционная платформа присваивает идентификатор уведомлению и возвращает его в ответе метода SendNotificationAboutAppointment.
  3. МИС сохраняет полученный идентификатор уведомления для последующего использования.
  4. После изменения статуса для записи на прием, МИС передает сведения о статусе записи, по уже известному идентификатору уведомления, путем вызова метода SendNotificationAboutAppoinmentStatus для каждой записи.
  5. В случае, если у МИС нет возможности сохранения идентификатора уведомления, после изменения статуса для записи на прием МИС передает сведения о статусе записи путем вызова метода SendNotificationAboutAppoinmentStatus для каждой записи с указанием параметров idLpu, idPat, idAppointment и doctorsReferral (игнорируя idNotification).
  6. Вариант с передачей в запросе параметра idNotification (идентификатор уведомления) является предпочтительным.

 

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

Структура запроса SendNotificationAboutAppointmentStatus представлена на Рисунке 48.

Рисунок 48. Структура запроса метода SendNotificationAboutAppointmentStatus

В Таблице 39 представлено описание параметров запроса метода SendNotificationAboutAppointmentStatus.

Таблица 39 — Описание параметров запроса метода SendNotificationAboutAppointmentStatus.
Контейнер Параметры Условие Обязательность/ кратность Тип Описание
Root        
/ idNotification Параметр заполняется, если в запросе не переданы параметры idLpu, IdPat, IdAppointment и doctorsReferral 0..1 Long Идентификатор уведомления о записи
/ idLpu Параметр заполняется, если в запросе не передан параметр idNotification 0..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat Параметр заполняется, если в запросе не передан параметр idNotification 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ idAppointment Параметр заполняется, если в запросе не передан параметр idNotification 0..1 String Идентификатор талона из соответствующего справочника целевой МИС
/ doctorsReferral Параметр заполняется, если в запросе не передан параметр idNotification и данная запись на прием была произведена по направлению/заявке ЖОЗ 0..1 String Номер направления или номер заявки ЖОЗ
/ status   1..1 String Итоговое состояние записи Приложение 8
/ EventDateTime   1..1 dateTime Дата изменения статуса записи на прием. Дата и время изменения статуса записи на прием должна быть больше или равна дате и времени осуществления записи на прием. Дата и время изменения статуса записи на прием должна быть меньше или равна дате и времени отправки запроса.
/ guid   1..1 GUID Авторизационный токен
/ idHistory   0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа SendNotificationAboutAppointmentStatus представлена на Рисунке 49.

Рисунок 49. Структура ответа метода SendNotificationAboutAppointmentStatus

В Таблице 40 представлено описание выходных данных метода SendNotificationAboutAppointmentStatus.

Таблица 40 — Описание выходных данных метода SendNotificationAboutAppointmentStatus
Контейнер Параметры Тип Описание Возможные значения
/SendNotificationAboutAppointmentStatusResult      
/SendNotificationAboutAppointmentStatusResult IdHistory Int Идентификатор сессии (транзакции)  
/SendNotificationAboutAppointmentStatusResult Success Boolean Результат выполнения запроса True; False
/SendNotificationAboutAppointmentStatusResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

Получение доступных врачей для записи пациента на прием (GetAvailableDoctors)

Метод «Получение доступных врачей для записи пациента на прием (GetAvailableDoctors)» используется для получения от целевого ЛПУ массива специальностей и врачей, доступных для обслуживания пациента, идентификатор которого вводится в запрос метода.

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

Структура запроса GetAvailableDoctors представлена на Рисунке 57.

Рисунок 57. Структура запроса метода GetAvailableDoctors

В Таблице 46 представлено описание параметров запроса метода GetAvailableDoctors.

Таблица 46 — Описание параметров запроса метода GetAvailableDoctors
Контейнер Параметры Условие Обязательность/кратность Тип Описание
Root        
/ idLpu   1..1 String Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat   1..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ idSpeciality Если в запросе указывается параметр idSpeciality, параметр ferIdSpeciality в запросе передаваться не должен 0..1 String Идентификатор врачебной специальности в справочнике целевой МИС
/ ferIdSpeciality Если в запросе указывается параметр ferIdSpeciality, параметр idSpeciality в запросе передаваться не должен 0..1 String Идентификатор врачебной специальности в федеральном справочнике специальностей (Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181))
/ guid   1..1 GUID Авторизационный токен
/ idHistory   0..1 Int Идентификатор сессии (транзакции)
/ PaymentType   0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetAvailableDoctors представлена на Рисунке 58.

Рисунок 58. Структура ответа метода GetAvailableDoctors

В Таблице 47 представлено описание выходных данных метода GetAvailableDoctors.

Таблица 47 — Описание выходных данных метода GetAvailableDoctors
Контейнер Выходные данные Обязательность/кратность Тип Описание Возможные значения
/GetAvailableDoctorsResult      
/GetAvailableDoctorsResult IdHistory 0..1 Int Идентификатор сессии (транзакции)  
/GetAvailableDoctorsResult Success 1..1 Boolean Результат выполнения запроса True; False
/GetAvailableDoctorsResult Comment 0..1 String Комментарий Дополнительная информация для пациента по оформлению записи; до 50 символов
/GetAvailableDoctorsResult/ErrorList/Error   0..*    
/Error ErrorDescription 1..1 String Текстовое описание ошибки Коды ошибок
/Error IdError 1..1 Int Идентификатор ошибки в справочнике Коды ошибок
/GetAvailableDoctorsResult/ListSpeciality/Speciality3   0..*    
/Speciality3 Comment 0..1 String Комментарий Дополнительная информация о специальности (до 50 символов)
/Speciality3 CountFreeParticipantIE 1..1 Int Количество доступных участнику информационного обмена для записи талонов по врачебной специальности  
/Speciality3 CountFreeTicket 1..1 Int Общее количество свободных талонов к врачу  
/Speciality3 FerIdSpeciality 1..1 String Идентификатор врачебной специальности в федеральном справочнике специальностей Номенклатура специальностей специалистов с высшим и послевузовским медицинским и фармацевтическим образованием в сфере здравоохранения (OID 1.2.643.5.1.13.2.1.1.181)
/Speciality3 IdSpeciality 1..1 String Идентификатор врачебной специальности Значение идентификатора врачебной специальности из соответствующего справочника целевой МИС
/Speciality3 LastDate 1..1 Datetime Дата приема по последнему свободному талону врачебной специальности  
/Speciality3 NameSpeciality 1..1 String Наименование врачебной специальности Наименование врачебной специальности из соответствующего справочника целевой МИС
/Speciality3 NearestDate 1..1 Datetime Дата приема по ближайшему свободному талону врачебной специальности  
/GetAvailableDoctorsResult/ListSpeciality/Speciality3/Docs/Doctor3   0..*    
/Doctor3 Area 0..1 String Полное наименование врачебного участка (включая номер врачебного участка и необходимые дополнительные указания и комментарии)  
/Doctor3 AreaType 0..1 String Вид врачебного участка Указывается одно значение из следующих возможных:

  • Фельдшерский
  • Терапевтический
  • Врача общей практики (семейного врача)
  • Комплексный
  • Акушерский
  • Приписной
  • Педиатрический
  • Фтизиатрический
/Doctor3 Comment 0..1 String Комментарий Дополнительная информация о враче (например, информация о причинах и сроках отсутствия приема врача); до 50 символов
/Doctor3 CountFreeParticipantIE 1..1 Int Количество доступных участнику информационного обмена талонов для записи к врачу  
/Doctor3 CountFreeTicket 1..1 Int Общее количество свободных талонов к врачу  
/Doctor3 IdDoc 1..1 String Идентификатор врача в справочнике Значение идентификатора врача из соответствующего справочника целевой МИС
/Doctor3 LastDate 1..1 Datetime Дата приема по последнему свободному талону к врачу  
/Doctor3 Name 1..1 String ФИО врача (полностью) ФИО врача из соответствующего справочника целевой МИС
/Doctor3 NearestDate 1..1 Datetime Дата приема по ближайшему свободному талону к врачу  
/Doctor3 Snils 1..1 String СНИЛС врача СНИЛС врача из соответствующего справочника целевой МИС (формат передачи: «XXXXXXXXXXX»)

Запрос

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

Ответ

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

Получение списка должностей (GetPositionList)

Метод «Получение списка должностей (GetPositionList)» используется для получения от целевого ЛПУ перечня врачебных должностей, запись к врачам которых доступна для пациента, идентификатор которого вводится в запрос метода. Список должностей, к врачам которых для пациента доступна запись, определяется на стороне МИС ЛПУ.

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

Структура запроса GetPositionList представлена на Рисунке 75

Рисунок 75. Структура запроса метода GetPositionList

В Таблице 61 представлено описание параметров запроса метода GetPositionList.

Таблица 61 — Описание параметров запроса метода GetPositionList
Контейнер Параметры Обязательность/ кратность Тип Описание
Root      
/ idLpu 1..1 String Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/ PaymentType 0..1 String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetPositionList представлена на Рисунке 76.

Рисунок 76. Структура ответа метода GetPositionList

В Таблице 62 представлено описание выходных данных метода GetPositionList.

Таблица 62 — Описание выходных данных метода GetPositionList
Контейнер Выходные данные Обязательность/Кратность Тип Описание Возможные значения
/GetPositionListResult        
/GetPositionListResult IdHistory 0..1 Int Идентификатор сессии (транзакции)  
/GetPositionListResult Success 1..1 Boolean Результат выполнения запроса True; False
/GetPositionListResult Comment 0..1 String Комментарий Дополнительная информация для пациента по оформлению записи; до 50 символов
/GetPositionListResult/ErrorList/Error 0..*      
/Error ErrorDescription 1..1 String Текстовое описание ошибки Описание ошибок – см. Коды ошибок
/Error IdError 1..1 Int Идентификатор ошибки в справочнике> Описание ошибок – см. Коды ошибок
/GetPositionListResult/ListPosition/Position 0..*      
/Position Comment 0..1 String Комментарий Дополнительная информация о врачебной должности (до 50 символов)
/Position CountFreeParticipantIE 0..1 Int Количество доступных участнику информационного обмена для записи талонов по врачебной должности  
/Position CountFreeTicket 0..1 Int Общее количество свободных талонов по врачебной должности  
/Position FedIdPosition 1..1 String Идентификатор врачебной должности в федеральном справочнике должностей Должно соответствовать коду должности из справочника
ФНСИ 1.2.643.5.1.13.13.11.1102 «ФРМР. Должности медицинского персонала»,
расположенной в папках:

  • «Должности работников медицинских организаций» ->
    «Должности медицинских работников» ->
    «Должности специалистов с высшим профессиональным (медицинским) образованием (врачи)»
    -> «врачи-специалисты»
  • «Должности работников медицинских организаций» ->
    «Должности медицинских работников» ->
    «Должности специалистов со средним профессиональным (медицинским)
    образованием (средний медицинский персонал)»

Пример: 13

/Position IdPosition 1..1 String Идентификатор врачебной должности Значение идентификатора врачебной должности из соответствующего справочника целевой МИС
/Position LastDate 0..1 Datetime Дата приема по последнему свободному талону врачебной должности  
/Position NamePosition 1..1 String Наименование врачебной должности Наименование врачебной должности из соответствующего справочника целевой МИС
/Position NearestDate 0..1 Datetime Дата приема по ближайшему свободному талону врачебной должности  

Запрос

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

Ответ

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

Получение списка врачей по должности (GetDoctorList2)

Метод «Получение списка врачей по должности (GetDoctorList2)» используется для получения от целевого ЛПУ списка врачей указанной должности, запись к которым доступна для пациента, идентификатор которого вводится в запрос метода. Список врачей, запись к которым доступна для пациента, определяется на стороне МИС ЛПУ.

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

Структура запроса GetDoctorList2 представлена на Рисунке 78

Рисунок 78. Структура запроса метода GetDoctorList2

В Таблице 63 представлено описание параметров запроса метода GetDoctorList2.

Таблица 63 — Описание параметров запроса метода GetDoctorList2
Контейнер Параметры Условие Обязательность/Кратность Тип Описание
Root        
/ idLpu 1..1   String Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idPat 1..1>   String Идентификатор пациента из соответствующего справочника целевой МИС
/ idPosition 0..1 Если в запросе указывается параметр idPosition,
параметр fedIdPosition в запросе передаваться не должен
String Идентификатор врачебной должности в справочнике целевой МИС
/ fedIdPosition 0..1 Если в запросе указывается параметр fedIdPosition,
параметр idPosition в запросе передаваться не должен
String Идентификатор врачебной должности в федеральном
справочнике должностей (ФРМР. Должности медицинского персонала (OID 1.2.643.5.1.13.13.11.1102))
Должно соответствовать коду должности,
расположенной в папках:

  • «Должности работников медицинских организаций» -> «Должности медицинских работников» -> «Должности специалистов с высшим профессиональным (медицинским) образованием (врачи) » ->
    «врачи-специалисты»
  • «Должности работников медицинских организаций» -> «Должности медицинских работников» -> «Должности специалистов со средним профессиональным (медицинским) образованием (средний медицинский персонал)»

Пример: 13

/ guid 1..1   GUID Авторизационный токен
/ idHistory 0..1   Int Идентификатор сессии (транзакции)
/ PaymentType 0..1   String Идентификатор вида оплаты (транзакции)

Описание выходных данных

Структура ответа GetDoctorList2 представлена на Рисунке 79.

Рисунок 79. Структура ответа метода GetDoctorList2

В Таблице 64 представлено описание выходных данных метода GetDoctorList2.

Таблица 64 — Описание выходных данных метода GetDoctorList2
Контейнер Выходные данные Обязательность/Кратность Тип Описание Возможные значения
/GetDoctorList2Result        
/GetDoctorList2Result IdHistory 0..1 Int Идентификатор сессии (транзакции)  
/GetDoctorList2Result Success 1..1 Boolean Результат выполнения запроса True; False
/GetDoctorList2Result Comment 0..1 String Комментарий Дополнительная информация для пациента по оформлению записи; до 50 символов
/GetDoctorList2Result/ErrorList/Error 0..*      
/Error ErrorDescription 1..1 String Текстовое описание ошибки Описание ошибок – см. Коды ошибок
/Error IdError 1..1 Int Идентификатор ошибки в справочнике Описание ошибок – см. Коды ошибок
/GetDoctorList2Result/Docs/ Doctor3 0..*      
/Doctor3 Area 0..1 String Полное наименование врачебного участка
(включая номер врачебного участка и
необходимые дополнительные указания и комментарии)
 
/Doctor3 AreaType 0..1 String Вид врачебного участка Указывается одно значение из следующих возможных:

  • Фельдшерский
  • Терапевтический
  • Врача общей практики (семейного врача)
  • Комплексный
  • Акушерский
  • Приписной
  • Педиатрический
  • Фтизиатрический
/Doctor3 Comment 0..1 String Комментарий Дополнительная информация о враче
(например, информация о причинах
и сроках отсутствия приема врача);
до 50 символов
/Doctor3 CountFreeParticipantIE 0..1 Int Количество доступных участнику информационного обмена талонов для записи к врачу  
/Doctor3 CountFreeTicket 0..1 Int Общее количество свободных талонов к врачу  
/Doctor3 IdDoc 1..1 String Идентификатор врача в справочнике Значение идентификатора врача из соответствующего справочника целевой МИС
/Doctor3 LastDate 0..1 Datetime Дата приема по последнему свободному талону к врачу  
/Doctor3 Name 1..1 String ФИО врача (полностью) ФИО врача из соответствующего справочника целевой МИС
/Doctor3 NearestDate 0..1 Datetime Дата приема по ближайшему свободному талону к врачу  
/Doctor3 Snils 0..1 String СНИЛС врача СНИЛС врача из соответствующего справочника целевой МИС (формат передачи: «XXXXXXXXXXX»)

Запрос

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

Ответ

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

Получение списка услуг по врачу (GetServiceList)

Метод «Получение списка услуг (GetServiceList)» используется для получения от целевого ЛПУ по конкретному врачу перечня услуг, которые в рамках приема могут быть оказаны пациенту.

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

Структура запроса GetServiceList представлена на Рисунке 80.

Рисунок 80. Структура запроса метода GetServiceList

В Таблице 65 представлено описание параметров запроса метода GetServiceList.

Таблица 65 — Описание параметров запроса метода GetServiceList
Контейнер Параметры Обязательность/ кратность Тип Описание
Root      
/ idLpu 1..1 String Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ idDoc 1..1 String Идентификатор врача в справочнике целевой МИС
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)

Описание выходных данных

Структура ответа GetServiceList представлена на Рисунке 81.

Рисунок 81. Структура ответа метода GetServiceLis

В Таблице 66 представлено описание выходных данных метода GetServiceList.

Таблица 66 — Описание выходных данных метода GetServiceList
Контейнер Выходные данные Обязательность/Кратность Тип Описание Возможные значения
/GetServiceListResult        
/GetServiceListResult Comment 0..1 String Комментарий Дополнительная информация для пациента по оформлению записи; до 50 символов
/GetServiceListResult IdHistory 0..1 Int Идентификатор сессии (транзакции)  
/GetServiceListResult Success 1..1 Boolean Результат выполнения запроса True; False
/GetServiceListResult/ErrorList/Error 0..*      
/Error ErrorDescription 1..1 String Текстовое описание ошибки Описание ошибок – см. Коды ошибок
/Error IdError 1..1 Int Идентификатор ошибки в справочнике> Описание ошибок – см. Коды ошибок
/GetServiceListResult/ListService/Service 0..*      
/Service Comment 0..1 String Комментарий Дополнительная информация об услуге (до 50 символов)
/Service IdService 1..1 String Идентификатор услуги Значение идентификатора услуги из соответствующего справочника целевой МИС
/Service NameService 1..1 String Наименование услуги Наименование услуги из соответствующего справочника целевой МИС

Запрос

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

Ответ

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

Коды ошибок

Ниже приведены коды ошибок, возращаемые сервисом, и соответствующее им описание.

Идентификатор ошибки Текст ошибки
1 Не был указан/указан неверно guid при вызове метода
2 Отсутствует доступ или не найдена конечная точка
3 Время ожидания истекло
4 Получен не полный набор данных для выполнения метода
5 На стороне сервиса МИС метод не поддержан
6 Техническая ошибка на стороне МИС
7 Техническая ошибка. Медицинская система учреждения не поддержала данную функциональность.
8 Нет связи с сервисом «Управление очередями»
9 Не удалось определить ЛПУ для обращения за талонами
10 Учреждение с данным идентификатором отсутствует в справочнике
11 Отсутствуют данные целевой МО
12 Ошибка в сервисе УО
13 Недействительное значение параметра
14 Неверный формат входящего параметра
15 Внутренняя ошибка сервиса
16 МИС медицинской организации передала некорректные данные
20 Пациент с заданными параметрами не найден
21 Данные пациента не являются уникальными
22 Несоответствие записи акта гражданского состояния
23 МИС не вернула идентификатор пациента
30 Запись запрещена
31 Расхождения в данных прикрепления пациента
32 Несоответствие сроков действия полиса ОМС
33 Специальность врача не соответствует профилю пациента
34 Нарушение порядка и периодичности записи
35 Пациент имеет предстоящую запись к данному врачу/врачу этой специальности
36 Пациент не имеет прикрепления к данному учреждению или участку
37 Указан недопустимый идентификатор пациента
38 Указан недопустимый идентификатор талона на запись
39 Талон к врачу занят/заблокирован
40 Пациент уже имеет запись на это время к другому врачу
41 Отсутствует информация о врачебных участках по пациенту
42 Указан некорректный идентификатор медицинского осмотра
43 Указан некорректный идентификатор медицинской услуги
44 Указан некорректный идентификатор медицинского ресурса
45 Не найдено расписание медицинского ресурса
46 Отмена записи невозможна, медицинская услуга уже оказана
47 Отмена записи невозможна, медицинская услуга обязательна
48 Указан некорректный идентификатор сессии
49 Статус заявки не изменен. Статус заявки может быть изменен согласно правилам статусной модели
50 Значение PARequestPatientContacts.Phone не может быть пустым
51 Значение PARequestPatientContacts.Phone имеет неверный формат
52 Значение PARequestPatientContacts.Email имеет неверный формат
53 Значение PASource должно соответствовать одному из значений справочника «Источник записи»
60 Указан недопустимый идентификатор врача
61 Указаны недопустимые интервалы времени
62 Дата осуществления записи на прием должна быть меньше или равна дате начала приема (NoticeAppointment)
63 Дата начала приема должна быть больше или равна дате отправки запроса (Appointment)
64 Дата и время начала приема должна быть меньше или равна дате и времени окончания приема
65 Дата осуществления записи на прием должна быть меньше или равна дате отправки запроса (NoticeAppointment)
66 Дата и время изменения статуса записи на прием должна быть больше или равна дате и времени осуществления записи на прием
67 Дата и время изменения статуса записи на прием должна быть меньше или равна дате и времени отправки запроса
70 Указан недопустимый идентификатор специальности
71 В запросе запрещено одновременное заполнение параметров: идентификатора специальности и федерального идентификатора специальности
72 Нет доступного врача для вызова врача на дом
73 Нет доступных слотов для вызова врача на дом
75 Талон с указанным номером не существует или уже отменен
76 Направление не найдено по параметрам поиска
77 Направление найдено, но не прошло проверку на актуальность
80 Нет прикрепления к ЛПУ
90 Сведения о записи не найдены
91 Неизвестный источник записи
92 Заявка {idPar} не найдена среди активных заявок
99 Текст ответа МИС – в случае необходимости передачи определенной информации клиенту сервиса, инициирующему запрос метода

Тип направления

Type
консультация
повторный

Тип ЛПУ

LpuType TypeName
1 амбулатория
2 стоматология
3 онкология
4 травматология
5 КВД
6 женская консультация
7 ПНД
8 ПТД
9 роддом
10 стационар

Тип специалиста (врача)

Type
отсутстствует_неопределенно
широкого_профиля
узкий

Роль пользователя

UserPosition
отсутстствует_неопределенно
медрегистратор
оператор
врач
портал
инфомат
система
ЛПУ
ЕПГУ

Источники записи

№ п/п Значение справочника Описание (трактовка использования значений в методе
«Уведомление о произведенной записи на прием
(SendNotificationAboutAppointment)»)
1 ЦТО Запись на прием оформлена через ЦТО (без использования методов Сервиса «Запись на прием»)
2 Инфомат Запись на прием оформлена через Информационные терминалы (без использования методов
Сервиса «Запись на прием»)
3 Регистратура Запись на прием оформлена через Регистратуру МИС (без использования методов Сервиса «Запись на прием»)
4 Врач_АПУ Запись на прием оформлена через АРМ Врача (без использования методов Сервиса «Запись на прием»)
5 Интернет Запись на прием оформлена через Интернет-порталы, мобильные приложения и т.п. (без использования методов Сервиса «Запись на прием»)
6 Прочее Запись на прием оформлена через источники записи, использующие методы Сервиса «Запись на прием»

! В случае использования данного значения в запросе SendNotificationAboutAppointment, обязателен для передачи параметр member в запросе SendNotificationAboutAppointment

Статус записи на прием

№ п/п Значение справочника Описание
1 запись_отменена_по_инициативе_ЛПУ Запись отменена по инициативе ЛПУ
2 запись_отменена_по_инициативе_пациента Запись отменена по инициативе пациента
3 запись_перенесена Запись перенесена
4 посещение_состоялось Посещение состоялось
5 пациент_не_явился Пациент не явился