hl7v2 0.13.0 → 1.0.2

package/README.md

@@ -1,18 +1,13 @@
-  
+# HL7v2
+
 [![NPM Version][npm-image]][npm-url]
 [![NPM Downloads][downloads-image]][downloads-url]
-[![Build Status][travis-image]][travis-url]
+[![CI Tests][ci-test-image]][ci-test-url]
 [![Test Coverage][coveralls-image]][coveralls-url]
 
-[![Dependencies][dependencies-image]][dependencies-url]
-[![DevDependencies][devdependencies-image]][devdependencies-url]
-[![Package Quality][quality-image]][quality-url]
-
-
 ## About
 
-HL7 v2 parser, serializer, validator and tcp client/server for NodeJS
-
+HL7 v2.x parser, serializer and validator
 
 ## Installation
 
@@ -22,29 +17,40 @@ $ npm install hl7v2 --save
 
 ## Node Compatibility
 
-  - node >= 6.x
-  
-## Change log
-
-To see changelog click [here](https://github.com/panates/hl7v2/commits/master)
+- node >= 18.x
 
-  
 ### License
+
 HL7v2 is available under [MIT](LICENSE) license.
 
 [npm-image]: https://img.shields.io/npm/v/hl7v2.svg
+
 [npm-url]: https://npmjs.org/package/hl7v2
-[travis-image]: https://img.shields.io/travis/panates/hl7v2/master.svg
-[travis-url]: https://travis-ci.org/panates/hl7v2
+
+[ci-test-image]: https://github.com/panates/hl7v2/actions/workflows/test.yml/badge.svg
+
+[ci-test-url]: https://github.com/panates/hl7v2/actions/workflows/test.yml
+
 [coveralls-image]: https://img.shields.io/coveralls/panates/hl7v2/master.svg
+
 [coveralls-url]: https://coveralls.io/r/panates/hl7v2
+
 [downloads-image]: https://img.shields.io/npm/dm/hl7v2.svg
+
 [downloads-url]: https://npmjs.org/package/hl7v2
+
 [gitter-image]: https://badges.gitter.im/panates/hl7v2.svg
+
 [gitter-url]: https://gitter.im/panates/hl7v2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+
 [dependencies-image]: https://david-dm.org/panates/hl7v2/status.svg
+
 [dependencies-url]:https://david-dm.org/panates/hl7v2
+
 [devdependencies-image]: https://david-dm.org/panates/hl7v2/dev-status.svg
+
 [devdependencies-url]:https://david-dm.org/panates/hl7v2?type=dev
+
 [quality-image]: http://npm.packagequality.com/shield/hl7v2.png
+
 [quality-url]: http://packagequality.com/#?package=hl7v2

package/cjs/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FS = exports.VT = exports.LF = exports.CR = exports.SUBCOMPONENT_SEPARATOR = exports.ESCAPE_CHARACTER = exports.REPETITION_SEPARATOR = exports.COMPONENT_SEPARATOR = exports.FIELD_SEPARATOR = void 0;
+exports.FIELD_SEPARATOR = '|';
+exports.COMPONENT_SEPARATOR = '^';
+exports.REPETITION_SEPARATOR = '~';
+exports.ESCAPE_CHARACTER = '\\';
+exports.SUBCOMPONENT_SEPARATOR = '&';
+exports.CR = '\x0D';
+exports.LF = '\x0A';
+exports.VT = '\x0B';
+exports.FS = '\x1C';

package/cjs/dictionary/2.1/dictionary.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const hl7_dictionary_js_1 = require("../../hl7-dictionary.js");
+const index_js_1 = require("../../interfaces/index.js");
+const segments = tslib_1.__importStar(require("./segments/index.js"));
+const types = tslib_1.__importStar(require("./types/index.js"));
+const dict = new hl7_dictionary_js_1.HL7Dictionary({
+    version: index_js_1.HL7Version.v2_1,
+    segments,
+    types,
+});
+exports.default = dict;

package/cjs/dictionary/2.1/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("./patches.js");
+const dictionary_js_1 = tslib_1.__importDefault(require("./dictionary.js"));
+exports.default = dictionary_js_1.default;

package/cjs/dictionary/2.1/patches.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const valgen_1 = require("valgen");
+const hl7_date_js_1 = require("../../utils/hl7-date.js");
+const dictionary_js_1 = tslib_1.__importDefault(require("./dictionary.js"));
+dictionary_js_1.default.overwriteTypes({
+    DT: {
+        decode: hl7_date_js_1.decodeHL7Date,
+        encode: hl7_date_js_1.encodeHL7Date,
+    },
+    NM: {
+        decode: valgen_1.toNumber,
+    },
+    SI: {
+        decode: valgen_1.toInteger,
+    },
+    TS: {
+        fields: {
+            '1': {
+                decode: hl7_date_js_1.decodeHL7DateTime,
+                encode: hl7_date_js_1.encodeHL7DateTime,
+            },
+        },
+    },
+    TM: {
+        decode: hl7_date_js_1.decodeHL7Time,
+        encode: hl7_date_js_1.encodeHL7Time,
+    },
+});

package/cjs/dictionary/2.1/segments/ACC.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACC = void 0;
+exports.ACC = {
+    desc: 'Accident',
+    fields: {
+        '1': {
+            type: 'TS',
+            desc: 'Accident date/time',
+            opt: 'O',
+            rep: 1,
+            len: 19,
+        },
+        '2': {
+            type: 'ID',
+            desc: 'Accident code',
+            opt: 'O',
+            rep: 1,
+            len: 2,
+            table: 50,
+        },
+        '3': {
+            type: 'ST',
+            desc: 'Accident location',
+            opt: 'O',
+            rep: 1,
+            len: 25,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/ADD.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADD = void 0;
+exports.ADD = {
+    desc: 'Addendum',
+    fields: {
+        '1': {
+            type: 'ST',
+            desc: 'Addendum continuation pointer',
+            opt: 'O',
+            rep: 1,
+            len: 60,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/BHS.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BHS = void 0;
+exports.BHS = {
+    desc: 'Batch header',
+    fields: {
+        '1': {
+            type: 'ST',
+            desc: 'Batch field separator',
+            opt: 'R',
+            rep: 1,
+            len: 1,
+        },
+        '2': {
+            type: 'ST',
+            desc: 'Batch encoding characters',
+            opt: 'R',
+            rep: 1,
+            len: 4,
+        },
+        '3': {
+            type: 'ST',
+            desc: 'Batch sending application',
+            opt: 'O',
+            rep: 1,
+            len: 15,
+        },
+        '4': {
+            type: 'ST',
+            desc: 'Batch sending facility',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '5': {
+            type: 'ST',
+            desc: 'Batch receiving application',
+            opt: 'O',
+            rep: 1,
+            len: 15,
+        },
+        '6': {
+            type: 'ST',
+            desc: 'Batch receiving facility',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '7': {
+            type: 'TS',
+            desc: 'Batch creation date/time',
+            opt: 'O',
+            rep: 1,
+            len: 19,
+        },
+        '8': {
+            type: 'ST',
+            desc: 'Batch security',
+            opt: 'O',
+            rep: 1,
+            len: 40,
+        },
+        '9': {
+            type: 'ST',
+            desc: 'Batch name/id/type',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '10': {
+            type: 'ST',
+            desc: 'Batch comment',
+            opt: 'O',
+            rep: 1,
+            len: 80,
+        },
+        '11': {
+            type: 'ST',
+            desc: 'Batch control id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '12': {
+            type: 'ST',
+            desc: 'Reference batch control id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/BLG.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLG = void 0;
+exports.BLG = {
+    desc: 'Billing',
+    fields: {
+        '1': {
+            type: 'CM',
+            desc: 'When to charge',
+            opt: 'O',
+            rep: 1,
+            len: 15,
+        },
+        '2': {
+            type: 'ID',
+            desc: 'Charge type',
+            opt: 'O',
+            rep: 1,
+            len: 50,
+            table: 122,
+        },
+        '3': {
+            type: 'CM',
+            desc: 'Account id',
+            opt: 'O',
+            rep: 1,
+            len: 100,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/BTS.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BTS = void 0;
+exports.BTS = {
+    desc: 'Batch trailer',
+    fields: {
+        '1': {
+            type: 'ST',
+            desc: 'Batch message count',
+            opt: 'O',
+            rep: 1,
+            len: 10,
+        },
+        '2': {
+            type: 'ST',
+            desc: 'Batch comment',
+            opt: 'O',
+            rep: 1,
+            len: 80,
+        },
+        '3': {
+            type: 'CM',
+            desc: 'Batch totals',
+            opt: 'O',
+            rep: 1,
+            len: 100,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/DG1.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DG1 = void 0;
+exports.DG1 = {
+    desc: 'Diagnosis',
+    fields: {
+        '1': {
+            type: 'SI',
+            desc: 'Set id - diagnosis',
+            opt: 'R',
+            rep: 1,
+            len: 4,
+        },
+        '2': {
+            type: 'ID',
+            desc: 'Diagnosis coding method',
+            opt: 'R',
+            rep: 1,
+            len: 2,
+            table: 53,
+        },
+        '3': {
+            type: 'ID',
+            desc: 'Diagnosis code',
+            opt: 'O',
+            rep: 1,
+            len: 8,
+            table: 51,
+        },
+        '4': {
+            type: 'ST',
+            desc: 'Diagnosis description',
+            opt: 'O',
+            rep: 1,
+            len: 40,
+        },
+        '5': {
+            type: 'TS',
+            desc: 'Diagnosis date/time',
+            opt: 'O',
+            rep: 1,
+            len: 19,
+        },
+        '6': {
+            type: 'ID',
+            desc: 'Diagnosis/drg type',
+            opt: 'R',
+            rep: 1,
+            len: 2,
+            table: 52,
+        },
+        '7': {
+            type: 'ST',
+            desc: 'Major diagnostic category',
+            opt: 'O',
+            rep: 1,
+            len: 4,
+        },
+        '8': {
+            type: 'ID',
+            desc: 'Diagnostic related group',
+            opt: 'O',
+            rep: 1,
+            len: 4,
+            table: 55,
+        },
+        '9': {
+            type: 'ID',
+            desc: 'Drg approval indicator',
+            opt: 'O',
+            rep: 1,
+            len: 2,
+        },
+        '10': {
+            type: 'ID',
+            desc: 'Drg grouper review code',
+            opt: 'O',
+            rep: 1,
+            len: 2,
+            table: 56,
+        },
+        '11': {
+            type: 'ID',
+            desc: 'Outlier type',
+            opt: 'O',
+            rep: 1,
+            len: 2,
+            table: 83,
+        },
+        '12': {
+            type: 'NM',
+            desc: 'Outlier days',
+            opt: 'O',
+            rep: 1,
+            len: 3,
+        },
+        '13': {
+            type: 'NM',
+            desc: 'Outlier cost',
+            opt: 'O',
+            rep: 1,
+            len: 12,
+        },
+        '14': {
+            type: 'ST',
+            desc: 'Grouper version and type',
+            opt: 'O',
+            rep: 1,
+            len: 4,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/DSC.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DSC = void 0;
+exports.DSC = {
+    desc: 'Continuation pointer',
+    fields: {
+        '1': {
+            type: 'ST',
+            desc: 'Continuation pointer',
+            opt: 'O',
+            rep: 1,
+            len: 60,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/DSP.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DSP = void 0;
+exports.DSP = {
+    desc: 'Display data',
+    fields: {
+        '1': {
+            type: 'SI',
+            desc: 'Set id - display data',
+            opt: 'O',
+            rep: 1,
+            len: 4,
+        },
+        '2': {
+            type: 'SI',
+            desc: 'Display level',
+            opt: 'O',
+            rep: 1,
+            len: 4,
+        },
+        '3': {
+            type: 'TX',
+            desc: 'Data line',
+            opt: 'R',
+            rep: 1,
+            len: 300,
+        },
+        '4': {
+            type: 'ST',
+            desc: 'Logical break point',
+            opt: 'O',
+            rep: 1,
+            len: 2,
+        },
+        '5': {
+            type: 'TX',
+            desc: 'Result id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/ERR.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERR = void 0;
+exports.ERR = {
+    desc: 'Error',
+    fields: {
+        '1': {
+            type: 'ID',
+            desc: 'Error code and location',
+            opt: 'R',
+            rep: 'infinite',
+            len: 80,
+            table: 60,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/EVN.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVN = void 0;
+exports.EVN = {
+    desc: 'Event type',
+    fields: {
+        '1': {
+            type: 'ID',
+            desc: 'Event type code',
+            opt: 'R',
+            rep: 1,
+            len: 3,
+            table: 3,
+        },
+        '2': {
+            type: 'TS',
+            desc: 'Date/time of event',
+            opt: 'R',
+            rep: 1,
+            len: 19,
+        },
+        '3': {
+            type: 'TS',
+            desc: 'Date/time planned event',
+            opt: 'O',
+            rep: 1,
+            len: 19,
+        },
+        '4': {
+            type: 'ID',
+            desc: 'Event reason code',
+            opt: 'O',
+            rep: 1,
+            len: 3,
+            table: 62,
+        },
+    },
+};

package/cjs/dictionary/2.1/segments/FHS.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FHS = void 0;
+exports.FHS = {
+    desc: 'File header',
+    fields: {
+        '1': {
+            type: 'ST',
+            desc: 'File field separator',
+            opt: 'R',
+            rep: 1,
+            len: 1,
+        },
+        '2': {
+            type: 'ST',
+            desc: 'File encoding characters',
+            opt: 'R',
+            rep: 1,
+            len: 4,
+        },
+        '3': {
+            type: 'ST',
+            desc: 'File sending application',
+            opt: 'O',
+            rep: 1,
+            len: 15,
+        },
+        '4': {
+            type: 'ST',
+            desc: 'File sending facility',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '5': {
+            type: 'ST',
+            desc: 'File receiving application',
+            opt: 'O',
+            rep: 1,
+            len: 15,
+        },
+        '6': {
+            type: 'ST',
+            desc: 'File receiving facility',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '7': {
+            type: 'TS',
+            desc: 'Date/time of file creation',
+            opt: 'O',
+            rep: 1,
+            len: 19,
+        },
+        '8': {
+            type: 'ST',
+            desc: 'File security',
+            opt: 'O',
+            rep: 1,
+            len: 40,
+        },
+        '9': {
+            type: 'ST',
+            desc: 'File name/id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '10': {
+            type: 'ST',
+            desc: 'File header comment',
+            opt: 'O',
+            rep: 1,
+            len: 80,
+        },
+        '11': {
+            type: 'ST',
+            desc: 'File control id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+        '12': {
+            type: 'ST',
+            desc: 'Reference file control id',
+            opt: 'O',
+            rep: 1,
+            len: 20,
+        },
+    },
+};