Digital Square E0 proposal: openIMIS Shelf Readiness
Teams:
Swiss TPH (Dragos Dobre Patrick Delcroix Marco Antonio Guimaraes Pereira)
SolDevelo (Kamil Madej (Deactivated) Damian Borowiecki Seweryn Niedzielski)
...
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.
...
FHIR release four (R4) integration
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
FHIR R4 extensions development
...
| Plantumlcloud | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
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 |
...
| 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
Related pages:
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:
openIMIS FHIR module documentation
openIMIS FHIR Quality Assurance
Docker package improvement
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 configuration using local files. Here the user has to provide the normally called “openimis.json” locally using the appropriate environmental variable, two can be provided for the backend and frontend configuration (from the 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 might change the branch if need 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> |
Developer initialisation script
A package to include not only openIMIS, but also services that could be required by an user, as 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).
There were some alterations of the in the previous section mentioned repository to achieve this. The manual steps for the installation of the database were eliminated, so that the only command the user would be required to use 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.
This is extendable by any service the user may want, given that the service is in a directory that follows instant OpenHIE structure, and adding the package ID then 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 as in the previous repository.