Руководство к использованию стандарта FHIR в ЦИСЗ (ВЕТКА release-1-4-t2-10-26-18)
1.4.463 - ci-build
Руководство к использованию стандарта FHIR в ЦИСЗ (ВЕТКА release-1-4-t2-10-26-18)
1.4.463 - ci-build
Метод предназначен для импорта пакета данных организации здравоохранения, сформированного в МИС ОЗ, в ЦИСЗ.
Последовательность действий для использования метода:
Bundle типа transaction по профилю Пакет информации в контексте организации;Bundle, а в заголовках запроса устанавливается тип передаваемого контента (content-type) в application/json.Транзакция (transaction) – действие, которое необходимо произвести над ресурсом.
Доступны следующие типы транзакций:
POST);PUT).Тип транзакции задается в элементе Bundle.entry.request профиля Пакет информации в контексте организации. Ресурс Bundle типа transaction представляет собой ресурсы, размещенные в Bundle, с указанием действий (типов транзакций), которые необходимо произвести над каждым ресурсом в рамках одного HTTP запроса.
Особенности метода:
метод позволяет в составе Bundle одновременно импортировать несколько ресурсов одного профиля с указанием действий, которые необходимо выполнить над этими ресурсами: создание (POST), обновление (PUT).
для каждого ресурса, содержащегося в Bundle типа transaction, в элементе Bundle.entry.request должно быть задано действие (тип транзакции), которое нужно произвести над ресурсом.
ЦИСЗ может принимать только ресурс Bundle, соответствующий профилю Пакет информации в контексте организации, при этом:
ресурсы, передаваемые в Bundle, должны соответствовать списку профилей, указанных в ограничении профиля Пакет информации в контексте организации;
входящие FHIR-профили ресурсов, передаваемых в Bundle, должны соответствовать профилям ЦИСЗ;
используемые справочные данные должны соответствовать значениям справочников ЦИСЗ.
Метод осуществляет проверку:
входящего пакета данных организации здравоохранения на соответствие профилю Пакет информации в контексте организации;
ресурсов входящего пакета данных организации здравоохранения на соответствие профилям ЦИСЗ;
справочных данных пакета данных организации здравоохранения на соответствие значениям справочников ЦИСЗ.
Подробное описание профилей ЦИСЗ размещено по адресу: Профили ЦИСЗ.
Программные интерфейсы ЦИСЗ защищены сервером авторизации с использованием технологии OAuth 2.0: авторизация в ЦИСЗ. При каждом вызове метода клиентское приложение (МИС) должно передавать токен доступа (токен организации) в заголовке запроса.
Импорт пакета данных организации здравоохранения производится в виде JSON без подписи со стороны медицинского работника (в заголовках запроса устанавливается тип передаваемого контента (content-type) в application/json).
Вызов метода осуществляется с помощью HTTP POST команды:
POST [FHIR_BASE]/Bundle/$import
Правила обработки транзакций:
каждому ресурсу в рамках одной транзакции типа POST присваивается уникальный идентификатор;
для каждого ресурса в рамках одной транзакции типа PUT изначально производится поиск в ЦИСЗ переданного идентификатора ресурса. Если ресурс с таким идентификатором уже существует в ЦИСЗ – используется уже существующий идентификатор, если ресурс с таким идентификатором отсутствует в ЦИСЗ – то переданному в методе ресурсу присваивается уникальный идентификатор;
результат выполнения транзакции не зависит от уникального идентификатора ресурса, присвоенного ресурсу в рамках транзакции;
транзакция считается успешно выполненной только в том случае, если все ресурсы в рамках транзакции прошли валидацию на соответствие профилям ЦИСЗ;
пакет данных считается успешно обработанным только в том случае, если все транзакции пакета выполнены успешно.
Входные данные метода:
| Название | Профиль | Описание |
|---|---|---|
| bundle | пакет информации в контексте организации | Пакет данных организации здравоохранения, сформированный локальной или облачной МИС ОЗ |
Выходные данные метода:
| Название | Профиль | Описание |
|---|---|---|
| result | parameters | В случае, если входящий пакет данных является валидным, то возвращается тип операции Parameters. В противном случае возвращается тип операции OperationOutcome с HTTP статусом 400 (BadRequest) |
Тип операции Parameters состоит из следующих параметров:
| Название | Описание |
|---|---|
| ProcessingStatus | Статус обработки добавления пакета данных. При успешном выполнении операции будет иметь значение Pending |
| OperationStatusReference | Ссылка на статус операции, по которой можно получить статус обработки пакета данных |
| ResourceId | Идентификатор ресурса, по которому можно получить статус операции, проводящейся с данным ресурсом |
| ResourceType | Тип ресурса |
Метод возвращает:
HTTP статус 202 (Accepted): валидация входящего пакета данных на соответствие профилю пакета данных прошла успешно, запрос на импорт пакета принят в обработку, но обработка запроса еще не завершена;HTTP статус серии 4xx: операция импорта не выполнена. К сбою операции импорта могут привести ошибки в контенте (например, неверный набор символов, неверный JSON и т. д.).В случае успешного выполнения проверки метод возвращает НТТР статус операции импорта и набор параметров, по которым в последующем можно запросить в ЦИСЗ добавленный пакет данных.
Пример запроса на импорт пакета ресурсов расписаний со слотами в ЦИСЗ:
Пример ответа в случае успешного импорта пакета в ЦИСЗ:
Пример ответа в случае неуспешного импорта пакета в ЦИСЗ: