Ссылка скопирована

Техническая документация

Дата обновления: 18.11.2025

Оглавление

Общее описание

Методы API

Статусная модель

Рекомендации по использованию API

Схема взаимодействия

Основные бизнес-кейсы

Общее описание

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



Интеграция реализуется согласно REST API. Авторизация реализуется согласно спецификации OAuth 2.0.

Методы API по ролям:


Методы API (полный список):

I. Авторизация

  1. Получение токена авторизации
  2. Обновление токена авторизации

II. Справочники

  1. Получение списка доступных страховых компаний
  2. Получение списка доступных клиник

III. Ордеры

  1. Создание ордера
  2. Получение ордера
  3. Получение списка ордеров
  4. Обновление ордера

IV. Услуги для согласования

  1. Загрузка списка услуг
  2. Редактирование списка услуг

V. Добавление списка протоколов приёмов

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

VII. Гарантийные письма

  1. Загрузка гарантийного письма
  2. Получение гарантийного письма

VII. Файлы вложений

  1. Загрузка списка файлов
  2. Получение файла

Статусная модель

Статусы ордеров:

  • «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» – Передано в другое ЛПУ

Рекомендации по использованию API

  1. Если клиника хочет отправить запрос на согласование 2 и более услуг, ей стоит определиться, являются ли услуги однородными или разнородными (амбулаторными / госпитальными / лабораторными). В случае разнородных услуг стоит создать 2 и более разных ордеров
  2. В случае поэтапного согласования услуг страховой компанией, когда ордер находится в статусе «2 - Ожидает согласования» или «4 - Дополнительная информация предоставлена», клиника оказывает согласованные страховой компанией услуги на свой страх и риск

Схема взаимодействия

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

Базовый кейс, позитивный сценарий

Клиника запрашивает у Страховой компании согласование по списку услуг, страховая согласовывает всё в полном объёме, формирует и прикладывает гарантийное письмо:

I. Клиника создаёт и наполняет ордер:

  1. создать ордер, заполнив обязательную информацию
  2. добавить список услуг к ордеру
  3. (необязательно) добавить список протоколов приёмов к ордеру
  4. (необязательно) добавить список файлов-вложений к ордеру
  5. отредактировать ордер, добавив дополнительную информацию (необязательно) и изменив статус ордера (обязательно) на «2 - Ожидает согласования»

II. Страховая компания получает и обрабатывает ордер:

  1. (периодически, 1 раз в N минут) запросить ордеры, обновлённые за прошедшие N минут
  2. получить новый ордер и направить информацию оператору для обработки
  3. (вне API МедФлекс) оператор обрабатывает информацию, принимает положительное решение по всем услугам в полном объёме и формирует гарантийное письмо
  4. изменить список услуг, указав кол-во согласованных услуг и изменив их статус на «3 – Согласовано по ГП»
  5. загрузить и добавить к ордеру файл гарантийного письма
  6. отредактировать ордер, сменив его статус на «6 – Согласовано, ГП передано во вложении»

III. Клиника получает и обрабатывает ордер

  1. (периодически, 1 раз в N минут) запросить ордеры, обновлённые за прошедшие N минут
  2. получить изменённый ордер и направить информацию и гарантийное письмо администратору/врачу для обработки

Основные бизнес-кейсы

  1. Клиника запрашивает у Страховой компании согласование по списку услуг, Страховая компания принимает решение: полностью согласовать, частично согласовать или полностью отклонить услуги в ордере
  2. Клиника указывает, по каким услугам из списка она ожидает получить гарантийное письмо по итогам согласования, а какие услуги могут быть согласованы без гарантийного письма. Страховая компания передаёт гарантийное письмо по API
  3. Клиника прикладывает информацию из протоколов приёмов пациента для того, чтобы Страховая компания могла принять решение о согласовании услуг: жалобы, анамнез, диагноз, назначенные лекарства, обоснование и т. п.
  4. Страховой компании недостаточно информации, переданной Клиникой, для принятия решения и Страховая запрашивает дополнительную информацию у Клиники посредством API и клиника её передаёт также по API
  5. Страховая компания направила пациента в Клинику и заранее направила по API в Клинику ордер без списка услуг. Клиника по итогам проведённого приёма самостоятельно заполняет ордер и отправляет его на согласование
  6. Страховая компания заранее направила в Клинику согласованный список услуг, в т. ч. сразу приложила гарантийное письмо
  7. Страховая компания отозвала гарантийное письмо

Кейс "Поэтапное согласование услуг страховой компанией, все услуги согласованы"

Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток

Решение:

  1. Страховая компания получает ордер, не меняя его статус
  2. Страховая компания, используя метод ​/insurance_approval​/orders​/{uuid}​/services​/bulk_update​/, меняет статус 2 услуг на «2 – Согласована без ГП» или «3 – Согласована по ГП» в течение часа
  3. Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
  4. Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания согласовала 2 из них и может оказать эти услуги пациенту
  5. Через сутки страховая компания согласовывает 3ю из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «2 – Согласована без ГП» или «3 – Согласована по ГП» и статус самого ордера на «5 - Согласовано частично или полностью, нет ГП» или «6 - Согласовано частично или полностью, ГП передано во вложении»

Кейс "Поэтапное согласование услуг страховой компанией, не все услуги согласованы"

Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток

Решение:

  1. Страховая компания получает ордер, не меняя его статус
  2. Страховая компания, используя метод ​/insurance_approval​/orders​/{uuid}​/services​/bulk_update​/, меняет статус 2 услуг на «2 – Согласована без ГП» или «3 – Согласована по ГП» в течение часа
  3. Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
  4. Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания согласовала 2 из них и может оказать эти услуги пациенту
  5. Через сутки страховая компания согласовывает 3ю из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «4 – Отклонена» и статус самого ордера на «5 - Согласовано частично или полностью, нет ГП» или «6 - Согласовано частично или полностью, ГП передано во вложении»

Кейс "Поэтапное согласование услуг страховой компанией, в согласовании всех услуг отказано"

Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток

Решение:

  1. Страховая компания получает ордер, не меняя его статус
  2. Страховая компания, используя метод ​/insurance_approval​/orders​/{uuid}​/services​/bulk_update​/, меняет статус 2 услуг на «4 – Отклонена» в течение часа
  3. Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
  4. Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания отказала в согласовании 2 из них
  5. Через сутки страховая компания отказывает в согласовании 3ей из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «4 – Отклонена» и статус самого ордера на «13 - Отклонен СК»