diff --git a/README.md b/README.md index 2ec1619..d9eb824 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ docker-compose up The project starts a server providing an endpoint to handle REDCap notifications. Then, Data Entry Trigger of a REDCap can be configured to send notification to http://localhost:8095/tofhir-redcap/notification endpoint (if you use default configurations). +Whenever this endpoint receives a notification about a record, it exports its data via REDCap API and publishes record data +to a Kafka topic which is the concatenation of project id and instrument name such as '27-patient'. + # Configuration Please see [application.conf](src/main/resources/application.conf) for the configurations. It allows you to configure Web server settings, Kafka and REDCap projects. \ No newline at end of file