Skip to content
This repository was archived by the owner on Oct 6, 2025. It is now read-only.

Commit 6147651

Browse files
committed
Improve Process Readme
Adds sections regarding process configuration and compatibility.
1 parent 4466376 commit 6147651

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

codex-process-feasibility/README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,10 @@ This describes the execute process in case `Structured Query` is specified as an
7474

7575
This process supports the following query types within the transferred Library resource:
7676

77-
|Type | Description | Mime Type |
78-
|-----|-------------|-----------|
79-
| CQL | Standardized query format. See https://cql.hl7.org/ for more information. | `text/cql` |
80-
| Structured Query | Internal query representation within the CODEX project based on the JSON format. | `application/sq+json` |
77+
| Type | Description | Mime Type |
78+
|-------------------|------------------------------------------------------------------------------------------------|----------------------------|
79+
| CQL | Standardized query format. See https://cql.hl7.org/ for more information. | `text/cql` |
80+
| Structured Query | Internal query representation within the CODEX project based on the JSON format. | `application/sq+json` |
8181
| FHIR Search Query | Standardized FHIR search query. See https://www.hl7.org/fhir/search.html for more information. | `application/x-fhir-query` |
8282

8383
**Note**: _Although a FHIR search query can be transferred to the process no result will be calculated!_
@@ -98,10 +98,38 @@ In the [Business Process Model and Notation][7] (BPMN) model of the `request` pr
9898

9999
The BPMN model of the `execute` process is straightforward and already explained in detail above.
100100

101+
## Configuration
102+
103+
Besides the [common DSF settings controlled by different environment variables][8], there are some additional ones specific to this process:
104+
105+
| EnvVar | Description | Default |
106+
|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------|
107+
| DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_PROCESSES_FEASIBILITY_FLARE_WEBSERVICE_BASEURL | Base URL to a Flare instance. Only required when evaluation strategy is set to `structured-query`. | |
108+
| DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_PROCESSES_FEASIBILITY_FLARE_WEBSERVICE_CONNECTTIMEOUT | Timeout in ms when trying to connect to a Flare instance. | `2000` |
109+
| DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_PROCESSES_FEASIBILITY_EVALUATION_STRATEGY | How the feasibility shall be evaluated. Possible values are `cql` and `structured-query`. When using the latter a Flare instance is required. | `cql` |
110+
| DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_PROCESSES_FEASIBILITY_EVALUATION_OBFUSCATE | Whether the feasibility results shall be obfuscated. | `true` |
111+
| DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_PROCESSES_FEASIBILITY_STORE_URL | Base URL to a FHIR store used for feasibility evaluation. Only required when evaluation strategy is set to `cql`. | `foo` |
112+
113+
## Compatibility
114+
115+
This version of the process is compatible with the following components:
116+
117+
| Component | Compatible Version(s) |
118+
|-----------|-----------------------|
119+
| DSF FHIR | `0.5.x` |
120+
| DSF BPE | `0.5.x` |
121+
| Blaze | `>= 0.12` |
122+
| Flare | `1.0` |
123+
124+
**Note:** Flare got rewritten. Only the [new project][9] is supported.
125+
126+
101127
[1]: <https://www.hl7.org/FHIR/task.html>
102128
[2]: <https://www.hl7.org/fhir/measure.html>
103129
[3]: <https://www.hl7.org/fhir/library.html>
104130
[4]: <https://www.hl7.org/fhir/bundle.html>
105131
[5]: <https://www.hl7.org/fhir/operation-measure-evaluate-measure.html>
106132
[6]: <https://www.hl7.org/fhir/measurereport.html>
107133
[7]: <https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation>
134+
[8]: <https://github.com/highmed/highmed-dsf/wiki/DSF-0.5.4-Configuration-Parameters#dsf-bpe>
135+
[9]: <https://github.com/rwth-imi/flare-query>

0 commit comments

Comments
 (0)