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

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

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

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

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

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

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

Для взаимодействия информационных систем в зависимости от их вида предусмотрены различные типовые решения:

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

Типовое решение для Портала, Инфоматов и Мобильных приложений

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

На диаграмме представлены функции (выделены зеленым), результат выполнения функций (выделены красным) и методы, которые реализуют соответствующие функции (указаны как комментарии к функциям). Например, метод, реализующий функцию «Валидация кода направления», называется InspectDoctorsReferal. Результатами выполнения этой функции могут быть следующие ответы:

  1. Код направления недействителен;
  2. Проверяемое направление является направлением на повторный прием;
  3. Проверяемое направление является направлением на консультацию.

Рисунок 1. Схема Типового решения для Портала, Инфомата и Мобильного приложения

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

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

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

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

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

Типовое решение для записи из МИС в другую МИС

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

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

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

Рисунок 3. Схема Типового решения для записи из одной МИС в другую

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

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

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

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

Валидация кода направления (InspectDoctorsRefferal)

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

Результатами выполнения данного метода могут быть следующие ответы:

  1. Код направления недействителен;
  2. Проверяемое направление является направлением на повторный прием;
  3. Проверяемое направление является направлением на консультацию.

В случае, если код направления является кодом на консультацию, далее с помощью нижеописанных методов осуществляется выбор района (GetDistrictList), выбор ЛПУ (GetLPUList), проводится идентификация пациента (CheckPatient или SearchTop10Patient), после чего осуществляется выбор врача (GetDoctorList или GetDocListFullTree). В случае, если код направления является кодом на повторный прием, осуществляется проверка направления, в результате которой Район, ЛПУ и врач будут выбраны автоматически.

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

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

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

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

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

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

Параметр "Обязательность" определяет количество возможных экземпляров параметра

Возможны следующие значения:

  • 0..1 - параметр необязательный, максимальное количество экземпляров один;
  • 0..* – параметр необязательный, максимальное количество экземпляров не ограничено;
  • 1..1 – параметр обязательный, экземпляр один;
  • 1..* – параметр обязательный, максимальное количество экземпляров не ограничено.

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

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

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

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

Таблица 2 - Описание выходных данных метода InspectDoctorsRefferal
Контейнер Параметры Тип Описание Возможные значения
/InspectDoctorsRefferalResult      
/InspectDoctorsRefferalResult IdHistory Int Идентификатор сессии (транзакции)  
/InspectDoctorsRefferalResult Success Boolean Результат выполнения запроса True; False
/InspectDoctorsRefferalResult IdDoc String Идентификатор врача, к которому осуществляется запись Значение идентификатора врача из соответствующего справочника целевой МИС
/InspectDoctorsRefferalResult IdLpu Int Идентификатор ЛПУ Значение идентификатора из справочника «ЛПУ» Интеграционной платформы
/InspectDoctorsRefferalResult Id_Patient String Идентификатор пациента, получившего направление Значение идентификатора пациента из соответствующего справочника целевой МИС
/InspectDoctorsRefferalResult Type String Тип направления Значения типа направления – см. Приложение 2
/InspectDoctorsRefferalResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок

Запрос

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

Ответ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Запрос

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

Ответ

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

Выбор ЛПУ (GetLPUList)

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

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

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

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

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

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

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

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

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

Рисунок 9. Структура ответа метода 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)

Запрос

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

Ответ

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

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

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

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

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

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

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

<

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

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

Таблица 7 – Описание параметров запроса метода CheckPatient
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/pat      
/pat AriaNumber 0..1 String Номер врачебного участка
/pat Birthday 1..1 datetime Дата рождения
/pat CellPhone 0..1 String Номер мобильного телефона
/pat Document_N 0..1 String Номер документа
/pat Document_S 0..1 String Серия документа
/pat HomePhone 0..1 String Номер домашнего телефона
/pat IdPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/pat Name 1..1 String Имя
/pat Polis_N 0..1 String Номер полиса ОМС
/pat Polis_S 0..1 String Серия полиса ОМС
/pat SecondName 0..1 String Отчество
/pat Surname 1..1 String Фамилия

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

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

Рисунок 11. Структура ответа метода 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)

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

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

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

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

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

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

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

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

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

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

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

Запрос

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

Ответ

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

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

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

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

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

Рисунок 14. Структура запроса метода 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 Идентификатор сессии (транзакции)

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

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

