This repository contains the two clients.
- A central client "central-broker-client", which collects the site reports submitted to the central AKTIN broker, downloads them and saves them to a folder.
- A decentral client "site-cleint", which connects to the local FHIR Server of the DIC, collects the capability statement, executes the queries in the report-queries.json of this repository, and sends the finished report to the configured central AKTIN broker.
The client comes packaged in a docker image and can be configured via environment variables.
-
Checkout the version you would like to install by checking out the respective git tag
git checkout tags/<tag-here - e.g. v0.3.0> -
Initialise the .env file by executing the
initialise-env-file.sh. If it already exists compare .env file to .env.default file and add any new vars from .env.default to the .env file -
Set the enviroment variables in your .env file according to your requirements (explanation see "Overview Configuration Variables" below)
-
Start the process by executing
docker-compose up -
By default the variable MII_REPORT_CLIENT_SEND_REPORT is set to false - this allows you to generate a report without sending it out so that you can check it manually before.
-
After a first run with MII_REPORT_CLIENT_SEND_REPORT=false - check the generated report under /reports and if satisfied change to MII_REPORT_CLIENT_SEND_REPORT=true
-
Start the process again by executing
docker-compose up -
Check with the central team administering the central AKTIN broker if your report was successfully submitted
-
Create a cronjob similar to the
crontabfile in this repository to run the program periodically
Note: If you are using the standard installation of the feasibility triangle from here: https://github.com/medizininformatik-initiative/feasibility-deploy, please ensure that you start the container here as part of the correct docker-compose project (e.g. COMPOSE_PROJECT=feasibility-deploy). In this case MII_REPORT_CLIENT_FHIR_BASE_URL should match the set docker BASE_URL (default: http://fhir-server:8080/fhir).
Example: docker-compose -p $COMPOSE_PROJECT up. the -p option then also has to be carried over to your crontab configuration.
| Environment Variable | description | default value |
|---|---|---|
| MII_REPORT_CLIENT_FHIR_BASE_URL | Local FHIR server base url e.g. see default value | http://fhir-server:8080/fhir |
| MII_REPORT_CLIENT_FHIR_USER | Basic auth user for local FHIR server | None |
| MII_REPORT_CLIENT_FHIR_PW | Basic auth password for local FHIR server | None |
| MII_REPORT_CLIENT_FHIR_TOKEN | auth token for local FHIR server | None |
| MII_REPORT_CLIENT_FHIR_PROXY_HTTP | HTTP url for proxy if used for local FHIR server | None |
| MII_REPORT_CLIENT_FHIR_PROXY_HTTPS | HTTPS url for proxy if used for local FHIR server | None |
| MII_REPORT_BROKER_ENDPOINT_URI | Url of central AKTIN broker example see default | http://aktin-broker:8080/broker/ |
| MII_REPORT_CLIENT_AUTH_PARAM | Client specific API key for central AKTIN broker | xxxApiKey123 |
| MII_REPORT_CLIENT_AKTIN_HTTPS_PROXY | HTTPS url for proxy if used for local connecting to central AKTIN broker server, e.g. (with user: https://user:password@proxyip:port, without user: https://proxyip:port) | None |
| MII_REPORT_CLIENT_SEND_REPORT | configures if the report should be send to the central broker, set to false to generate the report locally first | false |
| MII_REPORT_SEARCH_PAT_YEAR_FACILITY | configures if any encounter or only the facility encounter is used to calculate the patient count | false |
| MII_REPORT_EXEC_YEAR_QUERIES | enables year queries, if disabled no year queries will be executed | false |
| MII_REPORT_EXEC_PAT_YEAR_QUERIES | enables yearly patient count calculation, if disabled patient breakdown by year will be empty | false |