Skip to content

mCODE version update in Readme #163

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 1 commit into from
Nov 18, 2021
Merged

mCODE version update in Readme #163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mCODE Extraction Framework

A Node.js framework for extracting mCODE FHIR resources. All resources are profiled per the [mCODE v1.0.0 R4 FHIR Implementation Guide](https://mcodeinitiative.github.io/index.html)
A Node.js framework for extracting mCODE FHIR resources. All resources are profiled per the [mCODE v1.16.0 R4 FHIR Implementation Guide](http://hl7.org/fhir/us/mcode/2021May/)

## Table of Contents

Expand Down Expand Up @@ -44,7 +44,7 @@ There are various extractors, modules, and helper functions exposed by the frame

Each extractor exposes an asynchronous `get` function that will return a bundle of extracted mCODE data.

``` JavaScript
```JavaScript
// Example
const { CSVCancerDiseaseStatusExtractor, logger} = require('mcode-extraction-framework');

Expand Down Expand Up @@ -116,7 +116,7 @@ In order to send an email, users must specify the hostname or IP address of an S
- `port`: `<number>` (Optional) The port to connect to (defaults to 587)
- `to`: `<string[]>` Comma separated list or an array of recipients email addresses that will appear on the _To:_ field
- `from`: `<string>` (Optional) The email address of the sender. All email addresses can be plain `'[email protected]'` or formatted `'"Sender Name" [email protected]'` (defaults to [email protected], which cannot receive reply emails)
- `tlsRejectUnauthorized`: `<boolean>` (Optional) A boolean value to set the [node.js TLSSocket option](https://nodejs.org/api/tls.html#tls_class_tls_tlssocket) for rejecting any unauthorized connections, `tls.rejectUnauthorized`. (defaults to `true`)
- `tlsRejectUnauthorized`: `<boolean>` (Optional) A boolean value to set the [node.js TLSSocket option](https://nodejs.org/api/tls.html#tls_class_tls_tlssocket) for rejecting any unauthorized connections, `tls.rejectUnauthorized`. (defaults to `true`)

An example of this object can be found in [`config/csv.config.example.json`](config/csv.config.example.json).

Expand Down Expand Up @@ -161,6 +161,7 @@ Alternatively, providing a string with a value of `all` in the `constructorArgs`
}
}
```

### Extraction Date Range

The mCODE Extraction Client will extract all data that is provided in the CSV files by default, regardless of any dates associated with each row of data. It is recommended that any required date filtering is performed outside of the scope of this client.
Expand Down