Initial commit

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8b86ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# ETL-Processor for bwHC data
+
+Diese Anwendung versendet ein bwHC-MTB-File an das bwHC-Backend und pseudonymisiert die Patienten-ID.
+
+## Pseudonymisierung der Patienten-ID
+
+Wenn eine URI zu einer gPAS-Instanz angegeben ist, wird diese verwendet.
+Ist diese nicht gesetzt. wird intern eine Anonymisierung der Patienten-ID vorgenommen.
+
+* `APP_PSEUDONYMIZE_PREFIX`: Standortbezogenes Prefix - `UNKNOWN`, wenn nicht gesetzt
+* `APP_PSEUDONYMIZE_GPAS_URI`: URI der gPAS-Instanz
+* `APP_PSEUDONYMIZE_GPAS_TARGET`: gPas Domänenname
+
+## Mögliche Endpunkte
+
+Für REST-Requests als auch (parallel) zur Nutzung von Kafka-Topics können Endpunkte konfiguriert werden.
+
+### REST
+
+Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an das bwHC-Backend gesendet wird:
+
+* `APP_REST_URI`: URI der zu benutzenden bwHC-Backend-Instanz
+
+### Kafka-Topics
+
+Folgende Umgebungsvariablen müssen gesetzt sein, damit ein bwHC-MTB-File an ein Kafka-Topic übermittelt wird:
+
+* `APP_KAFKA_TOPIC`: Zu verwendendes Topic
+* `APP_KAFKA_SERVERS`: Zu verwendende Kafka-Bootstrap-Server als kommagetrennte Liste
+
+Weitere Konfigrationen können über die Parameter
\ No newline at end of file