Authorization	Обязателен	44556afd-0e84-b847-2322-75999668f590	Авторизационный токен. Выдается разработчику МИС администратором Интеграционной платформы;
X-Id-Lpu	Обязателен	12346afd-0e84-b847-2322-75999668f500a	Уникальный идентификатор ЛПУ в системе согласно справочнику 1.2.643.2.69.1.1.1.64

Поле	Тип	Обязательность	Описание
Authorization	string	Обязательно	Авторизационный токен. Выдается разработчику МИС администратором Интеграционной платформы. Формат: 44556afd-0e84-b847-2322-75999668f590
X-Id-Lpu	string	Обязательно	Уникальный идентификатор ЛПУ в системе
Content-Type	string	Обязательно	multipart/form-data; boundary=—-pepsign

Поле	Тип	Обязательность	Описание
idLpu	string	Обязательно	Уникальный идентификатор ЛПУ в системе согласно справочнику 1.2.643.2.69.1.1.1.64

Поля объектов в telecom:

Поле	Тип	Обязательность	Описание
system	string	Обязательно	Тип контакта: «Email» или «Telephone»
value	string	Обязательно	Значение (email/телефон). Телефон в формате +7XXXXXXXXXX.

Поле	Тип	Обязательность	Описание
mrProxyNumber	string	Опционально	Номер машиночитаемой доверенности (например, 12-52884аАА)
familyName	string	Обязательно	Фамилия
givenName	string	Обязательно	Имя
middleName	string	Опционально	Отчество
userIdLpu	string	Обязательно	Идентификатор врача в ЛПУ
snils	string	Обязательно	СНИЛС сотрудника
telecom	array	Опционально	Контактные данные (аналогично organization.telecom)

Поле	Тип	Обязательность	Описание
idPatientMis	string	Обязательно	ID пациента в МИС (например, patient-456)
mpiId	string	Опционально	MPI ID из ИЭМК (например, 123e4567-e89b-12d3-a456-426614174000)
familyName	string	Обязательно	Фамилия
givenName	string	Обязательно	Имя
middleName	string	Опционально	Отчество
birthDate	string	Обязательно	Дата рождения в формате YYYY-MM-DD
sex	string	Обязательно	Пол: male или female
telecom	array	Обязательно	Минимум 1 объект с system: «Telephone».

Документы пациента (documentDto):

Поле	Тип	Обязательность	Описание
providerName	string	Обязательно	Кто выдал документ (например, «ОВД», «ПФР»)
issuedDate	string	Опционально	Дата выдачи (YYYY-MM-DD)
docN	string	Обязательно	Номер документа
docS	string	Обязательно	Серия документа (если есть)
documentName	string	Опционально	Название документа (например, «СНИЛС»)
idDocumentType	integer	Обязательно	Код типа документа: • 14 — паспорт РФ • 223 — СНИЛС • 240 — полис ДМС (полный список в справочнике 1.2.643.2.69.1.1.1.6)

Поле	Тип	Обязательность	Описание
esiaAuth	boolean	Опционально	true — требуется подпись через ЕСИА. Если комплект содержит шаблон ИДС – обязательно указывайте TRUE. Рекомендуется предусмотреть в используемой системе флаг для шаблона документа – ИДС.
attachments	array	Обязательно	Массив вложений.

Вложения (attachments):

Поле	Тип	Обязательность	Описание
partName	string	Обязательно	Оригинальное название файла <String>
documentType	string	Опционально	Тип вложения: • 1 — медицинские • 2 — бухгалтерские • 3 — прочие

MIME Type
.doc	application/msword
.docx	application/vnd.openxmlformats-officedocument.wordprocessingml.document
.pdf	applicatiapplication/pdfon/pdf
.odt	application/vnd.oasis.opendocument.text

Поле	Тип	Обязательность	Описание
delivery	array	Обязательно	Способы доставки:  • «sms»  • «max» • «mila»

400	INVALID_SIGNTOKEN	Неверный SIGNTOKEN: проверьте, что токен выдан для передаваемых guid и IdLpu
403	ESIA_AUTH_REQUIRED	Ошибка авторизации ЕСИА
403	PATIENT_NO_DATA	Не все обязательные поля переданы ВЫВОДИТ СПИСОК ТРЕБУЕМЫХ ПОЛЕЙ
403	PATIENTS_DENIED	Запрет со стороны пациента
403	INVALID_BASE64	«Некорректные данные в поле Content»
403	EMPTY_ARRAY	Обязательное поле не может быть пустым.
429	RATE_LIMIT_EXCEEDED	Превышен лимит запросов

