Develop FHIR server

This section will guide you on how to further develop the FHIR server for new functionalities.

Set up dev environment

Step 1, install the following dependencies

  1. Java JDK (>=17)

  2. Apache Maven (>=3.8)

Step 2, build mapping engine

Check this section to build Google Whistle mapping engine (C shared library), which is used by FHIR server to convert data.

Step 3, set mapping configs

First, clone mapping configs repo

git clone https://github.com/nwo-strap/mapping_configs.git

Let’s assume the path of this clone is MAPPING_CONFIG_PATH, e.g. /home/mapping_configs.

Then, update all local_path variables in gamebus_fhir_r4/configurations/*.textproto files.

If the path of the cloned repo (your MAPPING_CONFIG_PATH) is /mapping_configs, you don’t need to do anything; Otherwise, you MUST update all local_path with absolute path.

Step 4, clone source code

git clone https://github.com/nwo-strap/gamebus-fhir-layer.git

The gamebus-fhir-layer repo contains the implementation of the FHIR server by taking advantage of HAPI FHIR framework.

Further develop the FHIR server

Now it’s ready for further development of FHIR server, e.g. adding or updating FHIR resources and operations.

You could first have a look at the code in gamebus-fhir-layer repo to get a sense of how the HAPI FHIR framework works. It’s quite straightforward to add functionalities.

HAPI FHIR website has great documentation for developers to develop the FHIR server.

Start a local test server

Start a local FHIR server to test new functionalities:

# make sure you are working in the gamebus-fhir-layer repo
cd gamebus-fhir-layer

# Replace "[GAMEBUS_API_URL]" and "[mapping_configs_ABSOLUTE_PATH]" with real values
mvn -D="jna.library.path=/usr/local/lib" \
    -Dgb.url="[GAMEBUS_API_URL]" \
    -Dgwc.player="[mapping_configs_ABSOLUTE_PATH]/gamebus_fhir_r4/configurations/player.textproto" \
    -Dgwc.activity="[mapping_configs_ABSOLUTE_PATH]/gamebus_fhir_r4/configurations/activity.textproto" \
    jetty:run

  • -D="jna.library.path=/usr/local/lib" sets the path of C shared library of the mapping engine.

  • -Dgb.url="[GAMEBUS_API_URL] sets the URL of GameBus REST API (https://api3-new.gamebus.eu/v2).

  • -Dgwc.player="[mapping_configs_ABSOLUTE_PATH]/gamebus_fhir_r4/configurations/player.textproto" sets the mapping config for GameBus player data. Replace the [mapping_configs_ABSOLUTE_PATH] with the real value of the absolute path of the mapping configs repo (see step 3 above).

  • -Dgwc.activity="[mapping_configs_ABSOLUTE_PATH]/gamebus_fhir_r4/configurations/activity.textproto" sets the mapping config for GameBus activity data.

By default, the server will be served at the base “http://localhost:8080”.

You can check the available functionalities of the FHIR server by visiting the URL: http://localhost:8080/metadata.

Before requesting data from the FHIR server, you need to add some example data to GameBus. Check the section Add data to GameBus for more details.

Then you can send HTTP requests to test the new functionalities of the FHIR server. Check the section Request on FHIR API for more details.

To validate the FHIR data returned by the server, please check the section Validate FHIR data.