Рисунок 15. Структура ответа метода 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 IdDoc String Идентификатор врача в справочнике Значение идентификатора врача из соответствующего справочника целевой МИС
/Doctor Name String ФИО врача (полностью) ФИО врача из соответствующего справочника целевой МИС

Запрос

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

Ответ

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

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

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

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

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

Рисунок 16. Структура запроса метода 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 Идентификатор сессии (транзакции)

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

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

Рисунок 17. Структура ответа метода 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 представлена на Рисунке 18.

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

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

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

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

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

Рисунок 19. Структура ответа метода 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 IdAppointment String Идентификатор талона для записи Значение идентификатора талона на прием из соответствующего справочника целевой МИС
/Appointment VisitStart Datetime Дата и время начала приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs
/Appointment VisitEnd Datetime Дата и время окончания приема Значение в формате: YYYY-MM-DDHH:MM:SS.MsMsMs

Запрос

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

Ответ

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

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

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

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

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

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

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

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

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

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

Рисунок 21. Структура ответа метода 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 представлена на Рисунке 22.

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

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

Таблица 19 – Описание параметров запроса метода SearchTop10Patient
Контейнер Параметры Обязательность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/pat      
/pat AriaNumber 0..1 String Номер врачебного участка
/pat Birthday 0..1 datetime Дата рождения
/pat CellPhone 0..1 String Номер мобильного телефона
/pat Document_N 0..1 String Номер документа
/pat Document_S 0..1 String Серия документа
/pat HomePhone 0..1 String Номер домашнего телефона
/pat IdPat 0..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/pat Name 1..1 String Имя пациента
/pat Polis_N 0..1 String Номер полиса ОМС
/pat Polis_S 0..1 String Серия полиса ОМС
/pat SecondName 0..1 String Отчество пациента
/pat Surname 1..1 String Фамилия пациента

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

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

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

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

Таблица 20 - Описание выходных данных метода SearchTop10Patient
Контейнер Параметры Тип Описание Возможные значения
/SearchTop10PatientResult      
/SearchTop10PatientResult IdHistory Int Идентификатор сессии (транзакции)  
/SearchTop10PatientResult Success Boolean Результат выполнения запроса True; False
/SearchTop10PatientResult/ErrorList/Error      
/Error ErrorDescription String Текстовое описание ошибки Коды ошибок
/Error IdError Int Идентификатор ошибки в справочнике Коды ошибок
/SearchTop10PatientResult/ListPatient/Patient      
/Patient AriaNumber String Номер врачебного участка Значение идентификатора врачебного участка из соответствующего справочника целевой МИС
/Patient Birthday datetime Дата рождения  
/Patient CellPhone String Номер мобильного телефона  
/Patient Document_N String Номер документа  
/Patient Document_S String Серия документа  
/Patient HomePhone String Номер домашнего телефона  
/Patient IdPat String Идентификатор пациента Значение идентификатора пациента из соответствующего справочника целевой МИС
/Patient Name String Имя пациента  
/Patient Polis_N String Номер полиса ОМС  
/Patient Polis_S String Серия полиса ОМС  
/Patient SecondName String Отчество пациента  
/Patient Surname String Фамилия пациента  

Запрос

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

Ответ

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

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

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

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

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

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

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

Таблица 21 – Описание параметров запроса метода AddNewPatient
Контейнер Параметры Обязательность/ кратность Тип Описание
Root      
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/patient 0..1   Информация о пациенте
/patient AriaNumber 0..1 String Номер врачебного участка в запрашивающей МИС
/patient Birthday 1..1 datatime Дата рождения
/patient CellPhone 0..1 String Номер мобильного телефона
/patient Document_N 0..1 String Номер документа
/patient Document_S 0..1 String Серия документа
/patient HomePhone 0..1 String Номер домашнего телефона
/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 Surname 1..1 String Фамилия пациента

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

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

Рисунок 25. Структура ответа метода 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 представлена Рисунке 26.

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

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

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

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

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

Рисунок 27. Структура ответа метода 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 представлена Рисунке 28.

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

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

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

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

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

