matchbox is a FHIR server based on the hapifhir/hapi-fhir-jpaserver-starter
- (pre-)load FHIR implementation guides from the package server for conformance resources (StructureMap, Questionnaire, CodeSystem, ValueSet, ConceptMap, NamingSystem, StructureDefinition). The "with-preload" subfolder contains an example with the implementation guides provided for the public test server.
- validation support: [server]/$validate for checking FHIR resources conforming to the loaded implementation guides
- FHIR Mapping Language endpoints for creation of StructureMaps and support for the StructureMap/$transform operation
- SDC (Structured Data Capture) extraction support based on the FHIR Mapping language and Questionnaire/$extract
The docker file will create a docker image with no preloaded implementation guides. A list of implementation guides to load can be passed as config-map. A second docker file will create an image with fixed configuration and preloaded implementation guides. That docker image does not need to download the implementation guides afterwards.
- This project checked out. You may wish to create a GitHub Fork of the project and check that out instead so that you can customize the project and save the results to GitHub. Check out the main branch (master is kept in sync with hapi-fhir-jpaserver-starter
- Oracle Java (JDK) installed: Minimum JDK8 or newer.
- Apache Maven build tool (newest version)
The easiest way to run this server entirely depends on your environment requirements. At least, the following 4 ways are supported:
With no implementation guide:
mvn clean install -DskipTests spring-boot:runLoad example implementation guides:
mvn clean install -DskipTests spring-boot:run -Dspring-boot.run.arguments=--spring.config.additional-location=file:with-preload/application.yamlor
java -Dspring.config.additional-location=file:with-preload/application.yaml -jar target/matchbox.jar
mvn clean install -DskipTests spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"
Then, browse to the following link to use the server:
http://localhost:8080/matchbox/
mvn package -DskipTests
docker build -t matchbox .
docker run -d --name matchbox -p 8080:8080 matchboxServer will then be accessible at http://localhost:8080/matchbox/fhir/metadata.
To dynamically configure run in a kubernetes environment and add a kubernetes config map that provides /config/application.yaml file with implementation guide list like in "with-preload/application.yaml"
After building the base image:
cd with-preload
docker build -t matchbox-swissepr .
docker run -d --name matchbox-swissepr -p 8080:8080 matchbox-swisseprdocker tag matchbox eu.gcr.io/fhir-ch/matchbox:v140
docker push eu.gcr.io/fhir-ch/matchbox:v140
docker push eu.gcr.io/fhir-ch/matchbox-swissepr:v140
Use VSCode, REST Client to work with the API: