Skip to content

Process Report Configuration v1.1.x.x

Jump to bottom
Reto Wettstein edited this page Jul 31, 2024 · 2 revisions

The report process can be configured using the following mandatory and optional environment variables depending on the organization's role. Add the necessary environment variables to the /opt/bpe/docker-compose.yml file of your BPE.

Important:

To receive eMail notifications, configure the e-mail environment variables described as part of the DSF BPE deployment starting with DEV_DSF_BPE_MAIL_....

DIC Mandatory

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BASE_URL

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.base.url
  • Required: Yes
  • Processes: medizininformatik-initiativede_reportSend
  • Description: The base address of the FHIR server to read/store FHIR resources
  • Example: http://foo.bar/fhir

DIC as Needed

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_HRP_IDENTIFIER

  • Property: de.medizininformatik.initiative.report.dic.hrp.identifier
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: The identifier of the HRP which should receive the report
  • Recommendation: Only configure if more than one HRP exists in your network
  • Example: forschen-fuer-gesundheit.de

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_DATALOGGINGENABLED

  • Property: de.medizininformatik.initiative.report.dic.fhir.dataLoggingEnabled
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: To enable debug logging of FHIR resources set to true
  • Default: false

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_TRUST_CERTIFICATES

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.trust.certificates
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: PEM encoded file with one or more trusted root certificate to validate the FHIR server certificate when connecting via https
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/hospital_ca.pem

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BASICAUTH_USERNAME

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.basicauth.username
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Basic authentication username, set if the server containing the FHIR data requests authentication using basic auth

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BASICAUTH_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BASICAUTH_PASSWORD_FILE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.basicauth.password
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Basic authentication password, set if the server containing the FHIR data requests authentication using basic auth
  • Recommendation: Use docker secret file to configure by using DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BASICAUTH_PASSWORD_FILE
  • Example: /run/secrets/fhir_server_basicauth.password

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_BEARER_TOKEN

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.bearer.token
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Bearer token for authentication, set if the server containing the FHIR data requests authentication using a bearer token, cannot be set using docker secrets

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_TRUST_CERTIFICATES

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.trust.certificates
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, PEM encoded file with one or more trusted root certificate to validate the oidc provider server certificate when connecting via https
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/hospital_ca.pem

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_ISSUER_URL

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.issuer.url
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, the url of the oidc provider to request access tokens (token endpoint)
  • Example: http://foo.baz/realms/fhir-realm/protocol/openid-connect/token

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_CLIENT_ID

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.client.id
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, identifier of the client (username) used for authentication when accessing the oidc provider token endpoint

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_CLIENT_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_CLIENT_PASSWORD_FILE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.client.password
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, secret of the client (password) used for authentication when accessing the oidc provider token endpoint
  • Recommendation: Use docker secret file to configure by using DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_CLIENT_PASSWORD_FILE

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_PROXY_URL

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.proxy.url
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, proxy location, set if the oidc provider can only be reached through a proxy, uses value from DEV_DSF_PROXY_URL if not set
  • Example: http://proxy.foo:8080

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_PROXY_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_PROXY_PASSWORD_FILE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.proxy.password
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, proxy password, set if the oidc provider can only be reached through a proxy which requests authentication, uses value from DEV_DSF_PROXY_PASSWORD if not set
  • Recommendation: Use docker secret file to configure by using DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_PROXY_PASSWORD_FILE

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_PROXY_USERNAME

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.proxy.username
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, proxy username, set if the oidc provider can only be reached through a proxy which requests authentication, uses value from DEV_DSF_PROXY_USERNAME if not set

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_TIMEOUT_CONNECT

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.timeout.connect
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, the timeout in milliseconds until a connection is established between the client and the oidc provider
  • Recommendation: Change default value only if timeout exceptions occur
  • Default: 20000

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_TIMEOUT_SOCKET

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.oauth2.timeout.socket
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Available from version >1.1.1.0, maximum period of inactivity in milliseconds between two consecutive data packets of the client and the oidc provider
  • Recommendation: Change default value only if timeout exceptions occur
  • Default: 60000

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_CERTIFICATE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.certificate
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: PEM encoded file with client-certificate, if FHIR server requires mutual TLS authentication
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/fhir_server_client_certificate.pem

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.private.key
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Private key corresponding to the FHIR server client-certificate as PEM encoded file. Use DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY_PASSWORD_FILE if private key is encrypted
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/fhir_server_private_key.pem

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY_PASSWORD_FILE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.private.key.password
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Password to decrypt the FHIR server client-certificate encrypted private key
  • Recommendation: Use docker secret file to configure by using DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PRIVATE_KEY_PASSWORD_FILE
  • Example: /run/secrets/fhir_server_private_key.pem.password

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PROXY_URL

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.proxy.url
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Proxy location, set if the server containing the FHIR data can only be reached through a proxy, from version >1.1.1.0: uses value from DEV_DSF_PROXY_URL if not set
  • Example: http://proxy.foo:8080

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PROXY_USERNAME

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.proxy.username
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Proxy username, set if the server containing the FHIR data can only be reached through a proxy which requests authentication, from version >1.1.1.0: uses value from DEV_DSF_PROXY_USERNAME if not set

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PROXY_PASSWORD or DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PROXY_PASSWORD_FILE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.proxy.password
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Proxy password, set if the server containing the FHIR data can only be reached through a proxy which requests authentication, from version >1.1.1.0: uses value from DEV_DSF_PROXY_PASSWORD if not set
  • Recommendation: Use docker secret file to configure by using DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_PROXY_PASSWORD_FILE

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_CLIENT_VERBOSE

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.client.verbose
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: The client will log additional debug output
  • Recommendation: Change default value only if exceptions occur
  • Default: false

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_TIMEOUT_CONNECT

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.timeout.connect
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: The timeout in milliseconds until a connection is established between the client and the FHIR server
  • Recommendation: Change default value only if timeout exceptions occur
  • Default: 20000

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_TIMEOUT_CONNECTION_REQUEST

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.timeout.connection.request
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: The timeout in milliseconds used when requesting a connection from the connection manager between the client and the FHIR server
  • Recommendation: Change default value only if timeout exceptions occur
  • Default: 20000

DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_TIMEOUT_SOCKET

  • Property: de.medizininformatik.initiative.report.dic.fhir.server.timeout.socket
  • Required: No
  • Processes: medizininformatik-initiativede_reportSend
  • Description: Maximum period of inactivity in milliseconds between two consecutive data packets of the client and the FHIR server
  • Recommendation: Change default value only if timeout exceptions occur
  • Default: 60000

HRP Mandatory / as Needed

There are no mandatory or optional configuration parameters for the HRP.

Clone this wiki locally