@rethinkhealth/hl7v2-lint-message-version

Lint rule that checks an HL7v2 message version (MSH-12) satisfies a version expression.

Installation

pnpm add -D @rethinkhealth/hl7v2-lint-message-version

Usage

import { unified } from "unified";
import { hl7v2Parser } from "@rethinkhealth/hl7v2-parser";
import hl7v2LintMessageVersion from "@rethinkhealth/hl7v2-lint-message-version";

const message = `MSH|^~\\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.5`;

const processor = unified()
  .use(hl7v2Parser)
  // default expression is "<3.0.0 >=2.3"
  .use(hl7v2LintMessageVersion, { expression: "<3.0.0 >=2.3" });

await processor.process(message);

Options

• expression: string (optional)
  • A semver-like range expression evaluated against MSH-12.
  • Defaults to "<3.0.0 >=2.3".

Expressions are parsed and evaluated by @rethinkhealth/hl7v2-util-semver.

Examples

• ✅ Valid within default range (default "<3.0.0 >=2.3")

MSH|^~\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.5

• ❌ Invalid: below minimum (2.3)

MSH|^~\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.2

• ✅ Custom expression allowing 2.2

unified()
  .use(hl7v2Parser)
  .use(hl7v2LintMessageVersion, { expression: "<3.0.0 >=2.2" });

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Code of Conduct

To ensure a welcoming and positive environment, we have a Code of Conduct that all contributors and participants are expected to adhere to.

License

Copyright 2025 Rethink Health, SUARL. All rights reserved.

This program is licensed to you under the terms of the MIT License. This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for details.