Статусы

201	Создан	Created	Документ создан через API, готов к обработке
202	Отправлен на подписание	Sent for Signing	Документ отправлен получателю
203	Просмотрел	Viewed	Документ просмотрен получателем
204	Подписал	Signed	Документ подписан получателем
205	Отказался	Rejected	Получатель отказался от подписания
206	Срок для подписания истек	Signing Period Expired	Срок действия ссылки истек до момента проставления подписи или отказа
207	Ожидание действий всех получателей	Awaiting Actions from All Recipients	Ожидание действий от всех получателей
210	Завершено. Подписано всеми	Completed. Fully Signed	Все получатели подписали, документ сохранен
211	Завершено. Подписано не всеми	Completed. Partially Signed	Не все получатели подписали, документ сохранен
212	Отменен для получателя	Cancelled for Recipient	Подписание отменено для конкретного получателя
213	Завершено. Отменено для всех	Completed. Cancelled for All	Подписание отменено для всех получателей
214	Успешно. Требуется подписание УКЭП	UKEP required	Требуется подписание УКЭП медицинского работника
498	Завершено. Отклонено всеми	Completed. Rejected by All	Все получатели отказались от подписания
499	Завершено. Истекло для всех	Completed. Expired for All	Срок ссылки истек для всех получателей
500	Ошибка обработки	Processing Error	Ошибка во время обработки документа
501	Ошибка доставки получателю	Delivery Error	Произошла ошибка при доставке конкретному получателю

Лимиты

SEP_API_BLOCKED_ALLOW включает и отключает механизм блокировки
SEP_API_BLOCKED_TIME=15 SEP_API_BLOCKED_PERIOD=10 SEP_API_BLOCKED_COUNT=50 SEP_API_BLOCKED_ALLOW=true	в данной конфигурации можно делать 50 запросов к POST /signing в 10 минут, если больше — блокировка на 15 минут

Повторная отправка уведомления

Описание

Метод для повторной отправки уведомления о необходимости подписания документа по указанному trackingId. Позволяет изменить способ доставки уведомления.

Базовые параметры
Демо-окружение: https://b2b-demo.n3health.ru
Базовый путь API: /sep/api
Полный базовый URL: https://b2b-demo.n3health.ru/sep/api

HTTP-запрос
POST https://b2b-demo.n3health.ru/sep/api/resend

Заголовки (Headers)

{
  «trackingId»: «string»,
  «delivery»: [«string»],
  «IdPatientMis»: [«string»]
}

Параметры

trackingId	string	Да	Идентификатор отслеживания подписания (полученный при первоначальной отправке)	«8da15c45-3b27-8727-77dd-9de51d0aa920»
delivery	array[string]	Да	Способ доставки нового уведомления. Возможные значения: sms, max, mila, goskey	[«mila»]
IdPatientMis	array[string]	Да	Идентификатор пациента в отправляющей системе	[«singaevDemo1234»]

Пример запроса

POST https://b2b-demo.n3health.ru/sep/api/resend
Authorization: 53656afd-0e84-77dd-5555-9de51d0aa920
X-Id-Lpu: 1234937e-bla4-707d-abcd-3ce6df2bf6fe
Content-Type: application/json

{
  "trackingId": "8da15c45-3b27-8727-77dd-9de51d0aa920",
  "delivery": ["mila"],
  "IdPatientMis": ["singaevDemo1234"]
}

Ответ

Успешный ответ (200 OK):

{   «success»: true,   «message»: «Уведомление успешно повторно отправлено»,   «tracking_id»: «a8cc6886-956f-42e4-aa3c-742df306930f»}

Ошибка (400 Bad Request):

{   «error»: «Документ не найден»,   «message»: «Tracking ID не существует» }

{   «error»: «IdPationMis не найден»,   «message»: «IdPationMis  не существует или не соответствует «trackingId» }

Ошибка (404 Not Found):

{   «error»: «Документ не найден»,   «message»: «Tracking ID не существует» }

