# shr-text-import

> Imports Standard Health Record (SHR) elements from their custom grammar to the SHR models

Latest version **6.7.2** (published 2020-01-08) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install shr-text-import
pnpm add shr-text-import
yarn add shr-text-import
bun add shr-text-import
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 6.7.2 |
| Published | 2020-01-08 |
| First published | 2017-01-03 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | cmoesel |

## Links

- npm: https://www.npmjs.com/package/shr-text-import
- Repository: https://github.com/standardhealth/shr-text-import
- Homepage: https://github.com/standardhealth/shr-text-import#readme
- Issues: https://github.com/standardhealth/shr-text-import/issues
- npm.io page: https://npm.io/package/shr-text-import

## Dependencies (1)

- [antlr4](https://npm.io/package/antlr4.md) ~4.6.0

## Recent versions

- 6.7.2 (latest) — 2020-01-08
- 6.0.0-beta.2 (cimpl6-beta) — 2019-06-04
- 5.4.2-beta.1 (beta) — 2018-08-17
- 6.7.1 — 2019-12-02
- 6.7.0 — 2019-10-04
- 6.6.0 — 2019-09-20
- 6.5.0 — 2019-09-04
- 6.4.0 — 2019-08-20
- 6.3.0 — 2019-07-30
- 6.2.0 — 2019-07-25
- 6.1.0 — 2019-07-17
- 6.0.0 — 2019-06-05
- 6.0.0-beta.1 — 2019-05-30
- 5.7.1 — 2019-05-15
- 5.7.0 — 2019-03-27
- … 27 more at https://npm.io/package/shr-text-import/versions

## README

# SHR Text Import

The Standard Health Record (SHR) initiative is working to create a single, high-quality health record for every individual in the United States.  For more information, see [standardhealthrecord.org](http://standardhealthrecord.org/).

This GitHub repository contains an ES6 library for parsing SHR text definitions into the SHR models.  It also contains a simple Node.js script that imports a folder of SHR text files and prints out any errors.

The SHR text definitions and grammar files can be found in the [shr_spec](https://github.com/standardhealth/shr_spec) repo.  As the SHR text format (and content files) are still evolving, so is this import tool.

# Setting Up the Environment

This project has been developed and tested with Node.js 6.6, although other versions _may_ work.  After installing Node.js, change to the project directory and _npm install_ the dependencies:
```
$ npm install
```

# Running the Import

After installing the dependencies with npm, you can use node to import a file or folder of files from SHR text format and print out any errors:
```
$ node run.js /path/to/shr_spec/spec
```

# Running the Tests

This project contains unit tests for testing the SHR text importer and FHIR StructureDefinition exporter.  To run the tests, execute the following command:
```
$ npm test
```

During development, it is often helpful to run tests in _watch_ mode.  This launches a process that watches the filesystem for changes to the javascript files and will automatically re-run the tests whenever it detects changes.  To run the tests in _watch_ mode, execute the following command:
```
$ npm run test:watch
```

# Linting the Code

To encourage quality and consistency within the code base, all code should pass eslint without any warnings.  Many text editors can be configured to automatically flag eslint violations.  We also provide an npm script for running eslint on the project.  To run eslint, execute the following command:
```
$ npm run lint
```

# License

Copyright 2016 The MITRE Corporation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

---
_Source: https://npm.io/package/shr-text-import · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._