Дата обновления: 18.11.2025
Оглавление 
Общее описание
API предназначен для обмена документами с целью согласования Страховой компанией услуг, предоставляемых Клиникой и в случае положительного решения – передачи гарантийного письма или номера листа согласования по запрашиваемому списку услуг.
Интеграция реализуется согласно REST API. Авторизация реализуется согласно спецификации OAuth 2.0.
Методы API по ролям:
Методы API (полный список):
I. Авторизация
- Получение токена авторизации
- Обновление токена авторизации
II. Справочники
- Получение списка доступных страховых компаний
- Получение списка доступных клиник
III. Ордеры
- Создание ордера
- Получение ордера
- Получение списка ордеров
- Обновление ордера
IV. Услуги для согласования
- Загрузка списка услуг
- Редактирование списка услуг
V. Добавление списка протоколов приёмов
VI. Добавление списка филиалов клиник, для которых выпускается гарантийное письмо
VII. Гарантийные письма
- Загрузка гарантийного письма
- Получение гарантийного письма
VII. Файлы вложений
- Загрузка списка файлов
- Получение файла
Основные бизнес-кейсы
- Клиника запрашивает у Страховой компании согласование по списку услуг, Страховая компания принимает решение: полностью согласовать, частично согласовать или полностью отклонить услуги в ордере
- Клиника указывает, по каким услугам из списка она ожидает получить гарантийное письмо по итогам согласования, а какие услуги могут быть согласованы без гарантийного письма. Страховая компания передаёт гарантийное письмо по API
- Клиника прикладывает информацию из протоколов приёмов пациента для того, чтобы Страховая компания могла принять решение о согласовании услуг: жалобы, анамнез, диагноз, назначенные лекарства, обоснование и т. п.
- Страховой компании недостаточно информации, переданной Клиникой, для принятия решения и Страховая запрашивает дополнительную информацию у Клиники посредством API и клиника её передаёт также по API
- Страховая компания направила пациента в Клинику и заранее направила по API в Клинику ордер без списка услуг. Клиника по итогам проведённого приёма самостоятельно заполняет ордер и отправляет его на согласование
- Страховая компания заранее направила в Клинику согласованный список услуг, в т. ч. сразу приложила гарантийное письмо
- Страховая компания отозвала гарантийное письмо
Схема взаимодействия
В зависимости от решаемых бизнес-кейсов последовательность выполняемых запросов в сторону МедФлекс может быть разной. Далее в описываемом кейсе предполагается, что авторизация успешно пройдена, токен получен и используется при отправке запросов в МедФлекс.
Базовый кейс, позитивный сценарий
Клиника запрашивает у Страховой компании согласование по списку услуг, страховая согласовывает всё в полном объёме, формирует и прикладывает гарантийное письмо:
I. Клиника создаёт и наполняет ордер:
- создать ордер, заполнив обязательную информацию
- добавить список услуг к ордеру
- (необязательно) добавить список протоколов приёмов к ордеру
- (необязательно) добавить список файлов-вложений к ордеру
- отредактировать ордер, добавив дополнительную информацию (необязательно) и изменив статус ордера (обязательно) на «2 - Ожидает согласования»
II. Страховая компания получает и обрабатывает ордер:
- (периодически, 1 раз в N минут) запросить ордеры, обновлённые за прошедшие N минут
- получить новый ордер и направить информацию оператору для обработки
- (вне API МедФлекс) оператор обрабатывает информацию, принимает положительное решение по всем услугам в полном объёме и формирует гарантийное письмо
- изменить список услуг, указав кол-во согласованных услуг и изменив их статус на «3 – Согласовано по ГП»
- загрузить и добавить к ордеру файл гарантийного письма
- отредактировать ордер, сменив его статус на «6 – Согласовано, ГП передано во вложении»
III. Клиника получает и обрабатывает ордер
- (периодически, 1 раз в N минут) запросить ордеры, обновлённые за прошедшие N минут
- получить изменённый ордер и направить информацию и гарантийное письмо администратору/врачу для обработки
Статусная модель
Статусы ордеров:
- «1» - Создание ордера
- «2» - Ожидает согласования
- «3» - Запрос дополнительной информации
- «4» - Дополнительная информация предоставлена
- «5» - Согласовано, нет ГП
- «6» - Согласовано, ГП передано во вложении
- «7» - Согласовано, ожидает ГП (будет реализован в следующих итерациях)
- «8» - Согласовано, ГП сформировано, отправляется в СК (будет реализован в следующих итерациях)
- «9» - Согласовано, ГП получено, ожидает подписи со стороны СК (будет реализован в следующих итерациях)
- «10» - Согласовано, ГП подписано (будет реализован в следующих итерациях)
- «11» - Отклонен СК
- «12» - ГП аннулировано
- «13» - Отклонен Клиникой
Статусы ордеров «7», «8», «9», «10» необходимы для выпуска ГП в формате XML с дальнейшим подписанием ЭЦП на стороне Страховой компании. На текущий момент статусная модель заложена, но данный функционал недоступен, т. к. планируется к реализации в последующих итерациях.
Ограничения на использование статусов
Статусы ордера могут двигаться только в сторону увеличения. При этом, не обязательно последовательно.
Статусы ордера «11» - Отклонен СК, «12» - ГП аннулировано, «13» - Отклонен Клиникой являются финальными. Ордер в таких статусах редактировать нельзя.
Клиника может редактировать ордер только, когда ордер имеет один из следующих статусов:
- «1» - Создание ордера
- «3» - Запрос дополнительной информации
Страховая компания может редактировать ордер только, когда ордер имеет один из следующих статусов:
- «1» - Создание ордера
- «2» - Ожидает согласования
- «4» - Дополнительная информация предоставлена
- «6» - Согласовано, ГП передано во вложении
Статусы услуг:
- «1» – Ожидает согласования
- «2» – Согласована без ГП
- «3» – Согласована по ГП
- «4» – Отклонена
- «5» – Передано в другое ЛПУ