Важные примечания

1. Формат IdPatientMis: Параметр передается как массив строк для поддержки будущей функциональности отправки уведомлений нескольким пациентам по одному отправлению.

2. Соответствие ID: IdPatientMis должен соответствовать тому, который был указан при первоначальной отправке документа.

3. Окружения:

   • Тестовое (demo): https://b2b-demo.n3health.ru

   • Продакшен (production): https://b2b.n3health.ru

4. Способы доставки: Доступные значения для поля delivery:

   • sms — SMS-сообщение

   • max — MAX-сообщение

   • mila — Mila-сообщение

   • goskey — Goskey-сообщение

5. Таймауты: Рекомендуемый таймаут для запроса — 30 секунд.

6. Логика биллинга на текущий момент. Если ранее было отправлено не СМС, то отправление снимается тарификации, создается новая биллинговая запись с новым указанными типом. Если СМС, то тарификация по факту отправки.

Будущие обновления

• Множественная отправка: В ближайших обновлениях будет реализована возможность отправки уведомлений нескольким пациентам по одному отправлению. Для этого массив IdPatientMis может содержать несколько идентификаторов пациентов.

Запрос на локальное подписание КЭП

1. Базовые параметры
Демо-окружение: https://b2b-demo.n3health.ru
Базовый путь API: /sep/api
Полный базовый URL: https://b2b-demo.n3health.ru/sep/api/initqes

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

Описание

Метод для отправки открепленной подписи КЭП указанному trackingId. После локального подписания КЭПом через initQes комплекта документов.  
Доступна выдача при GET запросе по trackingId. 
Метод можно будет успешно исполнен при статусах trackingId 208, 209, 201, 211, 214

В ответ возвращается ссылка qesLink переход на которую должен быть осуществлен в браузере имеющем установленный КриптоПро плагин и настроен сертификат с локальным СКЗИ.

После процесса подписания на документ будет наложена визуализация подписи КЭП и возможность скачать результаты: PDF + .SIG А итоговый файл будет помещен в хранилище N3health и доступен для получения через GET методы.

HTTP-запрос

POST https://b2b-demo.n3health.ru/sep/api/initqes

Заголовки (Headers)

 

{
  «trackingId»: «8da15c45-3b27-8727-77dd-9de51d0aa920»,
  «practitioner»: {
    «familyName»: «Иванов»,
    «givenName»: «Иван»,
    «middleName»: «Иванович»,
    «snils«: «12345678912», // Обязательно для валидации
    «certificateThumbprint«: «A1B2C3D4E5F6…», // Опционально
    «userIdLpu»: «doc-123»,
    «telecom»: [
      { «system»: «Email», «value»: «email@example.com» },
      { «system»: «Telephone», «value»: «+71234567890» }
    ]
  }
}

Параметры

Пример запроса

POST https://b2b-demo.n3health.ru/sep/api/initqes
Authorization: 53656afd-0e84-77dd-5555-9de51d0aa920
X-Id-Lpu: 1234937e-bla4-707d-abcd-3ce6df2bf6fe
Content-Type: application/json