Рисунок 29. Структура ответа метода 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 datatime Дата создания записи на прием  
/HistoryRefusal IdAppointment String Идентификатор талона на запись Идентификатор талона для записи из соответствующего справочника МИС
/HistoryRefusal VisitStart datatime Дата начала приема  
/GetPatientHistoryResult/ListHistoryRefusal/HistoryRefusal/DoctorBringRefereal      
/DoctorBringRefereal AriaNumber String Номер врачебного участка  
/DoctorBringRefereal IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorBringRefereal Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryRefusal/HistoryRefusal/DoctorRendingConsultation      
/DoctorRendingConsultation AriaNumber String Номер врачебного участка  
/DoctorRendingConsultation IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorRendingConsultation Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryRefusal/HistoryRefusal/SpecialityBringReferal      
/SpecialityBringReferal FedIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике  
/SpecialityBringReferal IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityBringReferal NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryRefusal/HistoryRefusal/SpecialityRendingConsultation      
/SpecialityRendingConsultation FedIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике  
/SpecialityRendingConsultation IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityRendingConsultation NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryRefusal/HistoryRefusal/UserCreatedAppointment      
/UserCreatedAppointment UserName String Пользователь, записавший на прием  
/UserCreatedAppointment UserPosition String Роль пользователя, записавшего на прием Значение справочника «Роль пользователя (метод GetPatientHistory)» (см. Приложение 5)
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit      
/HistoryVisit DateCreatedAppointment datatime Дата создания записи на прием  
/HistoryVisit IdAppointment String Идентификатор талона на запись Идентификатор талона для записи из соответствующего справочника МИС
/HistoryVisit VisitStart datatime Дата начала приема  
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit/DoctorBringRefereal      
/DoctorBringRefereal AriaNumber String Номер врачебного участка  
/DoctorBringRefereal IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorBringRefereal Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit/DoctorRendingConsultation      
/DoctorRendingConsultation AriaNumber String Номер врачебного участка  
/DoctorRendingConsultation IdDoc String Идентификатор врача Значение идентификатора врача из соответствующего справочника МИС
/DoctorRendingConsultation Name String ФИО врача (полностью)  
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit/SpecialityBringReferal      
/SpecialityBringReferal FedIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике  
/SpecialityBringReferal IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityBringReferal NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit/SpecialityRendingConsultation      
/SpecialityRendingConsultation FedIdSpesiality String Идентификатор врачебной специальности в федеральном справочнике  
/SpecialityRendingConsultation IdSpesiality String Идентификатор врачебной специальности в справочнике Идентификатор врачебной специальности в справочнике МИС
/SpecialityRendingConsultation NameSpesiality String Наименование врачебной специальности Наименование врачебной специальности в справочнике МИС
/GetPatientHistoryResult/ListHistoryVisit/HistoryVisit/UserCreatedAppointment      
/UserCreatedAppointment UserName String Пользователь, записавший на прием  
/UserCreatedAppointment UserPosition String Роль пользователя, записавшего на прием Значение справочника «Роль пользователя (метод GetPatientHistory)» (см. Приложение 5)

Запрос

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

Ответ

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

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

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

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

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

Рисунок 30. Структура запроса метода 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 представлена на Рисунке 31.

Рисунок 31. Структура ответа метода 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 представлена на Рисунке 32.

Рисунок 32. Структура запроса метода 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 представлена на Рисунке 33.

Рисунок 33. Структура ответа метода 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

Запрос

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

Ответ

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

Постановка в лист ожидания (SetWaitingList)

Данный метод предназначен для фиксирования отказа пациента от записи на прием и добавления пациента в Лист ожидания.

Листом ожидания является список пациентов, ожидающих появление свободных талонов на прием к определенному врачу или врачебной специальности в указанный временной интервал. Пациент может быть добавлен в Лист ожидания при отсутствии свободного/удобного для пациента времени приема врача в соответствии с установленным графиком приема врачей.

Если при обращении к методу передается объект rule, то метод осуществляет постановку в Лист ожидания, иначе осуществляется отказ от записи.

При осуществлении добавления пациента в Лист ожидания соответствующая информация направляется посредством Интеграционной платформы в целевую МИС.

Процесс «Постановка пациента в Лист ожидания посредством ЦТО» представлен на Рисунке 34.

Рисунок 34. Схема процесса «Постановка пациента в Лист ожидания посредством ЦТО»

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

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

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

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

Таблица 31 - Описание параметров запроса метода SetWaitingList
Контейнер Параметры Обязательность/ кратность Тип Описание
Root      
/ idDoc 0..1 String Идентификатор врача в справочнике целевой МИС
/ nameDoc 0..1 String ФИО врача (полностью)
/ idSpesiality 1..1 String Идентификатор врачебной специальности в справочнике целевой МИС
/ nameSpesiality 1..1 String Наименование врачебной специальности в справочнике целевой МИС
/ idLpu 1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ claim 0..1 String Причина постановки в лист ожидания (см. Приложение 6)
/ idPat 1..1 String Идентификатор пациента из соответствующего справочника целевой МИС
/ namePat 0..1 String ФИО пациента (полностью)
/ birthday 0..1 dataTime Дата рождения пациента
/ phone 0..1 String Номер телефона пациента
/ guid 1..1 GUID Авторизационный токен
/ idHistory 0..1 Int Идентификатор сессии (транзакции)
/rule 0..1   Заполняется при постановке в лист ожидания
/rule Start 1..1 Datetime Начало диапазона ожидания (желаемого времени приема)
/rule End 1..1 Datetime Окончание диапазона ожидания (желаемого времени приема)

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

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

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

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

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

