Сервис хранения и получения документов

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

Авторизация в сервисе и формат обмена

Для обращения к сервису необходимо указать в заголовке сообщения авторизационный ключ в формате:
Authorization: N3[пробел][GUID]

Авторизационный ключ системе-клиенту сервиса выдается администратором интеграционной платформы N3.Health.

В качестве формата обмена требуется указать:
Content-Type: application/json

Поиск документа по ДМС

Входные данные

Параметр Тип Обязательность Описание
dmsValue
 string 1..1 Номер полиса ДМС
remdCode
 массив 0..* Тип документа по справочнику 1.2.643.5.1.13.13.11.1520
dateStart
 date 1..1 Дата начала поиска
dateEnd
 date 1..1 Дата окончания поиска
oidMo
 oid 1..1 Медицинская организация по ФРМО 1.2.643.5.1.13.13.11.1461

Если не указан remdCode, то сервис возвращает все документы, которые были найдены по карточкам пациента.

Выходные данные

Параметр Тип Описание
idCda
 string Уникальный идентификатор записи CDA
idDocumentMis
 string Идентификатор документа в МИС
remdCode
 int Тип документа по справочнику 1.2.643.5.1.13.13.11.1520
createdDate
 date Дата создания документа
oidMo
 oid Медицинская организация по ФРМО 1.2.643.5.1.13.13.11.1461
statusInfo
 массив Информация по статусу документа
    idFederalSystem
 int Тип федеральной подсистемы:
0 — Не было выгрузки
1 — ФИЭМК
2 — РЭМД
3 — ВИМИС
    idRecipientSystem
 int Идентификатор нозологии ВИМИС
    status
 string Статус
    statusDescription
 string Описание статуса

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

POST http://b2b-demo.n3health.ru/sds/Documents/SearchByPatientDms
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

{
«dmsValue»: «12345678910111213»,
«remdCode»: [«227″,»68″,»119»],
«dateStart»: «2025-04-07»,
«dateEnd»: «2025-04-10»,
«oidMo»: «1.2.643.5.1.13.13.12.2.78.8755»
}

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

{
        «idCda»: «8d096793-51e6-4ae7-b55f-9f294077f403»,
        «idDocumentMis»: «REMD_ehrrecord_6561»,
        «remdCode»: [ 227 ],
        «createdDate»: «2025-05-20T09:49:51+03:00»,
        «oidMo»: «1.2.643.5.1.13.13.12.2.78.8755»,
        «statusInfo»: [
            {
                «idFederalSystem»: 2,
                «idRecipientSystem»: null,
                «status»: 4,
                «statusDescription»: «Валидация документа прошла успешно»
            }
        ]
}

Поиск документа по Типу документа

Входные данные

Параметр Тип Обязательность Описание
IdMedDocumentType массив 1..* Идентификатор типа медицинского документа по справочнику 1.2.643.2.69.1.1.1.195
dateStart
 date 1..1 Дата начала поиска
dateEnd
 date 1..1 Дата окончания поиска

Выходные данные

Параметр Тип Описание
idCda
 string Уникальный идентификатор записи CDA
idDocumentMis
 string Идентификатор документа в МИС
idMedDocumentType
 int Тип документа по справочнику 1.2.643.2.69.1.1.1.195
idPatient
 string Идентификатор карточки пациента
mcard
 string Идентификатор Мастер карты пациента

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

POST http://b2b-demo.n3health.ru/sds/Documents/SearchByType
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

{
«IdMedDocumentType»: [316,198],
«dateStart»: «2025-04-07»,
«dateEnd»: «2025-05-24»
}

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

[
    {
        «idCda»: «c387e725-4cbа-4e07-8e73-94cеef19b724»,
        «idDocumentMis»: «3»,
        «idMedDocumentType»: 316,
        «idPatient»: «b6a6eе00-6a07-4dbb-afе9-ee7704900242»,
        «mcard»: null
    },
    {
        «idCda»: «1е2a4аa4-6846-47f7-abe1-7ceafac84bfa»,
        «idDocumentMis»: «ABСBFA0A7-6977-4432-A6CС-D8B5FED3348F»,
        «idMedDocumentType»: 198,
        «idPatient»: «948028fd-4c2e-4e5e-99bb-b31d43b724b2»,
        «mcard»: null
    }
]

Поиск документа по Типу документа и ЛПУ

Входные данные

Параметр Тип Обязательность Описание
IdMedDocumentType массив 1..* Идентификатор типа медицинского документа по справочнику 1.2.643.2.69.1.1.1.195
dateStart
 date 1..1 Дата начала поиска
dateEnd
 date 1..1 Дата окончания поиска
idLpu массив 1..* Идентификатор медицинской организации по справочнику 1.2.643.2.69.1.1.1.64

Выходные данные

Параметр Тип Описание
idLpu
 string Идентификатор медицинской организации по справочнику 1.2.643.2.69.1.1.1.64
idCda
 string Уникальный идентификатор записи CDA
idDocumentMis
 string Идентификатор документа в МИС
idMedDocumentType
 int Тип документа по справочнику 1.2.643.2.69.1.1.1.195
idPatient
 string Идентификатор карточки пациента
mcard
 string Идентификатор Мастер карты пациента

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

POST http://b2b-demo.n3health.ru/sds/Documents/SearchByTypeIdLpu
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

{
«IdMedDocumentType»: [«316″,»293″,»198»],
«dateStart»: «2025-04-07»,
«dateEnd»: «2025-07-29»,
«idLpu»: [«1c3b6b34-356c-4549-bb4a-b91e7b05a11c»,»72a86c5a-9ebf-4eb7-ba41-4e69222308a8″]
}

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

