Skip to content

Commit

Permalink
add readme for FDE
Browse files Browse the repository at this point in the history
  • Loading branch information
@juliangruendner
juliangruendner committed Nov 20, 2024
1 parent 108e147 commit dcc0183
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions feasibility-triangle/fhir-data-evaluator/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# The Fhir-Data-Evaluator (FDE)

The FDE is used as part of the feasibility triangle to collect metadata about available data on the local FHIR server.
This data can then be sent via the DSF to the central portal or loaded into the local portal to display the availability of single criteria in the fhir server.

## Running the FDE

To run the FDE copy the .env.default file to .env in the this folder and change the env variables according to your requirements.

Run the FDE by executing the `run-fde` script provided here.

You can as is configured by default send the metadata report back to your FHIR server which contains your patient data or
alternatively send the data to a different fhir server.

Regardless of this choice, the FHIR server which contains the report should be accessible from your DSE BPE in order to send the report to the central fdpg DSF using the
data transfer plugin https://github.com/medizininformatik-initiative/mii-process-data-transfer.


| Env Variable | Description | Default | Possible Values |
|-------------------------------------------------|------------------------------------------------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------|
| FDE_CONVERT_TO_CSV | Whether to convert the data to CSV format | false | true, false |
| FDE_FHIR_SERVER | Base URL of the FHIR server | http://localhost:8080/fhir | URL |
| FDE_FHIR_USER | Username for the FHIR server authentication | (empty) | String |
| FDE_FHIR_PASSWORD | Password for the FHIR server authentication | (empty) | String |
| FDE_FHIR_MAX_CONNECTIONS | Maximum number of simultaneous connections to the FHIR server | 4 | Integer |
| FDE_FHIR_MAX_QUEUE_SIZE | Maximum size of the FHIR server request queue | 500 | Integer |
| FDE_FHIR_PAGE_COUNT | Number of resources to fetch per page | 1000 | Integer |
| FDE_FHIR_BEARER_TOKEN | Bearer token for FHIR server authentication | (empty) | String |
| FDE_FHIR_OAUTH_ISSUER_URI | OAuth issuer URI for FHIR server | (empty) | URL |
| FDE_FHIR_OAUTH_CLIENT_ID | OAuth client ID for FHIR server | (empty) | String |
| FDE_FHIR_OAUTH_CLIENT_SECRET | OAuth client secret for FHIR server | (empty) | String |
| FDE_MAX_IN_MEMORY_SIZE_MIB | Maximum size (in MiB) of in-memory data storage | 10 | Integer |
| FDE_INPUT_MEASURE | Path to the input measure JSON file | ./measure/kds-measure.json | File path |
| FDE_OUTPUT_DIR | Directory to save output files | ./output | Directory path |
| FDE_TZ | Time zone to use for processing | Europe/Berlin | Time zone |
| FDE_FHIR_REPORT_DESTINATION_SERVER | FHIR server to send reports to | http://localhost:8080/fhir | URL |
| FDE_SEND_REPORT_TO_SERVER | Whether to send the generated report to the server | true | true, false |
| FDE_AUTHOR_IDENTIFIER_SYSTEM | System for the author's identifier | http://dsf.dev/sid/organization-identifier | URL |
| FDE_AUTHOR_IDENTIFIER_VALUE | Value for the author's identifier | fde-dic | String |
| FDE_PROJECT_IDENTIFIER_SYSTEM | System for the project's identifier | http://medizininformatik-initiative.de/sid/project-identifier | URL |
| FDE_PROJECT_IDENTIFIER_VALUE | Value for the project's identifier | fdpg-data-availability-report | String |

0 comments on commit dcc0183

Please sign in to comment.