Запрос

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

Ответ

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

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

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

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

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

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

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

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

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

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

Рисунок 38. Структура ответа метода 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 представлена на Рисунке 39.

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

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

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

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

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

Рисунок 40. Структура ответа метода 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 Роль пользователя Значение справочника «Роль пользователя (метод GetHubUserByGuid)» (см. Приложение 7)
/HubUser IdDistrict Int Идентификатор района Значение идентификатора из справочника «Районы» Интеграционной платформы
/HubUser PublicGuid GUID GUID пользователя  

Запрос

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

Ответ

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

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

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

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

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

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

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

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

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

Таблица 37 - Описание параметров запроса метода SendNotificationAboutAppointment.
Контейнер Параметры Условие Обязательность/ кратность Тип Описание
Root        
/ idLpu   1..1 Int Идентификатор ЛПУ из справочника «ЛПУ» Интеграционной платформы
/ appointmentSource   1..1 String Источник записи (см. Приложение 8)
/ guid   1..1 GUID Авторизационный токен
/ idHistory   0..1 Int Идентификатор сессии (транзакции)
/doctor        
/doctor AriaNumber   0..1 String Номер врачебного участка
/doctor IdDoc   1..1 String Идентификатор врача в соответствующем справочнике МИС
/doctor Name   1..1 String ФИО врача
/spesiality        
/spesiality FerIdSpesiality   0..1 String Идентификатор специальности в справочнике ФЭР
/spesiality IdSpesiality   1..1 String Идентификатор врачебной специальности в справочнике МИС
/spesiality NameSpesiality   1..1 String Наименование врачебной специальности в справочнике МИС
/patient        
/patient AriaNumber   0..1 String Номер врачебного участка
/patient Birthday   1..1 dateTime Дата рождения пациента
/patient CellPhone   0..1 String Номер мобильного телефона пациента
/patient HomePhone   0..1 String Номер домашнего телефона пациента
/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 Номер полиса
/Аppointment При передаче уведомлений «онлайн» 1..1
При передаче уведомлений «постфактум» 0..0
/Аppointment IdAppointment   1..1 String Идентификатор талона для записи из соответствующего справочника МИС
/Аppointment VisitStart   1..1 dateTime Начало приема
/Аppointment VisitEnd   1..1 dateTime Окончание приема
/NoticeAppointment При передаче уведомлений «онлайн» 0..0
  При передаче уведомлений «постфактум» 1..1
/NoticeAppointment IdAppointment   1..1 String Идентификатор талона для записи из соответствующего справочника МИС
/NoticeAppointment VisitStart   1..1 dateTime Начало приема
/NoticeAppointment VisitEnd   1..1 dateTime Окончание приема
/NoticeAppointment RecordDateTime   1..1 dateTime Дата осуществления записи на прием

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

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

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

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

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

Запрос

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

Ответ

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

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

Идентификатор ошибки Текст ошибки
1 Не был указан/указан неверно guid при вызове метода
2 Отсутствует доступ или не найдена конечная точка
3 Время ожидания истекло
10 Учреждение с данным идентификатором отсутствует в справочнике
20 Пациент с заданными параметрами не найден
21 Данные пациента не являются уникальными
22 Несоответствие записи акта гражданского состояния
30 Запись запрещена
31 Расхождения в данных прикрепления пациента
32 Несоответствие сроков действия полиса ОМС
33 Специальность врача не соответствует профилю пациента
34 Нарушение порядка и периодичности записи
35 Пациент имеет предстоящую запись к данному врачу/врачу этой специальности
36 Пациент не имеет прикрепления к данному учреждению
37 Указан недопустимый идентификатор пациента
38 Указан недопустимый идентификатор талона на запись
39 Талон к врачу занят/заблокирован
40 Пациент уже имеет запись на это время к другому врачу
60 Указан недопустимый идентификатор врача
61 Указаны недопустимые интервалы времени
70 Указан недопустимый идентификатор специальности