Профиль интеграции ИЭМК.Стационар (в дальнейшем "Система") реализован в виде WEB-API приложения.
Обращение к REST ресурсам происходит посредством протокола HTTP, используя парадигму CRUD - Create, Read, Update, Delete.
Адрес ресурса (URI) представляет собой базовый адрес системы (URL) и единообразное имя ресурса (URN). Базовый адрес системы описан в пункте Адреса сервисов. Единообразное имя ресурса указано в описании каждого отдельного ресурса.
Модель ресурса описывает все поля и вложенные модели, присутствующие в данном ресурсе, с полной информацией о имени, заголовке, типе поля, адресе вложенного ресурса, обязательности заполнения и глубине иерархии в рамках данной модели.
Для обеспечения корректной однозначной связанности основного и зависимых ресурсов используется связь по идентификаторам системы ИЭМК, присутствует в каждой модели ресурса.
В системе используются следующие HTTP методы для работы с ресурсами:
- GET — используются для получения (чтения) ресурсов.
- POST — для создания ресурсов.
- PUT — для обновления ресурсов.
- DELETE — для удаления ресурсов.
По умолчанию всем ресурсам доступны все эти методы за одним лишь исключением - все справочники системы доступны только на чтение и принимают только методы GET.
Пункт "Авторизация" описывает правила, по которым необходимо передать системе данные по авторизации для доступа к ресурсам.
Пункт "Ресурсы системы" описывает все ресурсы, используемые в работе системы, с подробным описанием модели, адреса и доступных ресурсу методов.
Пункт "Последовательность действий для создания карты" описывает стандартный порядок действий в системе, которые требуются для создания полной медицинской карты стационарного больного с подробным описанием используемых методов и порядка их запуска.
Пункт "Тестирование" представляет собой набор тестовых запросов для обращения к ресурсам и описание возвращаемых ответов.
Пункт "Методы интеграции" описывает правила обращения к ресурсам системы при помощи HTTP методов, а также описывается порядок создания ресурса медицинской карты стационарного больного в системе.
API для интеграции Стационар - ИЭМК представляет собой CRUD приложение, позволяющее добавлять, получать, обновлять и удалять данные по госпитализациям пациентов.
API представлена набором сервисов, которые работают с моделями посредством передачи запросов GET, PUT, POST и DELETE на адреса соответствующих контроллеров.
Используемые модели бывают двух видов - сущности и справочники, что отмечено в описании каждой модели.
Контроллеры сущностей принимают запросы GET, PUT, POST и DELETE - запись можно получить из БД, изменить, вставить новую и удалить.
Контроллеры справочников принимают только запросы GET, так как записи справочников доступны API только на чтение, попытки удалить, изменить или добавить вернут ошибку.
Блок "схема взаимодействия" описывает механизмы передачи данных между стационарами и ИЭМК.
Блок "модели интеграции" описывает все модели, используемые в работе API, с полным перечислением всех полей, их типов, иерархией вложенности и адресов контроллеров, которые принимают запросы к этим моделям.
Блок "методы интеграции" описывает порядок работы с сервисами АПИ для передачи, редактирования и обновления данных.
Блок "авторизация в методах интеграции" описывает правила, по которым необходимо передать системе данные по авторизации для доступа к сервисам.
Блок "тестирование интеграции" представляет собой набор тестовых запросов, которые показывают примеры работы с сервисами интеграции.