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