{
  «trackingId»: «8da15c45-3b27-8727-77dd-9de51d0aa920»,
     «practitioner»: {
    «mrProxyNumber»: «12-52884аАА»,
    «familyName»: «Иванов», 
    «givenName»: «Иван», 
    «middleName»: «Иванович»,
    «userIdLpu»: «doc-123»,
    «snils»: «12345678912»,
    «certificateThumbprint»: «A1B2C3D4E5F6…»,
    «telecom»: [ 
      { «system»: «Email», «value»: «email@example.com» },
      { «system»: «Telephone», «value»: «+71234567890» }
    ]
}

Ответ

• Успешный ответ (200 OK):
  {
    «success»: true,
    «message»: «Подпись успешно добавлена, и будет доступна после индексации»,
    «tracking_id»: «a8cc6886-956f-23e4-aa3c-742df306930f»,
    «qesLink»: «https://b2b-demo.n3health.ru/sep/mis/qes/addqes-t?trackingId=cd6899fe-9ae6-4b86-ac48-8cefe6db749b&thumbprint=231B6DEE3B12348A3C6BACF943EFD7788B8E69EC«
  }
  

• Ошибка (400 Bad Request):

  {   «error»: «Документ не найден»,   «message»: «Tracking ID не существует»,  «tracking_id»: «a8cc6886-956f-42e4-aa3c-742df306930f» }

  {   «error»: «Документ не соответствует»,   «message»: «Tracking ID не соответствует указанной организации, проверьте токен доступа или трекинг номер»,  «tracking_id»: «a8cc6886-956f-42e4-aa3c-742df306930f» }

  {   «error»: «Метод недоступен для текущего статуса trackingId»,   «message»: «Статус TrackingID должен быть trackingId 208, 209, 201, 211, 214 «,  «trackingStatus»: «203» } 

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

https://cryptopro.ru/products/cades/plugin/ плагин

КриптоПро CSP важно — подписание осуществляется локально. Таким образом должна быть приобретена поставка КриптоПро CSP c Поддержкой КриптоПро TSP Клиент 2.0 для проставления метки доверенного времени в состав подписываемой информации для долговременного хранения.

https://docs.cryptopro.ru/cades/plugin/plugin-installation-windows

https://docs.cryptopro.ru/cades/plugin/plugin-installation-unix

https://docs.cryptopro.ru/cades/plugin/plugin-installation-macos

Проверка установки 
https://docs.cryptopro.ru/cades/plugin/plugin-usage

ВЕБ ИНСТРУМЕНТЫ ДЛЯ РАБОТЫ С СЕРТИФИКАТАМИ И ПЛАГИНОМ
https://www.cryptopro.ru/sites/default/files/products/cades/demopage_2024-08-09/webtools.html

Запрос на локальное подписание КЭП списка отправлений

Базовые параметры
Демо-окружение: https://b2b-demo.n3health.ru
Базовый путь API: /sep/api
Полный базовый URL: https://b2b-demo.n3health.ru/sep/api

Метод: Инициализирует последовательное проставление квалифицированной электронной подписи (КЭП) списку отправлений, подписанных пациентом.

Описание

Метод пакетного подписания QES (КЭП) работником отправлений по trackingIds ИЛИ заданным параметрам.
В ответ на запрос возвращается ссылка /addbatchqes переход на которую должен быть осуществлен в браузере, имеющем установленный КриптоПро плагин и настроен сертификат с локальным СКЗИ.
onlyPractitioner и onlyPractitionerCertificateThumbprint — передаются в параметрах ссылки вместе с отпечатком.
«batchQesLink»: «https://sep.mila.online/sep/mis/qes/addbatchqes?id=96c6a822-7cc2-4ed9-9ba6-c60b4a468e03&thumbprint=A1B2C3…&onlyPractitioner=true&onlyPractitionerCertificateThumbprint=true»

Перед подписанием на документ будет наложена визуализация подписи КЭП. После подписания документы сохраняются в Сервисе Электронной Подписи и доступны через GET-методы.

Внешняя информационная система может осуществить следующие сценарии:

• Отправка массива trackingIds конкретных отправлений для проставления КЭП
  Будет инициировано подписание только trackingIds из запроса.
• Отправить запрос по параметрам, без указания конкретных trackingIds 
  В таком случае будет осуществлена выборка в соответствии с передаваемыми параметрами.

Важно: без явного указания статусов возвращаются отправления в статусе 214 (требуется подписание КЭП).

по дате — все отправления конкретного работника за период.

по дате и статусу — все отправления конкретного работника за период и статусы

Особенности в личном кабинете работника WEB
В личном кабинете работника при выполнении групповой операции подписания initBatchQes — всегда передается practitioner, таким образом в UI возможно инициировать подписание отправлений выполненных от имени текущего работника. Ограничение установлено для избежания наложения подписи на отправления, к которым работник не имеет отношения.

Если медицинскому работнику необходимо подписать отправление КЭП-ом, которое изначально он не инициировал в адрес пациента (например оформлено медицинским регистратором), то такое отправление возможно подписать через соответствующее индивидуальное меню отправления («шестеренку» опций).

Запрос

POST https://b2b-demo.n3health.ru/sep/mis/api/initbatchqes

Заголовки (Headers)

{"trackingIds": ["34a987b7-b042-4e6f-a8c1-19ffd9066786", "52c94dcd-b470-48e4-8449-443480732a1b", "5ad07a15-33b6-4699-a0f3-63f9d5b04e2c", "0c585017-e776-4eda-99ba-492959a17736"],
  "certificateThumbprint": "A1B2C3...",
  "dateFrom": "2025-03-01",
  "dateTo": "2025-03-20",
  "statuses": ["214", "210", "211"],
  "practitioner": {
    "snils": "1234567899",
    "userIdLpu": "doc-Id123"
  },
  
}

либо

{
  "trackingIds": ["34a987b7-b042-4e6f-a8c1-19ffd9066786", "52c94dcd-b470-48e4-8449-443480732a1b", "5ad07a15-33b6-4699-a0f3-63f9d5b04e2c", "0c585017-e776-4eda-99ba-492959a17736"],
  "practitioner": {
    "snils": "1234567899",
    "userIdLpu": "doc-Id123"
  }
}

Параметры тела запроса 

* должен быть передан один из идентификаторов. **Либо trackingIds либо параметры.

Примеры запросов

POST https://b2b-demo.n3health.ru/sep/mis/api/initbatchqes
Authorization: 53656afd-0e84-77dd-5555-9de51d0aa920
X-Id-Lpu: 1234937e-bla4-707d-abcd-3ce6df2bf6fe
Content-Type: application/json

{
 

Примеры запросов

// 1. Подписание конкретных отправлений по trackingIds с авто-выбором сертификата
{
  "trackingIds": [
    "8da15c45-3b27-8727-77dd-9de51d0aa920",
    "a1b2c3d4-5e6f-7890-abcd-ef1234567890"
  ],
  "certificateThumbprint": "A1B2C3..."
}

// 2. Подписание всех отправлений работника за период (статус 214)
{
  "practitioner": {
    "snils": "12345678990"
  },
  "dateFrom": "2025-03-01",
  "dateTo": "2025-03-20"
}

// 3. Подписание отправлений работника за период с указанием статусов
{
  "practitioner": {
    "userIdLpu": "doc-12345"
  },
  "dateFrom": "2025-03-01",
  "dateTo": "2025-03-20",
  "statuses": ["210", "214"]
}

// 4. Фильтрация отправлений по работнику + обязательный сертификат этого же работника
{
  "practitioner": {
    "snils": "12345678990"
  },
  "dateFrom": "2025-03-01",
  "dateTo": "2025-03-20",
  "statuses": ["214"],
  "onlyPractitioner": true,
  "onlyPractitionerCertificateThumbprint": true,
  "certificateThumbprint": "A1B2C3..."
}

Примеры ответов

Успешный ответ (200 OK)

{
  "success": true,
  "message": "Сессия подписания создана",
  "batchQesLink": "https://sep.mila.online/sep/mis/qes/addbatchqes?trackingId=96c6a822-7cc2-4ed9-9ba6-c60b4a468e03&thumbprint=A1B2C3...&onlyPractitioner=true&onlyPractitionerCertificateThumbprint=true"
}

Ошибка: не передан ни trackingIds, ни practitioner (400 Bad Request)

{
  "error": "Недостаточно параметров",
  "message": "Необходимо указать trackingIds или practitioner (snils/userIdLpu)"
}

Ошибка: не переданы обязательные параметры (400 Bad Request)

{
  "error": "Недостаточно параметров",
  "message": "onlyPractitionerCertificateThumbprint = true, а certificateThumbprint отсутствует. Для принудительного выбора сертификата необходимо передать certificateThumbprint"

}

Ошибка: работник не найден (404 Not Found)

{
  "error": "Practitioner not found",
  "message": "Работник с указанным snils=12345678990 не найден"
}

Ошибка: некорректный формат даты (400 Bad Request)

{
  "error": "Invalid date format",
  "message": "dateFrom должен быть в формате YYYY-MM-DD"
}

Примечания

• Если указан trackingIds, остальные параметры игнорируются.

• Если trackingIds не указан, обязательно должен быть задан practitioner (через snils или userIdLpu).

• Без явного указания statuses подбираются отправления только в статусе 214 (ожидают подписания КЭП).

• После получения batchQesLink необходимо открыть её в браузере с установленным КриптоПро плагином и настроенным сертификатом.

МЕТОДЫ GET

Методы предназначены для получения списка отправлений по организации и пациенту или получения конкретного отправления по его трекинг — ID в системе СЭП.