Сервис «Прикрепление онлайн» предназначен для обработки заявлений на прикрепление или открепления пациента к/от МО.
Указанный сервис обеспечивает механизмы взаимодействия и обмена сведениями о заявлениях между различными информационными системами.
В состав описания включены схемы процесса, описание используемых технологий, методов, входных и выходных данных.
Обозначения и сокращения
Сокращение (обозначение) |
Значение сокращения (обозначения) |
1 |
2 |
БД |
База данных |
ЕГИСЗ |
Единая государственная информационная система в сфере здравоохранения |
ЕПГУ |
Единый портал государственных и муниципальных услуг (функций). |
ИП ООГУЗ |
Интеграционная подсистема обеспечения оказания государственных услуг в сфере здравоохранения |
МИС |
Медицинская информационная система. |
МО |
Медицинская организация – больница, поликлиника, диспансер и др. Ранее использовался термин «лечебно-профилактическое учреждение» (ЛПУ). |
НСИ |
Нормативно-справочная информация |
ОМС |
Обязательное медицинское страхование |
СНИЛС |
Страховой номер индивидуального лицевого счета застрахованного лица |
ФИО |
Фамилия имя отчество |
FHIR |
Стандарт FHIR (Fast Healthcare Interoperability Resources), разработанный организацией HL7 (https://www.hl7.org/fhir/) |
GUID |
Globally Unique Identifier — англ., глобальный уникальный идентификатор |
HL7 |
Стандарт обмена, управления и интеграции электронной медицинской информации |
OID |
Object Identifier - (англ.) объектный идентификатор |
Описание решения
Назначение сервиса
Сервис предназначен для хранения, поиска и передачи информации между участниками информационного обмена для оказания государственной услуги по смене прикрепления гражданином РФ в рамках региона.
Сервис должен обеспечивать:
- централизованный учет заявок, поступивших с разных внешних информационных систем на смену прикрепления/открепления/отмену;
- передачу информации о заявке в медицинскую информационную систему медицинской организации;
- получение статуса обработки заявления на стороне медицинской организации;
передача информации во внешнюю информационную систему поставщику данных.
Описание информационного взаимодействия
На рис. 1 - 4 представлена схема информационного взаимодействия в рамках оказания услуги по смене прикрепления.
Рис. 1 – Схема информационного взаимодействия (часть 1)
Рис. 2 – Схема информационного взаимодействия (часть 2)
Рис. 3 – Схема информационного взаимодействия (часть 3)
Рис. 4 – Схема информационного взаимодействия (часть 4)
Сценарий информационного взаимодействия:
- Внешняя информационная система или МИС МО передает данные о заявке на прикрепление/открепление/отмену используя соответствующие методы (метод $TaskAttachMessage для прикрепления и открепления, метод POST Task для передачи отмены заявления на смену прикрепления/открепления)
- Пакет и ресурсы в составе заявки регистрируются в сервисе и в ответ возвращаются соответствующие идентификаторы.
- Сервис «Прикрепление онлайн» передает заявку в МИС МО и получает ответ об успешной обработке или отказе в оказании услуги. В случае если заявка не может быть обработана в реальном времени, возвращается соответствующий статус Task in-progress с последующей передачей статуса обработки из МИС МО методом $updateTaskStatus.
- Внешняя информационная система или МИС МО запрашивает текущий статус заявки методом _search
Описание требований к протоколу взаимодействия
Общие требования
Информационный обмен должен осуществляться в соответствии со стандартом HL7 FHIR (Fast Healthcare Interoperability Resources). Используемая версия стандарта FHIR 4.0.0. (http://hl7.org/fhir/)
Протокол информационного взаимодействия с внешними информационными системами должен быть использован RESTful API.
Формат обмена данными: JSON.
В заголовке http должен передаваться Content-type: application/json.
Требования к авторизации
Для передачи данных в сервис необходимо передавать в заголовке сообщения авторизационный токен в формате:
Authorization: N3[пробел][GUID передающей системы] |
GUID передающей системы присваивается на стороне сервиса.
Требования к передаче данных
Текстовая информация, передаваемая в запросах, должна передаваться в кодировке UTF8 (RFC 3629). Фамилия, имя, отчество должно начинаться с большой̆ буквы, далее в нижнем регистре. Остальная текстовая информация передается регистром «Как в предложениях» или в нижнем регистре. Передача текста в верхнем регистре, за исключением аббревиатур, не допускается.
Идентификаторы, используемые для связки ресурсов в запросах, и ссылки на существующие ресурсы в БД должны соответствовать требованиям, предъявляемым к GUID (RFC 4122), буквенные символы должны передаваться в нижнем регистре. Идентификаторы для связки ресурсов в запросах должны начинаться с префикса “urn:uuid:”
OID справочников и OID передающей̆ системы, передаваемые в параметрах “system”, должны начинаться с префикса “urn:oid:”.
OID передающей̆ системы, передаваемые в параметрах “display”, должны передаваться без префикса “urn:oid:”.
Передача пустых значений вида не допускается.
Ресурсы и бандлы, передаваемые в сервис, должны корректно валидироваться как JSON (RFC 8259) и соответствовать правилам стандарта FHIR по структуре и содержанию.
Требования к ответу сервиса
Коды ответов от сервиса
Код |
Описание |
Примечание |
200 |
Успешный ответ |
|
201 |
Успешный ответ, ресурс создан |
Успешный ответ при положительной первоначальной загрузке объекта FHIR в сервисе |
400 |
Ресурс не может быть проанализирован или не прошел валидацию по базовым правилам FHIR |
Ошибка должна выдаваться если запрос сформирован не по стандарту FHIR |
403 |
Ошибка авторизации |
При отсутствии/некорректной авторизации в сервисе |
404 |
Метод не поддерживается/отсутствует информация о ресурсе |
Если вызывается некорректный метод или идет обращение к ресурсу, отсутствующему на стороне сервиса |
409 |
Попытка создания дубля данных |
В случае если внешняя информационная система или МИС МО пытается создать ресурс, уже зарегистрированный в сервисе |
415 |
Неподдерживаемый тип данных |
Отсутствует корректный заголовок content-type или данные переданы не в формате JSON |
422 |
Ошибка валидации |
Передается в случае некорректно предоставленных данных внутри запроса |
500 |
Сервис недоступен. Внутренняя ошибка |
Иные проблемы, возникающие в работе сервиса, не попадающие под описанные проблемы |
504 |
Таймаут |
|
Описание ответа в случае успешной проверки данных
При приеме данных от участников информационного обмена сервис осуществляет проверку данных согласно данному документу.
В случае если успешно принят запрос в ответе от сервиса возвращается код ответа, согласно пункту 2.4.1 настоящего документа, и следующий набор параметров:
- для заявки на прикрепление и открепление от МО, которые передаются через Bundle
Таблица 2 – Описание параметров при успешной проверке Bundle
Параметр |
Описание параметра |
entry |
Массив переданных в запросе ресурсов по каждому передается информация: - fullUrl (переданный̆ в запросе параметр fullUrl преобразуется в ссылку на ресурс для дальнейшего запроса его в сервисе - на новый̆ ресурс или ссылка на найденный̆ в БД ресурс) - resource (непосредственно переданный̆ ресурс) |
- для заявки на отмену заявления в случае передачи одного ресурса Task
Таблица 3 – Описание параметров при успешной проверке Task
Параметр |
Описание параметра |
id |
GUID присвоенный ресурсу |
Описание ответа в случае ошибки в данных
В случае возникновении ошибки в принятых данных, в ответе от сервиса передается ошибка с кодами 400 – 504.
Ошибка передается согласно описанию ресурса FHIR 4.0.0 OperationOutcome, согласно представленной таблице параметров.
Таблица 4 – Описание параметров ресурса OperationOutcome
Параметр |
Описание |
code |
Код ошибки |
diagnostics |
Текст ошибки |
location |
Массив параметров, в которых обнаружена ошибка |
Описание используемых ресурсов при взаимодействии
Описание ресурса Bundle
Ресурс Bundle должен использоваться для передачи более одного ресурса. Формат должен соответствовать требованиям стандарта FHIR 4.0.0, представленному по адресу https://www.hl7.org/fhir/bundle.html.
Состав параметров описан в таблице 5.
Таблица 5 – Описание параметров ресурса Bundle
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса Принимает значение: «Bundle» |
2 |
type |
string |
1..1 |
Всегда передается «transaction» |
3 |
entry |
BackboneElement |
1..1 |
Содержание Bundle. Содержит массив передаваемых ресурсов |
3.1 |
entry.fullUrl |
uri |
1..* |
URI ресурса (UUID). Используется для связи ресурсов внутри Bundle |
3.2 |
entry.resource |
BackboneElement |
1..* |
Ресурс. Содержит параметры передаваемого ресурса |
Описание ресурса Task
Для передачи данных о заявлении на прикрепление, в рамках информационного обмена предусмотрен прием/передача ресурса Task, согласно требованию стандарта FHIR 4.0.0 https://www.hl7.org/fhir/task.html.
Состав параметров описан в таблице 6.
Таблица 6 – Описание параметров ресурса Task
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса Принимает значение: «Task» |
2 |
id |
string |
|
Указывается идентификатор, присвоенный сервисом "Прикрепление онлайн" |
0..1 |
При «status» = «requested» |
|||
1..1 |
Во всех остальных случаях |
|||
3 |
identifier |
identifier |
1..1 |
Сведения об идентификаторе заявления |
3.1 |
identifier.type |
CodebleConcept |
1..1 |
Информация о типе и номере заявления во внешней информационной системе |
3.1.1. |
identifier.type.coding |
CodebleConcept |
1..1 |
Значение типа заявление на смену прикрепления, согласно справочнику 1.2.643.2.69.1.1.1.164 |
3.1.1.1 |
identifier.type.coding.system |
uri |
1..1 |
Кодовое пространство Принимает значение: «urn:oid:1.2.643.2.69.1.1.1.164» |
3.1.1.2 |
identifier.type.coding.code |
string |
1..1 |
Значение из справочника 1.2.643.2.69.1.1.1.164 |
3.1.1.3 |
identifier.type.coding.display |
string |
0..1 |
Строковое представление значения из справочника |
3.2 |
identifier.system |
uri |
1..1 |
Пространство имен идентификатора. Принимает следующие значения: «https://www.gosuslugi.ru/» - для заявлений, поданных с ЕПГУ; «reg_portal» - для заявлений, поданных с регионального портала; «medical_facility»- для заявлений, поданных из МО. |
3.3 |
identifier.value |
string |
1..1 |
Номер заявления о смене прикрепления |
4 |
status |
string |
1..1 |
Статус задачи Принимает следующие значения: Для внешней информационной системы, которая создает задачи о смене прикрепления: · «requested» При передаче в МИС МО: · «accepted» Для МИС МО обрабатывающей запрос: · «in-progress» - запрос принят, ответ будет предоставлен МИС позже · «completed» - в случае положительной обработки запроса · «rejected» - в случае отказа в обработке запроса с указанием причины в statusReason |
5 |
statusReason |
CodebleConcept |
0..1 |
Информация о причине отказа в оказании услуги по смене прикрепления Передается если «status» = «rejected» |
5.1 |
statusReason.coding |
CodebleConcept |
1..1 |
Данные о причине отказа в оказании услуги по смене прикрепления согласно справочнику 1.2.643.5.1.13.13.99.2.646 |
5.1.1 |
statusReason.coding.system |
uri |
1..1 |
Кодовое пространство Принимает значение: «urn:oid:1.2.643.5.1.13.13.99.2.646» |
5.1.2 |
statusReason.coding.code |
string |
1..1 |
Значение из справочника 1.2.643.5.1.13.13.99.2.646 |
5.1.3 |
statusReason.coding.display |
string |
0..1 |
Строковое представление значения из справочника |
6 |
intent |
string |
1..1 |
Обязательный элемент структуры FHIR ресурса Task для передачи. Всегда равен: «order» |
7 |
for |
reference |
|
Передается ссылка на ресурс Patient с содержанием информации о прикреплении |
1..1 |
При Task.identifier.type.coding.code = 1 или Task.identifier.type.coding.code = 2 |
|||
0..1 |
При Task.identifier.type.coding.code = 3 |
|||
7.1 |
for.reference |
uri |
1..1 |
Ссылка на ресурс Patient Передается в формате: При первоначальной загрузке заявки в сервис "Прикрепление онлайн" - "urn:uuid:[GUID присвоенный внешней информационной системой]" При передаче информации в МИС МО и из МИС МО: "Patient/[GUID присвоенный сервисом "Прикрепление онлайн"]" |
8 |
authoredOn |
dateTime |
0..1 |
Дата создания заявления о смене прикрепления |
9 |
lastModified |
dateTime |
0..1 |
Дата изменения заявления о смене прикрепления. Заполняется МИС при обновлении информации о статусе обработки задачи |
10 |
requester |
reference |
|
Заявитель, запрашивающий услугу |
1..1 |
При Task.identifier.type.coding.code = 1 или Task.identifier.type.coding.code = 2 Если пациент заказывает сам, то должна передаваться ссылка на ресурс Patient Если законный представитель, то должна передаваться ссылка на ресурс RelatedPerson |
|||
0..1 |
При Task.identifier.type.coding.code = 3 |
|||
10.1 |
requester.reference |
uri |
1..1 |
Ссылка на ресурс Patient или RelatedPerson Передается в формате: При первоначальной загрузке заявки в сервис "Прикрепление онлайн" - "urn:uuid:[GUID присвоенный внешней информационной системой]" При передаче информации в МИС МО и из МИС МО: "[Patient или RelatedPerson]/[GUID присвоенный сервисом "Прикрепление онлайн"]" |
11 |
owner |
reference |
1..1 |
Организация - исполнитель по заявлению о смене прикрепления |
11.1 |
owner.reference |
uri |
1..1 |
Передается ссылка на организацию из справочника 1.2.643.2.69.1.1.1.64 |
12 |
reasonCode |
CodebleConcept |
0..1 |
Информация о причине смены прикрепления |
12.1 |
reasonCode.coding |
CodebleConcept |
1..1 |
Значение причины смены прикрепления из справочника 1.2.643.2.69.1.1.1.162 |
12.1.1 |
reasonCode.coding.system |
uri |
1..1 |
Кодовое пространство Принимает значение: «urn:oid:1.2.643.2.69.1.1.1.162» |
12.1.2 |
reasonCode.coding.code |
string |
1..1 |
Значение причины из справочника 1.2.643.2.69.1.1.1.162 |
12.1.3 |
reasonCode.coding.display |
string |
0..1 |
Строковое представление значения из справочника |
13 |
note |
аnnotation |
0..* |
Данные о комментарии к задаче |
13.1 |
note.time |
dateTime |
0..1 |
Дата комментария |
13.2 |
note.text |
string |
0..1 |
Комментарий |
Описание ресурса Patient
Данные о пациенте и о его прикреплении должны передаваться в ресурсе Patient, согласно требованиям стандарта FHIR 4.0.0 https://www.hl7.org/fhir/patient.html.
Состав параметров описан в таблице 7.
Таблица 7 – Описание параметров ресурса Patient
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса Принимает значение: «Patient» |
2 |
id |
string |
0..1 |
Указывается идентификатор, присвоенный сервисом "Прикрепление онлайн" |
3 |
identifier |
identifier |
1..* |
Идентификаторы пациента В данном параметре передается информация о полисе пациента и документе, удостоверяющем личность |
3.1 |
identifier.system |
uri |
1..1 |
Пространство имен идентификатора. Принимает следующие значения: «urn:oid:1.2.643.2.69.1.1.1.6.228» - для полиса пациента urn:oid:1.2.643.2.69.1.1.1.6.X - для документа, удостоверяющего личность, где X - код документа из справочника 1.2.643.2.69.1.1.1.6 |
3.2 |
identifier.value |
string |
1..1 |
Значение для идентификатора или для документа. · Для паспорта и свидетельства о рождении указывается [Серия]:[Номер] · Для страхового полиса и временного свидетельства [Номер полиса] В серии допускаются цифры и буквы русского и латинского алфавита. Между символами серии допускается один пробел (10 АА). |
3.3 |
identifier.period |
period |
0..1 |
Период действия для документа, удостоверяющего личность и полиса |
3.3.1 |
identifier.period.start |
dateTime |
1..1 |
Дата начала действия |
3.3.2 |
identifier.period.end |
dateTime |
0..1 |
Дата окончания действия |
3.4 |
identifier.assigner |
assigner |
1..1 |
Передается информация об организации, выдавшей документ, удостоверяющий личность или полис |
3.4.1 |
identifier.assigner.identifier |
identifier |
0..1 |
Данные о коде ОКАТО субъекта РФ, выдавшего полис |
3.4.1.1 |
identifier.assigner.identifier.system |
string |
1..1 |
Пространство идентификатора Принимает значение справочника urn:oid:1.2.643.5.1.13.13.99.2.206 |
3.4.1.2 |
identifier.assigner.identifier.value |
string |
1..1 |
Код региона ОКАТО из справочника 1.2.643.5.1.13.13.99.2.206 |
3.4.2 |
identifier.assigner.display |
string |
1..1 |
Для документа, удостоверяющего личность - [Наименование организации выдавшей документ]:[Код подразделения] Для полиса ОМС принимает значение 1.2.643.5.1.13.13.99.2.183.x, где Х - значение из справочника 1.2.643.5.1.13.13.99.2.183 |
4. |
name |
HumanName |
1..1 |
ФИО пациента |
4.1 |
name.family |
string |
1..1 |
Фамилия пациента |
4.2 |
name.given |
string |
1..2 |
Сначала указывается Имя. Отчество |
5. |
telecom |
telecom |
0..* |
Контактные данные пациента |
5.1 |
telecom.system |
string |
1..1 |
Принимает значения: phone - телефон email - электронная почта |
5.2 |
telecom.value |
string |
1..1 |
значение соответствующего контакта |
6. |
gender |
string |
0..1 |
Пол пациента Принимает значения: «male» - мужчина «female» - женщина |
7. |
birthDate |
dateTime |
1..1 |
Дата рождения |
8. |
address |
address |
2..2 |
Информация об адресе регистрации и адресе проживания |
8.1 |
address.extension |
extension |
0..2 |
Передается информация о коде ФИАС, а также широте и долготе |
8.1.1 |
address.extension.url |
url |
1..2 |
Принимает значения: Для кода ФИАС: «http://fias.egisz.rosminzdrav.ru/house/houseguid» Для передачи информации о широте и долготе: «https://www.hl7.org/fhir/extension-geolocation.html» |
8.1.2 |
address.extension.valueString |
string |
0..1 |
Передается значение кода ФИАС |
8.1.3 |
address.extension. extension |
extension |
0..1 |
Передается информация о широте и долготе |
8.1.3.1 |
address.extension. extension.url |
url |
1..2 |
Принимает значения: Для широты: «latitude» Для долготы: «longitude» |
8.1.3.2 |
address.extension. extension.valueDecimal |
string |
1..2 |
Значения широты и долготы |
8.2 |
address.use |
string |
1..1 |
Принимает значение: «home» - адрес проживания «temp» - адрес регистрации |
8.3 |
address.text |
string |
1..1 |
Полный адрес строкой |
8.4 |
address.line |
string |
0..1 |
Улица, номер дома, номер квартиры |
8.5 |
address.state |
string |
0..1 |
Код региона по ОКАТО |
8.6 |
address.city |
string |
0..1 |
Город |
8.7 |
address.district |
string |
0..1 |
Район |
8.8 |
address.postalCode |
string |
0..1 |
Почтовый индекс |
8.9 |
address.period |
period |
0..1 |
Период действия регистрации |
8.9.1 |
address.period.start |
dateTime |
1..1 |
Дата регистрации по адресу |
9 |
generalPractitioner |
reference |
0..1 |
Информация о заявленном прикреплении к медицинской организации |
9.1 |
generalPractitioner.reference |
urn |
0..1 |
Указывается ссылка на врача в формате "urn:uuid:[GUID врача присвоенный МИС МО]"
Заполняется только медицинской организацией по результату обработки заявления на прикрепление к МО |
9.2 |
generalPractitioner.identifier |
identifier |
1..1 |
Передается информация о прикреплении из заявления |
9.2.1 |
generalPractitioner.identifier.use |
string |
1..1 |
Принимает значение «usual» |
9.2.2 |
generalPractitioner.identifier.system |
urn |
1..1 |
Пространство идентификатора Принимает значение: «urn:oid:1.2.643.5.1.13.2.7.100.9» |
9.2.3 |
generalPractitioner.identifier.value |
string |
1..1 |
Тип прикрепления по специальности врача согласно справочнику 1.2.643.2.69.1.1.1.163 Принимается значение: 1.2.643.2.69.1.1.1.163.X, где X значение из справочника |
9.2.4 |
generalPractitioner.identifier.assigner |
assigner |
0..1 |
Передается информация об организации, к которой прикрепляется пациент по заявлению |
9.2.4.1 |
generalPractitioner.identifier.assigner.reference |
string |
0..1 |
Ссылка на организацию, к которой прикрепляется пациент по заявлению Принимает значение: "Organization/[GUID МО из справочника 1.2.643.2.69.1.1.1.64] |
9.2.4.2 |
generalPractitioner.identifier.assigner.identifier |
string |
0..1 |
Информация об идентификаторе организации, к которой прикрепляется пациент по заявлению Используется в случае, если организация отсутствует в справочнике 1.2.643.2.69.1.1.1.64 и служит для передачи OID структурного подразделения из справочника 1.2.643.5.1.13.13.99.2.114 |
9.2.4.2.1 |
generalPractitioner.identifier.assigner.identifier.system |
string |
1..1 |
Пространство идентификатора Принимает значение: "urn:oid:1.2.643.5.1.13.13.99.2.114" |
9.2.4.2.2 |
generalPractitioner.identifier.assigner.identifier.value |
string |
1..1 |
Передается OID структурного подразделения справочника 1.2.643.5.1.13.13.99.2.114 |
9.2.4.3 |
generalPractitioner.identifier.assigner.display |
|
0..1 |
Наименование врачебного участка Заполняется МИС МО после обработки заявления |
9.3 |
generalPractitioner.display |
string |
0..1 |
Наименование должности врача Заполняется МИС МО после обработки заявления |
10 |
managingOrganization |
reference |
0..1 |
Информация о медицинской организации, к которой прикреплен пациент в момент подачи заявления |
10.1 |
managingOrganization.reference |
string |
0..1 |
Ссылка на организацию, к которой прикреплен пациент на момент подачи заявления Принимает значение: "Organization/[GUID МО из справочника 1.2.643.2.69.1.1.1.64] |
10.2 |
managingOrganization.identifier |
identifier |
0..1 |
Информация об идентификаторе организации, к которой прикреплен пациент на момент подачи заявления по справочнику 1.2.643.5.1.13.13.99.2.114 и дате прикрепления |
10.2.1 |
managingOrganization.identifier.system |
string |
1..1 |
Пространство идентификатора Принимает значение: "urn:oid:1.2.643.5.1.13.13.99.2.114" Используется в случае, если организация отсутствует в справочнике 1.2.643.2.69.1.1.1.64 и служит для передачи OID структурного подразделения из справочника 1.2.643.5.1.13.13.99.2.114 |
10.2.2 |
managingOrganization.identifier.value |
string |
1..1 |
Передается OID структурного подразделения справочника 1.2.643.5.1.13.13.99.2.114 Используется в случае, если организация отсутствует в справочнике 1.2.643.2.69.1.1.1.64 и служит для передачи OID структурного подразделения из справочника 1.2.643.5.1.13.13.99.2.114 |
10.2.3 |
managingOrganization.identifier.period |
period |
0..1 |
Дата прикрепления к МО |
10.2.3.1 |
managingOrganization.identifier.period.start |
dateTime |
1..1 |
Значение даты прикрепления к МО |
11 |
extension |
extension |
0..2 |
Данные о месте рождения и гражданстве пациента |
11.1 |
extension.url |
string |
1..1 |
Принимает значение: Для гражданства: «https://www.hl7.org/fhir/extension-patient-citizenship.html» Для места рождения: «https://www.hl7.org/fhir/extension-patient-birthplace.html» |
11.2 |
extension.valueString |
string |
1..1 |
Значение места рождения или гражданства |
Описание ресурса RelatedPerson
Для передачи данных о законном представителе должен использоваться ресурс RelatedPerson согласно требованиям стандарта FHIR 4.0.0 https://www.hl7.org/fhir/relatedperson.html
Состав параметров описан в таблице 8.
Таблица 8 – Описание параметров ресурса RelatedPerson
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса Принимает значение: «RelatedPerson» |
2 |
identifier |
identifier |
1..* |
Идентификаторы законного представителя В данном параметре передается информация о документе, удостоверяющем личность и СНИЛС законного представителя |
2.1 |
identifier.system |
uri |
1..1 |
Пространство имен идентификатора. Принимает следующие значения: urn:oid:1.2.643.2.69.1.1.1.6.X - для документа, удостоверяющего личность, где X - код документа из справочника 1.2.643.2.69.1.1.1.6 «urn:oid:1.2.643.2.69.1.1.1.6.223» - для СНИЛС |
2.2 |
identifier.value |
string |
1..1 |
Значение для идентификатора или для документа. · Для паспорта и свидетельства о рождении указывается [Серия]:[Номер] · Для СНИЛС [Номер СНИЛС без пробелов и разделителей] В серии допускаются цифры и буквы русского и латинского алфавита. Между символами серии допускается один пробел (10 АА). |
2.3 |
identifier.period |
period |
0..1 |
Период действия для документа, удостоверяющего личность |
2.3.1 |
identifier.period.start |
dateTime |
1..1 |
Дата начала действия |
2.4 |
identifier.assigner |
assigner |
0..1 |
Передается информация об организации, выдавшей документ, удостоверяющий личность или СНИЛС |
2.4.1 |
identifier.assigner.identifier |
identifier |
0..1 |
Данные о коде ОКАТО субъекта РФ, выдавшего полис |
2.4.1.1 |
identifier.assigner.identifier.system |
string |
1..1 |
Пространство идентификатора
Принимает значение «urn:oid:1.2.643.5.1.13.13.99.2.206» |
2.4.1.2 |
identifier.assigner.identifier.value |
string |
1..1 |
Код региона ОКАТО из справочника 1.2.643.5.1.13.13.99.2.206 |
2.4.2 |
identifier.assigner.display |
string |
1..1 |
Для документа, удостоверяющего личность - [Наименование организации выдавшей документ]:[Код подразделения] Для СНИЛС принимает значение "ПФР" |
3 |
patient |
reference |
1..1 |
Ссылка на ресурс Patient законным представителем, которого является |
3.1 |
patient.reference |
url |
1..1 |
Ссылка на ресурс "Пациента" Передается в формате: "urn:uuid:[GUID присвоенный внешней системой]" - в случае первоначальной загрузки "Patient/[GUID присвоенный сервисом]" - после создания ресурса на стороне сервиса (в ответе от сервиса или при повторной загрузке) |
4. |
relationship |
CodeableContent |
0..1 |
Отношение законного представителя к пациенту |
4.1 |
relationship.coding |
coding |
1..1 |
Справочное значение |
4.1.1 |
relationship.coding.system |
url |
1..1 |
Принимается значение «http://terminology.hl7.org/CodeSystem/v3-RoleCode» |
4.1.2 |
Relationship.coding.code |
string |
1..1 |
Принимает следующие значения: «FTH» - Отец «MTH» - Мать «PRNFOST» - Опекун «ADOPTP» - Попечитель |
5. |
name |
HumanName |
1..1 |
ФИО законного представителя |
5.1 |
name.family |
string |
1..1 |
Фамилия законного представителя |
5.2 |
name.given |
string |
1..2 |
Сначала указывается Имя. Отчество |
6. |
gender |
string |
0..1 |
Пол законного представителя. |
7. |
birthDate |
dateTime |
1..1 |
Дата рождения законного представителя |
8. |
extension |
extension |
0..1 |
Данные о гражданстве законного представителя |
8.1 |
extension.url |
string |
1..1 |
Принимает значение: «https://www.api.n3med.ru/fhir/extension-relatedperson-citizenship.html» |
8.2 |
extension.valueString |
string |
1..1 |
Значение гражданства законного представителя |
Описание ресурса Practitioner
Для передачи информации о враче, к которому прикреплен пациент в информационном обмен должен использоваться ресурс Practitioner, согласно требованиям стандарта FHIR 4.0.0 https://www.hl7.org/fhir/practitioner.html.
Состав параметров описан в таблице 9.
Таблица 9 - Описание параметров ресурса Practitioner
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса Принимает значение: «Practitioner» |
2 |
id |
string |
0..1 |
Идентификатор ресурса, присвоенный сервисом |
3 |
identifier |
identifier |
1..* |
Идентификатор врача В данном параметре передается информация о документе, удостоверяющем личность и СНИЛС врача. |
3.1 |
identifier.system |
uri |
1..1 |
Пространство имен идентификатора. Принимает следующие значения: «urn:oid:1.2.643.2.69.1.1.1.6.223» - для СНИЛС |
3.2 |
identifier.value |
string |
1..1 |
Значение для идентификатора. · Для СНИЛС [Номер СНИЛС без пробелов и разделителей] В номере не должны использоваться разделители (пробелы, тире и т.д.), допускаются только цифры. |
3.3 |
identifier.assigner |
assigner |
0..1 |
Передается информация об организации, выдавшей СНИЛС |
3.3.1 |
identifier.assigner.display |
string |
1..1 |
Для СНИЛС принимает значение «ПФР» |
4. |
name |
HumanName |
1..1 |
ФИО врача |
4.1 |
name.family |
string |
1..1 |
Фамилия врача |
4.2 |
name.given |
string |
1..2 |
Сначала указывается Имя. Отчество |
Описание ресурса Parameters
Ресурс Parameters используется в запросах на поиск и обновление статуса работы по заявлению.
Требования к ресурсу Parameters сформированы согласно стандарту FHIR 4.0.0 https://www.hl7.org/fhir/parameters.html.
Состав параметров описан в таблице 10.
Таблица 10 – Описание параметров ресурса Parameters
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
resourceType |
string |
1..1 |
Наименование ресурса
Принимает значение: Parameters |
2 |
parameter |
parameter |
1..* |
Набор параметров запроса |
2.1 |
name |
string |
1..1 |
Наименование параметра, определяемого соответствующим методом |
2.2 |
value[X] |
dataTypes |
1..1 |
Значение соответствующего параметра Х - принимает значения: для строки String для кода из справочника Code |
Описание статусной модели
При обработке заявления используются принятые статусные модели.
Рис. 5 - Статусная модель заявления в режиме реального времени
Описание сценария обработки заявки в режиме реального времени
- Внешняя информационная система или МИС МО регистрирует заявку на обработку в статусе «requested»
- Сервис проверяет заявку и регистрирует в сервисе в статусе «accepted», возвращая его в ответе
- Сервис передает информацию в МИС МО.
- МИС МО возвращает в ответ на запрос информацию о положительном результате обработки заявки «completed» или в отказе в оказании услуги «rejected» с пояснением причин.
Рис. 6 - Статусная модель заявления в режиме с последующей передачей результата
Описание сценария обработки заявки с последующей передачей результата из МИС МО
- Внешняя информационная система или МИС МО регистрирует заявку на обработку в статусе «requested»
- Сервис проверяет заявку и регистрирует в сервисе в статусе «accepted», возвращая его в ответе
- Сервис передает информацию в МИС МО.
- МИС МО подтверждает получение заявки и возвращает статус «in-progress» в ответе.
- МИС МО передает результат обработки заявки в сервис «Прикрепление онлайн»: при положительном результате обработки заявки «completed» или в случае отказа в оказании услуги «rejected» с пояснением причин.
Использование справочников
Справочники, используемые в сервисе Прикрепление онлайн, опубликованы в «Сервисе Терминологии». Описание сервиса Терминологии и правила взаимодействия с ним приведены по ссылке: http://api.n3med.ru/api/nsi/nsi/?tab=177.
Для каждого справочника в настоящем документе указан его OID (объектный идентификатор). Перечень присвоенных корневых OID:
1.2.643.5.1.13.2.1 - Корневой OID справочников, размещённых в Федеральном реестре НСИ (http://nsi.rosminzdrav.ru/);
1.2.643.2.69.1.1.1 – Корневой OID для справочников подсистемы НСИ Регионального фрагмента.
Передача параметров, использующих значения справочников, не указанных в стандарте FHIR, осуществляется в следующей структуре:
"coding": [
{
"system": "urn:oid:[OID справочника в сервисе Терминологии]",
"code": "[код значения]"
}
]
При передаче параметров, использующих значения внутренних справочников FHIR, указывается только код значения (справочники стандарта FHIR также опубликованы в сервисе Терминологии).
Список справочников, используемых в сервисе «Прикрепление онлайн»:
- Тип заявления на смену прикрепления (OID 1.2.643.2.69.1.1.1.164)
- Причины отказа в прикреплении к медицинской организации (OID 1.2.643.5.1.13.13.99.2.646)
- Справочник МО (OID 1.2.643.2.69.1.1.1.64)
- Причина выбора медицинской организации при смене прикрепления (OID 1.2.643.2.69.1.1.1.162)
- Справочник «Тип документа» (OID 1.2.643.2.69.1.1.1.6)
- Субъекты Российской Федерации (OID 1.2.643.5.1.13.13.99.2.206)
- Реестр страховых медицинских организаций (ФОМС) (OID 1.2.643.5.1.13.13.99.2.183)
- Типы прикрепления по специальности врача (OID 1.2.643.2.69.1.1.1.163)
- ФРМО. Справочник структурных подразделений (OID 1.2.643.5.1.13.13.99.2.114)
Метод POST $TaskAttachMessage (передача заявления на смену прикрепления/открепления в медицинскую организацию)
Описание метода
Метод $TaskAttachMessage предназначен для регистрации новой задачи на смену прикрепления/открепление в медицинскую организацию.
Описание входных параметров
Таблица 11 – Описание состава запроса методом $TaskAttachMessage
№ п.п. |
Ресурс |
Описание |
1 |
Task |
Содержит следующую информацию: · о номере и типе заявления; · ссылку на пациента, законного представителя и МО-исполнителя заявки; · о текущем статусе заявления; · о дате создания и последнем обновлении; · о причине смены прикрепления; · о причине отказа в оказании услуги. Заполнение ресурсов идет согласно описанию ресурса Task |
2 |
Patient |
Содержит следующую информацию: · информацию о полисе и документе, удостоверяющем личность пациента; · ФИО пациента и дата рождения; · Пол пациента; · Гражданстве и месте рождения; · Об адресе пребывания и регистрации; · Контактная информация пациента; · Информация о прикреплении из заявления; · Информация о медицинской организации, в которой прикреплен на момент подачи заявления. Заполнение ресурсов идет согласно описанию ресурса Patient. |
3 |
RelatedPerson |
Ресурс передается только когда заявление подано не самим пациентом. В остальных случаях информация о законном представителе отсутствует. Содержит следующую информацию: · информацию о СНИЛС и документе, удостоверяющем личность пациента; · ссылку на ресурс пациента законным представителем которого является; · информацию об отношении законного представителя к пациенту; · ФИО и дата рождения законного представителя; · Пол законного представителя; · Гражданство законного представителя. Заполнение ресурсов идет согласно описанию ресурса RelatedPerson. |
Описание выходных параметров
Описание выходных параметров представлены в разделе 2.4
Метод POST Task (передача заявления на отмену заявления о прикреплении к медицинской организации)
Описание метода
Метод предназначен для передачи задачи на отмену заявления о прикреплении к медицинской организации.
Описание входных параметров
Таблица 12 – Описание состава запроса методом POST Task
№ п.п. |
Ресурс |
Описание |
1 |
Task |
Содержит следующую информацию: · о номере и типе заявления; · о текущем статусе заявления; · о дате создания и последнем обновлении; Заполнение ресурсов идет согласно описанию ресурса Task |
Описание выходных параметров
Описание выходных параметров представлены в разделе Требования к ответу сервиса.
Метод POST $UpdateTaskStatus (обновление статуса обработки заявки)
Описание метода
Метод используется для передачи статуса обработки заявки из МИС МО.
Описание входных параметров
В запросе на обновление статуса передается ресурс Parameters c параметрами, указанными в таблице 13.
Таблица 13 – Описание состава запроса методом POST $UpdateTaskStatus
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
_id |
1..1 |
Идентификатор Task присвоенный сервисом "Прикрепление онлайн" по которому идет обновления статуса |
|
2 |
status |
Task.status |
1..1 |
Статус заявки. Принимает следующие значения: «completed» - Успешно выполнено «rejected» - в услуге отказано |
3 |
identifierSystem |
Task.identifier.type.coding.system |
1..1 |
Кодовое пространство
Принимает значение: «urn:oid:1.2.643.2.69.1.1.1.164» |
4 |
identifierCode |
Task.identifier.type.coding.code |
1..1 |
Код типа заявления из справочника 1.2.643.2.69.1.1.1.164 |
5 |
statusSystem |
Task.statusReason.coding.system |
|
Кодовое пространство Принимает значение: «urn:oid:1.2.643.5.1.13.13.99.2.646» |
1..1 |
При status = rejected
|
|||
0..1 |
При status = completed
|
|||
6 |
statusCode |
Task.statusReason.coding.code |
|
Код причины отказа в услуге по справочнику 1.2.643.5.1.13.13.99.2.646 |
1..1 |
При status = rejected
|
|||
0..1 |
При status = completed
|
|||
7 |
statusComment |
Для статуса completed: Task.note Для статуса rejected: Task.statusReason.coding.display |
1..1 |
Комментарий к статусу |
8 |
PractitionerSurname |
Practitioner.name.family |
Фамилия врача |
|
1..1 |
При status = completed и identifierCode = 1 |
|||
0..1 |
В остальных случаях
|
|||
9 |
PractitionerName |
Practitioner.name.given[1] |
Имя врача |
|
1..1 |
При status = completed и identifierCode = 1 |
|||
0..1 |
В остальных случаях
|
|||
10 |
PractitionerPatronymic |
Practitioner.name.given[2] |
0..1 |
Отчество врача |
11 |
PractitionerSNILS |
Practitioner. identifier.value |
СНИЛС врача |
|
1..1 |
При status = completed и identifierCode = 1 |
|||
0..1 |
В остальных случаях
|
|||
12 |
PractitionerSpecialityName |
Patient.generalPractitioner.display |
Наименование врачебной специальности |
|
1..1 |
При status = completed и identifierCode = 1 |
|||
0..1 |
В остальных случаях
|
|||
13 |
PractitionerArea |
Patient.generalPractitioner.identifier.assigner.display |
Врачебный участок |
|
1..1 |
При status = completed и identifierCode = 1 |
|||
0..1 |
В остальных случаях |
Описание выходных параметров
Описание выходных параметров представлены в разделе Требования к ответу сервиса.
Метод POST _search (поиск заявки)
Метод предназначен для поиска информации в сервисе
Описание входных параметров
В запросе на обновление статуса передается ресурс Parameters c параметрами, указанными в таблице 14.
Таблица 14 – Описание состава запроса методом POST _search
№ п.п. |
Параметр |
Тип |
Кратность |
Описание |
1 |
_id |
1..1 |
Идентификатор Task присвоенный сервисом "Прикрепление онлайн" |
Описание выходных параметров
Выходными параметрами является набор ресурсов, связанных с запросом.
Описание кодов ошибок
Код ошибки |
Описание |
1 |
Внутренняя ошибка сервиса |
2 |
Свойство [Наименование элемента] не заполнено |
3 |
Свойство [Наименование элемента] должно иметь значение [Значение параметра] |
4 |
[Адрес параметра] [Значение параметра] не найдено в сервисе терминологии [OID справочника] |
5 |
Свойство [Наименование элемента] не должно содержать значения в будущем |
6 |
Свойство [Наименование элемента] указано в неверном формате |
7 |
Свойство [Наименование элемента] не должно содержать значения в прошлом |
8 |
Свойство [Наименование элемента] может иметь следующие значения [Значение параметра] |
9 |
Заявка не найдена |
10 |
По заявлению на открепление принимается только положительный ответ |
11 |
По заявке получен результирующий ответ ранее. Данный запрос не может быть выполнен |