Дата обновления: 18.11.2025
Оглавление 
Рекомендации по использованию API
Общее описание 
API предназначен для обмена документами с целью согласования Страховой компанией услуг, предоставляемых Клиникой и в случае положительного решения – передачи гарантийного письма или номера листа согласования по запрашиваемому списку услуг.
Интеграция реализуется согласно REST API. Авторизация реализуется согласно спецификации OAuth 2.0.
Методы API по ролям:

Методы API (полный список): 
I. Авторизация
- Получение токена авторизации
POST /insurance_approval/auth/token/ - Обновление токена авторизации
POST /insurance_approval/auth/refresh_token/
II. Справочники
- Получение списка доступных страховых компаний (доступен только Клинике)
GET /insurance_approval/catalog/insurance_companies/ - Получение списка доступных клиник
GET /insurance_approval/catalog/clinics/
III. Ордеры
- Создание ордера
POST /insurance_approval/orders/ - Получение ордера
GET /insurance_approval/orders/{uuid}/ - Получение списка ордеров
GET /insurance_approval/orders/ - Обновление ордера
PATCH /insurance_approval/orders/{uuid}/
IV. Услуги для согласования
- Загрузка списка услуг
POST /insurance_approval/orders/{uuid}/attachments/bulk_create/ - Редактирование списка услуг (доступен только СК)
PATCH /insurance_approval/orders/{uuid}/services/bulk_update/
V. Протоколы приёмов
- Добавление списка протоколов приёмов (доступен только Клинике)
POST /insurance_approval/orders/{uuid}/protocols/bulk_create/
VI. Филиалы клиник
- Добавление списка филиалов клиник, для которых выпускается гарантийное письмо (доступен только СК)
POST /insurance_approval/orders/{uuid}/filials_for_letter_of_guarantee/bulk_create/
VII. Гарантийные письма
- Загрузка гарантийного письма (доступен только СК)
POST /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/ - Получение гарантийного письма
GET /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/
VII. Файлы вложений
- Загрузка списка файлов (доступен только Клинике)
POST /insurance_approval/orders/{uuid}/attachments/bulk_create/ - Получение файла
GET /insurance_approval/orders/{uuid}/attachments/{attachment_id}/
Статусная модель 
Статусы ордеров: 
- «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 
- Если клиника хочет отправить запрос на согласование 2 и более услуг, ей стоит определиться, являются ли услуги однородными или разнородными (амбулаторными / госпитальными / лабораторными). В случае разнородных услуг стоит создать 2 и более разных ордеров
- В случае поэтапного согласования услуг страховой компанией, когда ордер находится в статусе «2 - Ожидает согласования» или «4 - Дополнительная информация предоставлена», клиника оказывает согласованные страховой компанией услуги на свой страх и риск
Основные бизнес-кейсы 
Клиника запрашивает согласование услуг, ГП не требуется 
Описание: клиника запрашивает у Страховой компании согласование по списку услуг, Страховая компания принимает решение, полностью или частично согласовать услуги в ордере
- Клиника создаёт ордер по методу POST /insurance_approval/orders/. При этом, в поле "lpu_ids" клиника указывает ожидаемые id филиалов своей сети, в которые застрахованный пациент может обратиться для оказания согласованных услуг после согласования со стороны СК
- Клиника добавляет услуги для согласования к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, для каждой услуги необходимо указать:
- стоимость в поле "price"
- для количественных услуг - их кол-во в поле "count"
- в поле "letter_of_guarantee" значение "false"
- Клиника добавляет информацию из протоколов приёмов (жалобы, анамнез, диагноз и т. п.) к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, указывая id ордера в URL
- Клиника передаёт ордер на согласование СК, передав в поле "status" значение "2" (Ожидает согласования) по методу PATCH /insurance_approval/orders/{uuid}/. После изменения статуса ордера на "2" клиника может вносить изменения в ордер, услуги, протоколы и файлы только, если СК изменит статус ордера на "3" (Запрос дополнительной информации)
- СК запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- СК получает в списке ордеров новый ордер в статусе "2" (Ожидает согласования)
- СК обрабатывает информацию из ордера и принимает решение о согласовании услуг
- СК приняла решение согласовать услуги и для каждой услуги в ордере указывает в методе PATCH /insurance_approval/orders/{uuid}/services/bulk_update/:
- для каждой несогласованной услуги: в поле "agreed_count" значение "0", в поле "status" значение "4" (Отклонена)
- для каждой согласованной услуги: в поле "agreed_count" - согласованное кол-во, в поле "status" значение "2" (Согласована без ГП)
- СК передаёт согласованный ордер клинике путём изменения значения поля "status" ордера на "5" (Согласовано частично или полностью, нет ГП) по методу PATCH /insurance_approval/orders/{uuid}/
- (необязательно) указывает номер листа согласования в поле approval_list.number
- меняет значение поля "status" ордера на "5" (Согласовано частично или полностью, нет ГП)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "5" (Согласовано частично или полностью, нет ГП) со списком согласованных услуг
Клиника запрашивает согласование услуг, ГП ожидается и передаётся 
Описание: клиника указывает, по каким услугам из списка она ожидает получить гарантийное письмо по итогам согласования, а какие услуги могут быть согласованы без гарантийного письма. Страховая компания согласовывает услуги и передаёт гарантийное письмо по API
- Клиника создаёт ордер по методу POST /insurance_approval/orders/. При этом, в поле "lpu_ids" клиника указывает ожидаемые id филиалов своей сети, в которые застрахованный пациент может обратиться для оказания согласованных услуг после согласования со стороны СК
- Клиника добавляет услуги для согласования к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, для каждой услуги необходимо указать:
- стоимость в поле "price"
- для количественных услуг - их кол-во в поле "count"
- в поле "letter_of_guarantee" значение "true"
- Клиника добавляет информацию из протоколов приёмов (жалобы, анамнез, диагноз и т. п.) к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, указывая id ордера в URL
- Клиника передаёт ордер на согласование СК, передав в поле "status" значение "2" (Ожидает согласования) по методу PATCH /insurance_approval/orders/{uuid}/. После изменения статуса ордера на "2" клиника может вносить изменения в ордер, услуги, протоколы и файлы только, если СК изменит статус ордера на "3" (Запрос дополнительной информации)
- СК запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- СК получает в списке ордеров новый ордер в статусе "2" (Ожидает согласования)
- СК обрабатывает информацию из ордера и принимает решение о согласовании услуг
- СК приняла решение согласовать услуги и для каждой услуги в ордере указывает:
- для каждой несогласованной услуги: в поле "agreed_count" значение "0", в поле "status" значение "4" (Отклонена)
- для каждой согласованной услуги, не требующей ГП: в поле "agreed_count" - согласованное кол-во, в поле "status" значение "2" (Согласована без ГП)
- для каждой согласованной услуги, требующей ГП: в поле "agreed_count" - согласованное кол-во, в поле "status" значение "3" (Согласована по ГП)
- (не обязательно) СК указывает, в какие филиалы сети Клиники может обратиться застрахованный пациент для оказания согласованных по ГП услуг в методе POST /insurance_approval/orders/{uuid}/filials_for_letter_of_guarantee/bulk_create/. Это необязательная информация - если не указаны конкретные филиалы Клиники, то подразумевается, что застрахованный пациент может обратиться в любой филиал Клиники для оказания согласованных по ГП услуг
- СК загружает файл ГП по методу POST /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/
- СК передаёт согласованный ордер клинике по методу: PATCH /insurance_approval/orders/{uuid}/:
- (необязательно) указывает номер листа согласования в поле approval_list.number
- указывает параметры ГП в объекте "letter_of_guarantee"
- меняет значение поля "status" ордера на "6" (Согласовано частично или полностью, ГП передано во вложении)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "6" (Согласовано частично или полностью, ГП передано во вложении) со списком согласованных услуг и (не обязательно) списком филиалов, в которых возможно оказание застрахованному пациенту согласованных по ГП услуг
- Клиника запрашивает файл ГП по методу GET /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/
Запрос дополнительной информации 
Описание: Страховой компании недостаточно информации, переданной Клиникой, для принятия решения и Страховая запрашивает дополнительную информацию у Клиники посредством API и клиника её передаёт также по API
- Клиника создаёт ордер по методу POST /insurance_approval/orders/. При этом, в поле "lpu_ids" клиника указывает ожидаемые id филиалов своей сети, в которые застрахованный пациент может обратиться для оказания согласованных услуг после согласования со стороны СК
- Клиника добавляет услуги для согласования к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, для каждой услуги необходимо указать:
- стоимость в поле "price"
- для количественных услуг - их кол-во в поле "count"
- в поле "letter_of_guarantee" значение "false"
- Клиника добавляет информацию из протоколов приёмов (жалобы, анамнез, диагноз и т. п.) к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, указывая id ордера в URL
- Клиника передаёт ордер на согласование СК, передав в поле "status" значение "2" (Ожидает согласования) по методу PATCH /insurance_approval/orders/{uuid}/. После изменения статуса ордера на "2" клиника может вносить изменения в ордер, услуги, протоколы и файлы только, если СК изменит статус ордера на "3" (Запрос дополнительной информации)
- СК запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- СК получает в списке ордеров новый ордер в статусе "2" (Ожидает согласования)
- СК обрабатывает информацию из ордера и принимает решение о запросе дополнительной информации, т. к. недостаточно данных для принятия решения
- СК указывает для каждой услуги, по которой недостаточно информации, комментарий в поле "comment" по методу PATCH /insurance_approval/orders/{uuid}/services/bulk_update/:
- СК передаёт ордер для уточнения информации Клинике по методу PATCH /insurance_approval/orders/{uuid}/:
- указывает общий комментарий к ордеру в поле "information"
- меняет значение поля "status" ордера на "3" (Запрос дополнительной информации)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "3" (Запрос дополнительной информации), где в полях "information" и data.services.comment СК указала, какой информации по каким услугам ей не хватает
- (не обязательно) Клиника добавляет к ордеру документы (анализы, снимки, заключения и т. п.) по методу POST /insurance_approval/orders/{uuid}/attachments/bulk_create/
- Клиника указывает дополнительную информацию и передаёт ордер СК по методу PATCH /insurance_approval/orders/{uuid}/:
- указывает общий комментарий к ордеру в поле "information"
- меняет значение поля "status" ордера на "4" (Дополнительная информация предоставлена)
- СК запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- СК получает в списке ордеров новый ордер в статусе "4" (Дополнительная информация предоставлена), где в поле "information" клиника передала дополнительную информацию и в объекте "data.attachments" передала файлы вложений
- СК по одному запрашивает вложения к ордеру по методу GET /insurance_approval/orders/{uuid}/attachments/{attachment_id}/
- СК обрабатывает полученную информацию и принимает решение о согласовании услуг
- СК приняла решение согласовать услуги и для каждой услуги в ордере указывает в методе PATCH /insurance_approval/orders/{uuid}/services/bulk_update/:
- для каждой несогласованной услуги: в поле "agreed_count" значение "0", в поле "status" значение "4" (Отклонена)
- для каждой согласованной услуги: в поле "agreed_count" - согласованное кол-во, в поле "status" значение "2" (Согласована без ГП)
- СК передаёт согласованный ордер клинике путём изменения значения поля "status" ордера на "5" (Согласовано частично или полностью, нет ГП) по методу PATCH /insurance_approval/orders/{uuid}/
- (необязательно) указывает номер листа согласования в поле approval_list.number
- меняет значение поля "status" ордера на "5" (Согласовано частично или полностью, нет ГП)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "5" (Согласовано частично или полностью, нет ГП) со списком согласованных услуг
Страховая компания инициирует процесс, передавая в клинику ордер и ГП 
Описание: застрахованный пациент обратился в страховую компанию, Страховая компания направила застрахованного пациента в Клинику и заранее направила по API в Клинику ордер без списка услуг. Клиника по итогам проведённого приёма самостоятельно заполняет ордер и отправляет его на согласование
- СК создаёт ордер по методу POST /insurance_approval/orders/. При этом, в поле "lpu_ids" СК указываетid филиалов сети Клиники, в которые застрахованный пациент может обратиться для оказания согласованных услуг
- (не обязательно) СК указывает, в какие филиалы сети Клиники может обратиться застрахованный пациент для оказания согласованных по ГП услуг в методе POST /insurance_approval/orders/{uuid}/filials_for_letter_of_guarantee/bulk_create/. Это необязательная информация - если не указаны конкретные филиалы Клиники, то подразумевается, что застрахованный пациент может обратиться в любой филиал Клиники для оказания согласованных по ГП услуг
- СК загружает файл ГП по методу POST /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/
- СК передаёт согласованный ордер клинике по методу: PATCH /insurance_approval/orders/{uuid}/:
- (необязательно) указывает номер листа согласования в поле approval_list.number
- указывает параметры ГП в объекте "letter_of_guarantee", включая значение поля "money_limit" (лимит ответственности по ГП)
- меняет значение поля "status" ордера на "6" (Согласовано частично или полностью, ГП передано во вложении)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "6" (Согласовано частично или полностью, ГП передано во вложении) со списком согласованных услуг и (не обязательно) списком филиалов, в которых возможно оказание застрахованному пациенту согласованных по ГП услуг
- Клиника запрашивает файл ГП по методу GET /insurance_approval/orders/{uuid}/letter_of_guarantee_pdf/
- Клиника добавляет услуги для оказания застрахованному пациенту в рамках согласованного по ГП лимита ответственности к ордеру по методу POST /insurance_approval/orders/{uuid}/services/bulk_create/, для каждой услуги необходимо указать:
- стоимость в поле "price"
- для количественных услуг - их кол-во в поле "count"
- в поле "letter_of_guarantee" значение "true"
Аннулирование ГП 
Описание: Страховая компания аннулирует ранее выпущенное ГП
Шаги 1-14 идентичны кейсу Клиника запрашивает согласование услуг, ГП ожидается и передаётся
- СК аннулирует ГП по методу PATCH /insurance_approval/orders/{uuid}/:
- в поле "letter_of_guarantee.cancellation_date" необходимо указать дату аннулирования ГП
b. в поле "status" необходимо указать значение "12" (ГП аннулировано)
- в поле "letter_of_guarantee.cancellation_date" необходимо указать дату аннулирования ГП
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "12" (ГП аннулировано)
Отклонение ордера Клиникой 
Описание: Клиника отклоняет ордер на согласование полностью. Отклонить ордер можно вне зависимости от его текущего статуса.
- Клиника отклоняет ордер по методу PATCH /insurance_approval/orders/{uuid}/:
- (не обязательно) указывает причину отклонения в поле "information"
- меняет значение поля "status" на "11" - (Отклонен клиникой)
- СК запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- СК получает в списке ордеров новый ордер в статусе "11" - (Отклонен клиникой)
Статус ордера "11" - (Отклонен клиникой) финальный - редактирование ордера в этом статусе, его услуг, протоколов и т. п. не доступно
Отклонение ордера Страховой компанией 
Описание: СК отклоняет ордер на согласование полностью. Отклонить ордер можно вне зависимости от его текущего статуса
- СК отклоняет ордер по методу PATCH /insurance_approval/orders/{uuid}/:
- (не обязательно) указывает причину отклонения в поле "information"
- меняет значение поля "status" на "13" - (Отклонен СК)
- Клиника запрашивает список ордеров с определённой периодичностью по методу GET /insurance_approval/orders/. Для получения только обновлённых ордеров необходимо указать соответствующие периодичности обновления параметры "dt_updated_gte" и "dt_updated_lte"
- Клиника получает в списке ордеров новый ордер в статусе "13" - (Отклонен СК)
Статус ордера "13" - (Отклонен СК) финальный - редактирование ордера в этом статусе, его услуг, протоколов и т. п. не доступно
Поэтапное согласование услуг страховой компанией, все услуги согласованы 
Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток
Решение:
- Страховая компания получает ордер, не меняя его статус
- Страховая компания, используя метод /insurance_approval/orders/{uuid}/services/bulk_update/, меняет статус 2 услуг на «2 – Согласована без ГП» или «3 – Согласована по ГП» в течение часа
- Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
- Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания согласовала 2 из них и может оказать эти услуги пациенту
- Через сутки страховая компания согласовывает 3ю из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «2 – Согласована без ГП» или «3 – Согласована по ГП» и статус самого ордера на «5 - Согласовано частично или полностью, нет ГП» или «6 - Согласовано частично или полностью, ГП передано во вложении»
Кейс "Поэтапное согласование услуг страховой компанией, не все услуги согласованы" 
Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток
Решение:
- Страховая компания получает ордер, не меняя его статус
- Страховая компания, используя метод /insurance_approval/orders/{uuid}/services/bulk_update/, меняет статус 2 услуг на «2 – Согласована без ГП» или «3 – Согласована по ГП» в течение часа
- Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
- Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания согласовала 2 из них и может оказать эти услуги пациенту
- Через сутки страховая компания согласовывает 3ю из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «4 – Отклонена» и статус самого ордера на «5 - Согласовано частично или полностью, нет ГП» или «6 - Согласовано частично или полностью, ГП передано во вложении»
Кейс "Поэтапное согласование услуг страховой компанией, в согласовании всех услуг отказано" 
Исходные данные: клиника направила ордер на согласование 3 услуг, 2 из которых - амбулаторные и могут быть согласованы страховой компанией в течение 1 часа, а оставшаяся 1 услуга требует госпитализации пациента и может быть согласована в течение суток
Решение:
- Страховая компания получает ордер, не меняя его статус
- Страховая компания, используя метод /insurance_approval/orders/{uuid}/services/bulk_update/, меняет статус 2 услуг на «4 – Отклонена» в течение часа
- Клиника с необходимой периодичностью или вручную запрашивает ордеры по дате обновления
- Клиника при получении обновлённого ордера смотрит на согласованные услуги и получает информацию о том, что страховая компания отказала в согласовании 2 из них
- Через сутки страховая компания отказывает в согласовании 3ей из услуг ордера (госпитализация), при этом меняет статус услуги в ордере на «4 – Отклонена» и статус самого ордера на «13 - Отклонен СК»