[
    {
        «idLpu»: «1c3b6b34-356c-4549-bb4a-b91e7b05a11c»,
        «idCda»: «0d151431-cd2d-41f3-8b00-32e566cf6ebf»,
        «idDocumentMis»: «5»,
        «idMedDocumentType»: 316,
        «idPatient»: «3a66563a-06b7-4c34-82ff-a32f708b294e»,
        «mcard»: null
    },
    {
        «idLpu»: «72a86c5a-9ebf-4eb7-ba41-4e69222308a8»,
        «idCda»: «6755156d-a469-4db2-b745-47d3f3e85453»,
        «idDocumentMis»: «-5106534569952410475»,
        «idMedDocumentType»: 293,
        «idPatient»: «ad835483-c2fa-4622-80f9-092851e38766»,
        «mcard»: null
    }
]

Поиск документа по Пациенту

Входные данные

Параметр Тип Обязательность Описание
IdPatient* массив 1..* Идентификатор карточки пациента
mcard* массив 1..* Идентификатор Мастер карты пациента
dateStart
 date 1..1 Дата начала поиска
dateEnd
 date 1..1 Дата окончания поиска
IdMedDocumentType массив 1..* Идентификатор типа медицинского документа по справочнику 1.2.643.2.69.1.1.1.195
Status массив 1..* Результат обработки полученного запроса:
1. Документ добавлен успешно
2. Ошибка обработки документа
3. Ошибка федерального сервиса
4. Валидация документа прошла успешно
5. Ответ ФЛК федерального сервиса

*Должен быть заполнен один из параметров: IdPatient или mcard

Выходные данные

Параметр Дочерний элемент Тип Описание
idCda
 
 string Уникальный идентификатор записи CDA
idMedDocumentType
 
 int Тип документа по справочнику 1.2.643.2.69.1.1.1.195
CreatedDate   date Время передачи документа в систему
StatusInfo   массив Идентификатор Мастер карты пациента
  idFederalSystem int Идентификатор системы получателя:
1 — ФИЭМК
2 — РЭМД
3 — ВИМИС
  idRecipientSystem int *заполняется если idFederalSystem=3
Нозология ВИМИС:
1 — ВИМИС «АкиНео»
2 — ВИМИС «Онкология»
3 — ВИМИС «ССЗ»
4 — ВИМИС «Профилактика»
5 — ВИМИС «Инфекционные болезни»
  Status массив Результат обработки полученного запроса:
1. Документ добавлен успешно
2. Ошибка обработки документа
3. Ошибка федерального сервиса
4. Валидация документа прошла успешно
5. Ответ ФЛК федерального сервиса
IdPatient   string Идентификатор карточки пациента
mcard   string Идентификатор Мастер карты пациента

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

POST http://b2b-demo.n3health.ru/sds/Documents/SearchByPatient
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

{
«idPatient»: [«6994a704-dc8e-4a85-8a48-021d5add81cf»,»36704b47-237c-49a1-aa02-08aac503b99e»],
«dateStart»: «2025-04-07»,
«dateEnd»: «2025-05-24»,
«IdMedDocumentType»: [«316″,»293″,»198»],
«Status»: [«1″,»2″,»3″,»4″,»5»]
}

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

[
 
]

Поиск документа по идентификатору пациента МИС

Входные данные

Параметр Дочерний элемент Тип Обязательность Описание
idPatientMis
   string 1..* Идентификатор пациента в МИС
idLpu   string 1..1 Идентификатор медицинской организации по справочнику 1.2.643.2.69.1.1.1.64
misOid
   oid 1..1 Идентификатор МИС по справочнику 1.2.643.2.69.1.2
idMedDocumentType
 
   массив 1..* Тип документа по справочнику 1.2.643.2.69.1.1.1.195
period
     1..1 Период, в который документ должен был быть создан
  dateStart date 1..1 Дата начала поиска
  dateEnd date 1..1 Дата окончания поиска

Выходные данные

Параметр Тип Описание
idCda
 string Уникальный идентификатор записи CDA
idDocumentMis
 string Идентификатор документа в МИС
idMedDocumentType

 
 массив Тип документа по справочнику 1.2.643.2.69.1.1.1.195
creationDate date Дата создания документа
idPatient
 string Идентификатор карточки пациента
idLpu
 string Идентификатор медицинской организации по справочнику 1.2.643.2.69.1.1.1.64

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

POST http://b2b-demo.n3health.ru/sds/Documents/SearchByPatientMis
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

{
«idPatientMis»: «TyshaWithDoc»,
«idLpu»: «91593c1f-c130-4312-9a97-8c017de6a1de»,
«misOid»: «1.2.643.2.69.1.2.115»,
«idMedDocumentType»: [227,68,119],
«period»: {
«dateStart»: «2025-01-01»,
«dateEnd»: «2026-01-10»
}
}

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

[
{
«idCda»: «3fa85f64-5717-4562-b3fc-2c963f66afa6»,
«idDocumentMis»: «string»,
«idMedDocumentType»: 195,
«creationDate»: «2025-07-31T12:57:28.431Z»,
«idPatient»: «3fa85f64-5717-4562-b3fc-2c963f66afa6»,
«idLpu»: «3fa85f64-5717-4562-b3fc-2c963f66afa6»
}
]

Получение документа по идентификатору idCda

После получения идентификатора документа idCda, можно запросить по нему документ.

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

Get http://b2b-demo.n3health.ru/sds/Documents/GetXmlBody/{idCda}
Content-Type: application/json
Authorization: N3 b1f40с77-9ddf-4707-894d-04835сс16162

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

{
«id»: «8d096793-51e6-4ae7-b55f-9f294077f403»,
«xmlBody»: «base64»
}