Giter Club home page Giter Club logo

mii-fhir-site-report-aktin's Introduction

Automated MII Site Reports via AKTIN

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.

Setting up the decentral site-client in a DIC

The client comes packaged in a docker image and can be configured via environment variables.

  1. 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>

  2. 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

  3. Set the enviroment variables in your .env file according to your requirements (explanation see "Overview Configuration Variables" below)

  4. Start the process by executing docker-compose up

  5. 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.

  6. 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

  7. Start the process again by executing docker-compose up

  8. Check with the central team administering the central AKTIN broker if your report was successfully submitted

  9. Create a cronjob similar to the crontab file 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.

Overview Configuration Variables

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-fhir-site-report-aktin's People

Contributors

juliangruendner avatar alexzautke avatar michael-82 avatar emtezogaf avatar noemide avatar umeihle avatar geloro94 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.