You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ Examples files for these extractor can be found in the [`test/sample-client-data
85
85
86
86
#### Configuration Files: Step 3
87
87
88
-
After exporting your CSV files to the `data` directory, kickstart the creation of a configuration file by renaming the provided `mcode-csv-config.example.json` to `csv.config.json`. Then, ensure the following configuration parameters are properly set:
88
+
After exporting your CSV files to the `data` directory, kickstart the creation of a configuration file by renaming the provided `csv.config.example.json` to `csv.config.json`. Then, ensure the following configuration parameters are properly set:
89
89
90
90
1.`patientIdCsvPath` should provide a file path to a CSV file containing MRN's for relevant patients;
91
91
2. For each extractor, `filePath:` should provide a file path to a CSV file containing that corresponding extractor's data;
@@ -94,7 +94,7 @@ For instructions on setting up an email notification trigger whenever an error i
94
94
95
95
### Configuration Deep Dive
96
96
97
-
Each deployment of the mCODE Extraction Client needs a configuration file. This file will specify basic information that every run will use. The configuration file can live in the `config` directory or any directory you prefer. An illustrative example file can be found in [`config/mcode-csv-config.example.json`](config/mcode-csv-config.example.json).
97
+
Each deployment of the mCODE Extraction Client needs a configuration file. This file will specify basic information that every run will use. The configuration file can live in the `config` directory or any directory you prefer. An illustrative example file can be found in [`config/csv.config.example.json`](config/csv.config.example.json).
98
98
99
99
To specify which patients the client should extract data for, the configuration file _must_ point to a CSV file containing MRNs for each patient. The format for this file can be found [here](https://github.com/mcode/mcode-extraction-framework/blob/master/docs). An example of this file can be found in [`test/sample-client-data/patient-mrns.csv`](test/sample-client-data/patient-mrns.csv).
100
100
@@ -112,7 +112,7 @@ In order to send an email, users must specify the hostname or IP address of an S
112
112
-`to`: Comma separated list or an array of recipients email addresses that will appear on the _To:_ field
113
113
-`from`: (Optional) The email address of the sender. All email addresses can be plain `'sender@server.com'` or formatted `'"Sender Name" sender@server.com'` (defaults to mcode-extraction-errors@mitre.org, which cannot receive reply emails)
114
114
115
-
An example of this object can be found in [`config/mcode-csv-config.example.json`](config/mcode-csv-config.example.json).
115
+
An example of this object can be found in [`config/csv.config.example.json`](config/csv.config.example.json).
116
116
117
117
If the `notificationInfo` object is provided in configuration, an email will be sent using the specified options if any errors occur during data extraction. If any required field is missing in the object (`host` or `to`), an email cannot be sent. If you prefer to not have an email sent even if errors occur, you can choose to not include the `notificationInfo` object in your configuration file.
0 commit comments