Skip to content

Commit 554f511

Browse files
committed
adding troubleshooting guide for BOMs
1 parent 3e0dc3a commit 554f511

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ A Node.js framework for extracting mCODE FHIR resources. All resources are profi
1919
- [Masking Patient Data](#masking-patient-data)
2020
- [Extraction Date Range](#extraction-date-range)
2121
- [CLI From-Date and To-Date (NOT recommended use)](#cli-from-date-and-to-date-not-recommended-use)
22+
- [Troubleshooting](#troubleshooting)
23+
- [Byte Order Markers in CSV Files](#byte-order-markers-in-csv-files)
2224
- [Terminology and Architecture](#terminology-and-architecture)
2325
- [Glossary](#glossary)
2426
- [High Level Diagram](#high-level-diagram)
@@ -161,6 +163,18 @@ If a `from-date` is provided as an option when running the mCODE Extraction Clie
161163
npm start -- --entries-filter --from-date <YYYY-MM-DD> --to-date <YYYY-MM-DD> --config-filepath <path>
162164
```
163165

166+
### Troubleshooting
167+
168+
#### Byte Order Markers in CSV Files
169+
170+
The extraction client has built-in handling of byte order markers for CSV files in UTF-8 and UTF-16 encodings. When using CSV files in other encodings, if you experience unexpected errors be sure to check for a byte order marker at the beginning of the file. One way to check is to run the following command from the command line:
171+
172+
```bash
173+
cat -v file.csv
174+
```
175+
176+
If there is an unexpected symbol at the beginning of the file, then there is a byte order marker that needs to be removed.
177+
164178
## Terminology and Architecture
165179

166180
This framework consists of three key components: Extractors, Modules and Templates. Below is, in order:

0 commit comments

Comments
 (0)