Skip to content

Adding troubleshooting guide for BOMs #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jafeltra merged 3 commits into from
Apr 27, 2021
Merged

Adding troubleshooting guide for BOMs #112

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
554f511
adding troubleshooting guide for BOMs
dmendelowitz Apr 23, 2021
ff24b92
fixing UTF-16 version and command line example
dmendelowitz Apr 26, 2021
c6e8208
changing 'is' to 'may be'
dmendelowitz Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ A Node.js framework for extracting mCODE FHIR resources. All resources are profi
- [Masking Patient Data](#masking-patient-data)
- [Extraction Date Range](#extraction-date-range)
- [CLI From-Date and To-Date (NOT recommended use)](#cli-from-date-and-to-date-not-recommended-use)
- [Troubleshooting](#troubleshooting)
- [Byte Order Markers in CSV Files](#byte-order-markers-in-csv-files)
- [Terminology and Architecture](#terminology-and-architecture)
- [Glossary](#glossary)
- [High Level Diagram](#high-level-diagram)
Expand Down Expand Up @@ -161,6 +163,18 @@ If a `from-date` is provided as an option when running the mCODE Extraction Clie
npm start -- --entries-filter --from-date <YYYY-MM-DD> --to-date <YYYY-MM-DD> --config-filepath <path>
```

### Troubleshooting

#### Byte Order Markers in CSV Files

The extraction client has built-in handling of byte order markers for CSV files in UTF-8 and UTF-16LE 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:

```bash
cat -v <file.csv>
```

If there is an unexpected symbol at the beginning of the file, then there may be a byte order marker that needs to be removed.

## Terminology and Architecture

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