...
Jira board: https://openimis.atlassian.net/jira/software/projects/OE0/boards/35
Objectives
The goal of this project is to improve the open-source Insurance Management Information System (openIMIS) interoperability layer for easier and more efficient integration with other health-related systems within OpenHIE (Open Health Information Exchange) architecture, and to allow an efficient installation procedure through enhanced packaging and documentation, and thus, to align the solution with the Instant OpenHIE project and initiative.
This page is dedicated to the Digital Square Notice E0 project and will be used to specify the developments and the realizations from this project.
From the initial proposal, only two Work Packages were awarded within this project:
| Table of Contents |
|---|
Roadmap
...
FHIR REST API Login endpoint
The /login endpoint has been added to the FHIR R4 module to allow the generation of the JWT token through the FHIR R4 module’s REST API.
| Code Block | ||
|---|---|---|
| ||
POST /api_fhir_r4/login
Request body:
{
"username": [username],
"password": [password]
}
HTTP 200 Response body:
{
"token": [token]
"exp": [expire_date]
}
HTTP 401 Response if credentials are not valid |
FHIR REST API Authorization header
All other FHIR R4 requests should contain the Authorization header with the Bearer token.
| Code Block | ||
|---|---|---|
| ||
Authorization: Bearer [token]
HTTP 200 Response when token validated (the actual resource payload is returned)
HTTP 401 Response when:
if Authorization header is missing
if Bearer prefix is missing
if error on decoding Authorization header
if token is expired |
FHIR Authorisation
In openIMIS, authorisation is based on User’s role and location. A role is a group of authorities or permissions which are well defined and constant (see openIMIS Authorities for an up-to-date list of authorities). During the migrations, some of authorities were not added in the new created modules. Moreover, the query set used to obtain the data related to a resource was fetching all the objects from the DB.
Based on the openIMIS Authorities, used in the legacy openIMIS, we have added the missing permission to the modular openIMIS. Also, we have updated the query sets and retrieved them from the business module (e.g. Claim module) which limits the access based on the Users The following modules have been updated:
1.4 openIMIS FHIR Quality Assurance
To come
1.5 openIMIS FHIR module documentation
To come.
2 Packaging and Installation
2.1 Docker package improvement
Enhancement of openIMIS dockerization
For better distribution, docker can be used to facilitate the installation of openIMIS. The repository https://github.com/openimis/openimis-dist_dkr/tree/develop was updated to let users provide their own configuration using local files. For this, the user has to provide the openimis.json file locally using the appropriate environmental variable. Two files can be provided for the backend and frontend configuration (from the https://github.com/openimis/openimis-dist_dkr/blob/develop/README.md):
| Code Block |
|---|
BE_CONF_PATH=<the path to your config file, has to be local>
FE_CONF_PATH=<the path to your config file, has to be local> |
Additionally if the user wants to provide development settings, there is a variable for the path where this configuration file would be located:
DEV_PATH=<the path to your developer config, optional>
For even easier installation, the different repositories will be built on the fly directly from GitHub (repository previously provided). The user can change the branch using the variables:
| Code Block |
|---|
BE_BRANCH=<branch of the backend repository to be used>
FE_BRANCH=<branch of the frontend repository to be used>
DB_BRANCH=<branch of the database repository to be used>
GW_BRANCH=<branch of the gateway repository to be used> |
openIMIS integrated with Instant OpenHIE
A package to include not only openIMIS, but also services that could be required by an user, e.g. a mediator (OpenHIM) or a FHIR server (Hapi), was developed. For this purpose, we extend the work of the OpenHIE, so called Instant OpenHIE (https://github.com/openhie/instant) to include openIMIS as a service (https://github.com/openimis/openimis-dist_instant_openhie/tree/develop).
To satisfy the Instant OpenHIE requirements, some alterations were necessary to the openIMIS docker package. The manual steps for the installation of the database were eliminated, so that the only command the user requires is:
./deploy.sh init core openimis-db_dkr openimis-dist_dkr -c="./openimis-db_dkr" -c="./openimis-dist_dkr"
To clean up the project you'd use destroy instead of init. The commands up and down known from docker-compose are also allowed.
Alternatively, you can achieve the same by cloning the https://github.com/openhie/instant repository, and running it with yarn. Having the repository locally, would replace the need of the deploy.sh.
Given that the service is in a directory that follows Instant OpenHIE structure, this implementation is extendable with any service the user may want by adding the package ID to the previous command with the corresponding path.
The variables for both services are now in the docker/compose.sh files of each service as opposed of the .env file in the previous repository.
...
| Roadmap Planner | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
The following sections will specify the changes and enhancements brought by this project to the two components from each WP.
1 openIMIS FHIR Module
1.1 FHIR release four (R4) integration
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
1.2 FHIR R4 extensions development
1.3 FHIR Authentication and Authorisation
FHIR Authentication
The objective is to manage User authentication directly from the FHIR module. The JWT authentication mechanism is used. FHIR module is using the authentication services so the token can be used in both FHIR REST API and GraphQL queries.
...
|
In July 2022, Dragos Dobre from SwissTPH held a webinar where he gave a detailed overview of the project with a focus on the FHIR module. You can watch the whole presentation here:
| Widget Connector | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
https://www.youtube.com/watch?v=xIg8iErO2s4
The following sections will specify the changes and enhancements brought by this project to the two components from each WP.
| Child pages (Children Display) |
|---|