Skip to content

Configuration Parameters v0.5.0

Jump to bottom
Hauke Hund edited this page Jun 24, 2022 · 2 revisions

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_CONSENT_GRANTED_OIDS_IDAT_MERGE

  • Property: de.netzwerk.universitaetsmedizin.codex.consent.granted.oids.idat.merge
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: List of expected consent provision permit codes for requesting a pseudonym based on a bloom filter from the fTTP
  • Default: 2.16.840.1.113883.3.1937.777.24.5.3.4

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_CONSENT_GRANTED_OIDS_MDAT_TRANSFER

  • Property: de.netzwerk.universitaetsmedizin.codex.consent.granted.oids.mdat.transfer
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: List of expected consent provision permit codes for exporting GECCO resources
  • Default: 2.16.840.1.113883.3.1937.777.24.5.3.8,2.16.840.1.113883.3.1937.777.24.5.3.9,2.16.840.1.113883.3.1937.777.24.5.3.33,2.16.840.1.113883.3.1937.777.24.5.3.34

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_CRR_IDENTIFIER_VALUE

  • Property: de.netzwerk.universitaetsmedizin.codex.crr.identifier.value
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: DSF organization identifier of the central research repository
  • Default: num-codex.de

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_CRR_PRIVATE_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.crr.private.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Location of the CRR private-key used to RSA decrypt FHIR bundles for the central repository
  • Example: /run/secrets/crr_private-key-pre-prod.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_CRR_PUBLIC_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.crr.public.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Location of the CRR public-key e.g. crr_public-key-pre-prod.pem used to RSA encrypt FHIR bundles for the central repository
  • Recommendation: Ask central repository management for the correct public key regarding the test and production environments
  • Example: /run/secrets/crr_public-key-pre-prod.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_API_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.api.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Your organizations API key provided by the fTTP, the fTTP API key can not be defined via docker secret file and needs to be defined directly via the environment variable
  • Recommendation: Specify if you are using the send process to request pseudonyms from the fTTP

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.basicauth.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Basic authentication password to authenticate against the fTTP server, set if the server requests authentication using basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_PASSWORD_FILE
  • Example: /run/secrets/fttp_server_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.basicauth.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Basic authentication username to authenticate against the fTTP server, set if the server requests authentication using basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_CERTIFICATE

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.certificate
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: PEM encoded file with client-certificate used to authenticated against fTTP server
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/fttp_server_client_certificate.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_CLIENT_HAPI_VERBOSE

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.client.hapi.verbose
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: To enable verbose logging of requests and replies to the fTTP server set to true
  • Default: false

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.private.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: PEM encoded file with private-key for the client-certificate defined via de.netzwerk.universitaetsmedizin.codex.fttp.certificate
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/fttp_server_client_certificate_private_key.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.private.key.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Password to decrypt the private-key defined via de.netzwerk.universitaetsmedizin.codex.fttp.private.key
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD_FILE
  • Example: /run/secrets/fttp_server_client_certificate_private_key.pem.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Forwarding proxy server basic authentication password, set if the fTTP server can only be reached via a proxy server that requires basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_PASSWORD_FILE
  • Example: /run/secrets/fttp_server_proxy_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_URL

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.url
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Forwarding proxy server url, set if the fTTP server can only be reached via a proxy server
  • Example: http://proxy.foo:8080

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Forwarding proxy server basic authentication username, set if the fTTPserver can only be reached via a proxy server that requires basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_SERVER_BASE_URL

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.server.base.url
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: The base URL of the fTTP server
  • Recommendation: Specify if you are using the send process to request pseudonyms from the fTTP. Caution: The fTTP client is unable to follow redirects, specify the final url if the server redirects requests

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_STUDY

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.study
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Study identifier specified by the fTTP
  • Default: num

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_TARGET

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.target
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Pseudonymization domain target identifier specified by the fTTP
  • Recommendation: Specify if you are using the send process to request pseudonyms from the fTTP
  • Example: dic_heidelberg
  • Default: codex

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_TIMEOUT_CONNECT

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.connect
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Connection timeout in milliseconds used when accessing the fTTP server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_TIMEOUT_CONNECTION_REQUEST

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.connection.request
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Connection request timeout in milliseconds used when requesting a connection from the connection manager while accessing the fTTP server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_TIMEOUT_SOCKET

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.socket
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: Maximum period of inactivity in milliseconds between two consecutive data packets from the fTTP server, time until the server needs to send a data packet before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_TRUST_CERTIFICATES

  • Property: de.netzwerk.universitaetsmedizin.codex.fttp.trust.certificates
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataTranslate
  • Description: PEM encoded file with trusted certificates to validate the server-certificate of the fTTP server
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/fttp_server_ca.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASE_URL

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.base.url
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Base URL of the GECCO FHIR server
  • Example: http://foo.bar/fhir

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.basicauth.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Basic authentication password to authenticate against the GECCO FHIR server, set if the server requests authentication using basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_PASSWORD_FILE
  • Example: /run/secrets/gecco_fhir_server_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.basicauth.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Basic authentication username to authenticate against the GECCO FHIR server, set if the server requests authentication using basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BEARER_TOKEN

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.bearer.token
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Bearer token to authenticate against the GECCO FHIR server, set if the server requests authentication using bearer token, cannot be set using docker secrets

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_CERTIFICATE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.certificate
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: PEM encoded file with client-certificate, if GECCO FHIR server requires mutual TLS authentication
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/gecco_fhir_server_client_certificate.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_CLIENT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.client
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: GECCO FHIR Server client implementation class
  • Default: de.netzwerk_universitaetsmedizin.codex.processes.data_transfer.client.fhir.FhirBridgeClient

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_CLIENT_HAPI_VERBOSE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.client.hapi.verbose
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: To enable verbose logging of requests and replies to the GECCO FHIR server set to true
  • Default: false

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: PEM encoded file with private-key for the client-certificate defined via de.netzwerk.universitaetsmedizin.codex.gecco.server.certificate
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/gecco_fhir_server_client_certificate_private_key.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Password to decrypt the private-key defined via de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD_FILE
  • Example: /run/secrets/gecco_fhir_server_client_certificate_private_key.pem.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Forwarding proxy server basic authentication password, set if the GECCO FHIR server can only be reached via a proxy server that requires basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_PASSWORD_FILE
  • Example: /run/secrets/gecco_fhir_server_proxy_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_URL

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.url
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Forwarding proxy server url, set if the GECCO FHIR server can only be reached via a proxy server
  • Example: http://proxy.foo:8080

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Forwarding proxy server basic authentication username, set if the GECCO FHIR server can only be reached via a proxy server that requires basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_SEARCH_BUNDLE_OVERRIDE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.search.bundle.override
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Location of a FHIR batch bundle used to override the internally provided bundle used to search for GECCO FHIR ressources

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_TIMEOUT_CONNECT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.connect
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Connection timeout in milliseconds used when accessing the GECCO FHIR server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_TIMEOUT_CONNECTION_REQUEST

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.connection.request
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Connection request timeout in milliseconds used when requesting a connection from the connection manager while accessing the GECCO FHIR server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_TIMEOUT_SOCKET

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.socket
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: Maximum period of inactivity in milliseconds between two consecutive data packets from the GECCO FHIR server, time until the server needs to send a data packet before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_TRUST_CERTIFICATES

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.trust.certificates
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend, wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: PEM encoded file with trusted certificates to validate the server-certificate of the GECCO FHIR server
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/gecco_fhir_server_ca.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_USE_CHAINED_PARAMETER_NOT_LOGICAL_REFERENCE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.use.chained.parameter.not.logical.reference
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataReceive
  • Description: To enable the use of logical references instead of chained parameters (patient:identifier instead of patient.identifier) while searching for Patients in the GECCO FHIR server set to true
  • Default: true

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Enables/disables local FHIR validation, set to false to skip validation
  • Default: true

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: FHIR implementation guide package used to validated resources, specify as name|version
  • Default: de.gecco|1.0.5

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CACHEFOLDER

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.cacheFolder
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Folder for storing downloaded FHIR implementation guide packages
  • Default: ${java.io.tmpdir}/codex_gecco_validation_cache/Package

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_BASIC_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_BASIC_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.basic.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Basic authentication password to authenticate against the FHIR implementation guide package server, set if the server requests authentication using basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_BASIC_PASSWORD_FILE
  • Example: /run/secrets/validation_package_server_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_BASIC_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.basic.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Basic authentication username to authenticate against the FHIR implementation guide package server, set if the server requests authentication using basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_CERTIFICATE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.certificate
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with client-certificate, if the FHIR implementation guide package server requires mutual TLS authentication
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/validation_package_server_client_certificate.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.certificate.private.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with private-key for the client-certificate defined via de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.certificate
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/validation_package_server_client_certificate_private_key.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.certificate.private.key.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Password to decrypt the private-key defined via de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.authentication.certificate.private.key
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE
  • Example: /run/secrets/validation_package_server_client_certificate_private_key.pem.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_PROXY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_PROXY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.proxy.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server basic authentication password, set if the FHIR implementation guide package server can only be reached via a proxy server that requires basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_PROXY_PASSWORD_FILE
  • Example: /run/secrets/validation_package_server_proxy_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_PROXY_SCHEMEHOSTPORT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.proxy.schemeHostPort
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server url, set if the FHIR implementation guide package server can only be reached via a proxy server
  • Example: http://proxy.foo:8080

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_PROXY_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.proxy.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server basic authentication username, set if the FHIR implementation guide package server can only be reached via a proxy server that requires basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_TIMEOUT_CONNECT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.timeout.connect
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Connection timeout in milliseconds used when accessing the FHIR implementation guide package server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_TIMEOUT_READ

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.timeout.read
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Read timeout in milliseconds used when accessing the FHIR implementation guide package server, time until the server needs to send a reply before aborting
  • Default: 300000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_TRUST_CERTIFICATES

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.trust.certificates
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with trusted certificates to validate the server-certificate of the FHIR implementation guide package server, uses the JVMs trust store if not specified
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/validation_package_server_ca.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_CLIENT_VERBOSE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.client.verbose
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: To enable verbose logging of requests and replies to the FHIR implementation guide package server, set to true
  • Default: false

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_NODOWNLOAD

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.noDownload
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: FHIR implementation guide packages that do not need to be downloaded, list with name|version values
  • Default: hl7.fhir.r4.core|4.0.1

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_PACKAGE_SERVER_BASEURL

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.package.server.baseUrl
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Base The base address of the FHIR repository containing GECCO data.URL of the FHIR implementation guide package server to download validation packages from
  • Default: https

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_STRUCTUREDEFINITION_CACHEFOLDER

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.structuredefinition.cacheFolder
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Folder for storing generated StructureDefinition snapshots
  • Default: ${java.io.tmpdir}/codex_gecco_validation_cache/StructureDefinition

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_STRUCTUREDEFINITION_MODIFIERCLASSES

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.structuredefinition.modifierClasses
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: List of StructureDefinition modifier classes, modifiers are executed before atempting to generate a StructureDefinition snapshot
  • Default: de.netzwerk_universitaetsmedizin.codex.processes.data_transfer.validation.structure_definition.ClosedTypeSlicingRemover,de.netzwerk_universitaetsmedizin.codex.processes.data_transfer.validation.structure_definition.MiiModuleLabObservationLab10IdentifierRemover,de.netzwerk_universitaetsmedizin.codex.processes.data_transfer.validation.structure_definition.GeccoRadiologyProceduresCodingSliceMinFixer

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_BINDINGSTRENGTH

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.bindingStrength
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: ValueSets found in the StructureDefinitions with the specified binding strength will be expanded
  • Default: required,extensible,preferred,example

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_CACHEFOLDER

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.cacheFolder
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Folder for storing expanded ValueSets
  • Default: ${java.io.tmpdir}/codex_gecco_validation_cache/ValueSet

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_BASIC_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_BASIC_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.basic.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Basic authentication password to authenticate against the terminology server, set if the server requests authentication using basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_BASIC_PASSWORD_FILE
  • Example: /run/secrets/terminology_server_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_BASIC_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.basic.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Basic authentication username to authenticate against the terminology server, set if the server requests authentication using basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.certificate
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with client-certificate, if the terminology server requires mutual TLS authentication
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/terminology_server_client_certificate.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.certificate.private.key
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with private-key for the client-certificate defined via de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.certificate
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/terminology_server_client_certificate_private_key.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.certificate.private.key.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Password to decrypt the private-key defined via de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.authentication.certificate.private.key
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_AUTHENTICATION_CERTIFICATE_PRIVATE_KEY_PASSWORD_FILE
  • Example: /run/secrets/terminology_server_client_certificate_private_key.pem.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_PROXY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_PROXY_PASSWORD_FILE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.proxy.password
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server basic authentication password, set if the terminology server can only be reached via a proxy server that requires basic authentication
  • Recommendation: Use docker secret file to configure by using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_PROXY_PASSWORD_FILE
  • Example: /run/secrets/terminology_server_proxy_basicauth.password

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_PROXY_SCHEMEHOSTPORT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.proxy.schemeHostPort
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server url, set if the terminology server can only be reached via a proxy server
  • Example: http://proxy.foo:8080

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_PROXY_USERNAME

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.proxy.username
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Forwarding proxy server basic authentication username, set if the terminology server can only be reached via a proxy server that requires basic authentication

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_TIMEOUT_CONNECT

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.timeout.connect
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Connection timeout in milliseconds used when accessing the terminology server, time until a connection needs to be established before aborting
  • Default: 10000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_TIMEOUT_READ

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.timeout.read
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Read timeout in milliseconds used when accessing the terminology server, time until the server needs to send a reply before aborting
  • Default: 300000

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_TRUST_CERTIFICATES

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.trust.certificates
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: PEM encoded file with trusted certificates to validate the server-certificate of the terminology server, uses the JVMs trust store if not specified
  • Recommendation: Use docker secret file to configure
  • Example: /run/secrets/terminology_server_ca.pem

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_CLIENT_VERBOSE

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.client.verbose
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: To enable verbose logging of requests and replies to the terminology server, set to true
  • Default: false

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_VALIDATION_VALUESET_EXPANSION_SERVER_BASEURL

  • Property: de.netzwerk.universitaetsmedizin.codex.gecco.validation.valueset.expansion.server.baseUrl
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: Base URL of the terminology server used to expand FHIR ValueSets
  • Recommendation: Specify a local terminology server to improve ValueSet expansion speed
  • Default: https://terminology-highmed.medic.medfak.uni-koeln.de/fhir

DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GTH_IDENTIFIER_VALUE

  • Property: de.netzwerk.universitaetsmedizin.codex.gth.identifier.value
  • Required: No
  • Processes: wwwnetzwerk-universitaetsmedizinde_dataSend
  • Description: DSF organization identifier of the GECCO Transfer Hub
  • Default: hs-heilbronn.de
Clone this wiki locally