# @cosyte/hl7 中文文档

规范地址：https://npmcn.com/package/%40cosyte/hl7/

版本：0\.1\.8
npm 元数据更新时间：2026-11-10T11:55:58.495Z
中文译文更新时间：2026-11-10T20:32:34.846Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cosyte/hl7
原文对照：https://npmcn.com/package/%40cosyte/hl7/?lang=original
项目主页：https://docs.cosyte.com/hl7
源码仓库：https://github.com/cosyte/hl7

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.5 MB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- peer 依赖：fast-check ^4\.0\.0
- 首次发布：2026-07-17T00:59:10.336Z
- 最新版本发布：2026-11-10T11:55:57.661Z
- 近 30 天下载量：6138（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 19 个）

## 中文简介

面向Node.js和TypeScript的开发者HL7 v2工具包,消息解析和构建,突变和序列化,以及一行帮助.

## 安装

```sh
npm install @cosyte/hl7
```

也可以使用：`pnpm add @cosyte/hl7`、`yarn add @cosyte/hl7`、`bun add @cosyte/hl7`

## README

[![The Cosyte logo on its own white ground: the icon beside the word Cosyte.](https://cosyte.com/tile/cosyte-lockup-tile-on-light-1200x300.png)](https://cosyte.com/)

# @cosyte/hl7 (韩语)

> 解析真实世界,销售商-quirky HL7 v2消息,并取出一行需要的字段,而不读取光谱.

[![npm version](https://img.shields.io/npm/v/@cosyte/hl7.svg)](https://www.npmjs.com/package/@cosyte/hl7) [![CI](https://img.shields.io/github/actions/workflow/status/cosyte/hl7/ci.yml?branch=main&label=CI)](https://github.com/cosyte/hl7/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/cosyte/hl7/blob/main/LICENSE) [![Node](https://img.shields.io/badge/node-%3E%3D22.0.0-brightgreen.svg)](https://nodejs.org/)

一个面向开发者的HL7 v2 解析器和用于Node.js和TypeScript的公用库. 对您实际使用的HL7的10%进行优化,另外的90%在您需要的时候仍然有一个接入器离开.

* * *

## 目录

-   [为什么会这样](https://npmcn.com/package/%40cosyte/hl7/#readme-why-this-exists)
-   [状态](https://npmcn.com/package/%40cosyte/hl7/#readme-status)
-   [安装](https://npmcn.com/package/%40cosyte/hl7/#readme-install)
-   [使用量](https://npmcn.com/package/%40cosyte/hl7/#readme-usage)
-   [文档](https://npmcn.com/package/%40cosyte/hl7/#readme-documentation)
-   [支助](https://npmcn.com/package/%40cosyte/hl7/#readme-support)
-   [警卫](https://npmcn.com/package/%40cosyte/hl7/#readme-security)
-   [捐款](https://npmcn.com/package/%40cosyte/hl7/#readme-contributing)
-   [商标](https://npmcn.com/package/%40cosyte/hl7/#readme-trademarks)
-   [许可证](https://npmcn.com/package/%40cosyte/hl7/#readme-license)

* * *

## 为什么会这样

HL7 v2是医院系统实际使用的格式,从中读出一个字段通常需要通过2000页的规格绕道才能得知患者的医疗记录号码是: `PID-3.1` 而消息时间是 `MSH-7`。这个库是为应用程序开发者设计的,该开发者必须消耗该流量,而不是首先成为HL7专家: `msg.patient?.mrn` 财务报告和审定财务报表 `msg.meta.timestamp` 是整个学习曲线。 最近的选择是分开 `|` 财务报告和审定财务报表 `^` 自己,或者找到一个解析器 手拿回一棵位置树 并且仍然期望你了解段数和字段数。 这些会给你结构;这会让你得到球场, 当您需要时将位置树保留在下面, 并且将小贩的微小真实世界输入视为正常情况而不是错误.

* * *

## 状态

0.1线. 公共 API 已安分并安全可依赖: 输出函数,消息和帮助器会浮出水面,以及20个稳定的警告代码是版本所声称的,而将警告代码更名在此算作突破性变化.

没有什么会排队的. `parseStream` 逐个解析多GB批量文件,并将信件生成为可同步的 `emitMessageSchema` 制作 JSON Schema 和 Zod 描述 `toJSON()` 返回。 两者都是出口的,因此上述稳定主张都涵盖了两者.

选入结构验证船也: `validateMessageStructure(msg)` 对 HL7 的已发布消息结构执行分区命令和主线。 见 [检查已发布结构的顺序和计数](https://github.com/cosyte/hl7/blob/main/docs-content/validate-messages.md#check-order-and-counts-against-the-published-structure)。 。 。 .

打印的信息覆盖了船舶,并包含在稳定性索赔中: `msg.is("ADT^A01")` 从解析器所提取的信件类型中解答,并缩小了对编译器的邮件,因此检查后的访问器被范围化到信件类型已发布的结构所需要的部分. 见 [将消息缩小到其类型](https://github.com/cosyte/hl7/blob/main/docs-content/read-patient-and-visit.md#narrow-a-message-to-its-type)。 。 。 .

永远超出范围:

-   **网络运输**: 通过 MLLP 发送和接收 [`@cosyte/mllp`](https://github.com/cosyte/mllp)任务; 此库只解析, 并且只在读取时跳出 MLLP 框架 .
-   **HL7 v3 和 CDA 数据**: 不同的家族; 不在我们计划中.
-   **FHIR 转换**数字 : [`@cosyte/transform`](https://github.com/cosyte/transform) 将解析后的信件转换为 FHIR R4; 此库没有 .
-   **穷尽编码值验证**:我们验证结构,不是每个HL7表. 为此整合一个域验证器(例如您的LIS的内部代码注册).

* * *

## 安装

```bash
# pnpm (recommended). Also works with: npm install @cosyte/hl7  |  yarn add @cosyte/hl7
pnpm add @cosyte/hl7
```

要求在22、24和26日测试的节点js 22或以后测试(`engines.node` 实值 `>=22.0.0`) (中文(简体) ). 一揽子船舶具有无害环境管理和共同JS的双重性质,并附有两者的申报类型,因此 `import` 财务报告和审定财务报表 `require` 既工作,也不需要一个相容的shim。 有零运行时间依赖性:节点标准库就是它装入的全部. 可选 `@cosyte/hl7/arbitraries` 进入点,快速检查发电机 [属性测试自己的代码](https://github.com/cosyte/hl7/blob/main/docs-content/property-test-your-code.md),需求 `fast-check` 安装在旁边;主入口从不加载.

* * *

## 使用量

分析一个消息,读字段离开它。 不需要HL7光谱知识.

```ts
import { parseHL7 } from "@cosyte/hl7";

// A synthetic ADT^A01 admit. HL7 v2 ends every segment with a carriage return.
const raw =
  "MSH|^~\\&|EPIC|MAIN|LIS|REF|20260419101500||ADT^A01^ADT_A01|MSG00001|P|2.5\r" +
  "EVN|A01|20260419101500\r" +
  "PID|1||MRN12345^^^HOSP^MR||Doe^John^Q||19800115|M|||123 Main St^^Boston^MA^02101||^PRN^PH^^^617^5551212\r" +
  "PV1|1|I|ICU^101^A^HOSP|||||ATTEND^Smith^Jane^^^^MD|||||||||||VISIT001\r";

const msg = parseHL7(raw);

console.log("Patient record number:", msg.patient?.mrn);
console.log("Full name:", msg.patient?.fullName);
console.log("Date of birth:", msg.patient?.dateOfBirth?.raw);
console.log("Precision:", msg.patient?.dateOfBirth?.precision);
console.log("Message type:", msg.meta.type);
console.log("Sent at:", msg.meta.timestamp?.raw);
console.log("Ward:", msg.visit?.location?.pointOfCare);
```

```text
Patient record number: MRN12345
Full name: John Q Doe
Date of birth: 19800115
Precision: day
Message type: ADT^A01^ADT_A01
Sent at: 20260419101500
Ward: ICU
```

测试套件从这个 README 读取该块, 运行在包上, 如果上面的输出停止匹配代码打印, 则失败 。 电文是寄存器测试仪器的合成固定件的复制件.

说明 `precision`出生日期是一天,不是瞬间 每一次约会都是忠贞的 `TS` 保持了精确度和时区 而不是猜测 `Date`。 。 。 .

这就是整个投出点:没有配置,没有计划上传,没有光谱检索. 解析器默认接受销售商-夸克输入,如果存在则剥去MLLP框架,使外壳正常化,并容忍真实的HL7流量经常携带的十几等偏差. 您到达严格的模式, 点- 路径, 或配置文件 当您需要它们, 而不是之前.

* * *

## 文档

完整参考文献 [docs.cosyte.com/hl7 (中文(简体) )](https://docs.cosyte.com/hl7),从此寄存器 [`docs-content/`](https://github.com/cosyte/hl7/tree/main/docs-content)从这些页面开始:

-   [教程: 处理实验室种子](https://github.com/cosyte/hl7/blob/main/docs-content/process-a-lab-feed.md):拆分一批文件,读取结果,标出异常的,用ACK回答每个消息.
-   [读信的三种方式](https://github.com/cosyte/hl7/blob/main/docs-content/access-patterns.md):一个90秒的HL7 v2入门器,后被命名为"助行器","点-路径"和"分块树".
-   如何指导: [病人和探视](https://github.com/cosyte/hl7/blob/main/docs-content/read-patient-and-visit.md), (中文(简体) ), [实验室结果](https://github.com/cosyte/hl7/blob/main/docs-content/read-lab-results.md), (中文(简体) ), [临床清单](https://github.com/cosyte/hl7/blob/main/docs-content/read-clinical-lists.md), (中文(简体) ), [合并](https://github.com/cosyte/hl7/blob/main/docs-content/handle-patient-merges.md), (中文(简体) ), [日期](https://github.com/cosyte/hl7/blob/main/docs-content/read-dates-and-times.md), (中文(简体) ), [编辑](https://github.com/cosyte/hl7/blob/main/docs-content/modify-and-resend.md), (中文(简体) ), [大楼](https://github.com/cosyte/hl7/blob/main/docs-content/build-messages.md), (中文(简体) ), [ACKs 缩写](https://github.com/cosyte/hl7/blob/main/docs-content/acknowledge-messages.md), (中文(简体) ), [批和流](https://github.com/cosyte/hl7/blob/main/docs-content/split-batches-and-streams.md) 财务报告和审定财务报表 [验证](https://github.com/cosyte/hl7/blob/main/docs-content/validate-messages.md)。 。 。 .
-   [使用和撰写供应商简介](https://github.com/cosyte/hl7/blob/main/docs-content/profiles.md):内置剖面图,自有,分层,并发布一.
-   [容忍和错误处理](https://github.com/cosyte/hl7/blob/main/docs-content/tolerance-and-errors.md):四个容忍级和库所抛出的错误.
-   [警告和致命代码](https://github.com/cosyte/hl7/blob/main/docs-content/warning-and-fatal-codes.md):每个稳定的代码和它的含义.

* * *

## 支助

问题,错误报告, 和怪异的目击都从 [问题跟踪器](https://github.com/cosyte/hl7/issues),任何重构都足以在拉出请求之前需要讨论.

需要一个 HL7 v2 集成, 或主机和运行你? 看我们的 [融合服务](https://cosyte.com/integration-services)。 。 。 .

* * *

## 警卫

私下报告脆弱性,如: [安全政策](https://github.com/cosyte/.github/blob/main/SECURITY.md) 描述,从来没有在公共问题.

### PHI 与安全

HL7 v2 消息携带病人数据,所以这个库用你手取的字节做什么是其合同的一部分.

**它不记录.** 没有日志, 没有调试通道, 没有 `console` 给图书馆的任何地方打电话:诊断器会还给你,从不打印. 被容忍的偏差会变成 `Hl7ParseWarning` 带有稳定代码、有界消息和位置的值(`segmentIndex`, (中文(简体) ), `fieldIndex`),从不会触发它们的字段值,所以一个警告是安全的,可以登录为正.

**一个领域是一个例外,而且是有意的.** `Hl7ParseError.snippet` 包含您输入的最多 40 个字符, 且未编辑, 因此一个致命的解析失败是可操作的 。 这是唯一一个不过滤而回放输入的字段,库不编辑它,如果遵守状态需要,它也是第一个剥去字段. `Hl7ParseError.message` 被绑定而不是绝对的内容免费 : 它只与符号匹配 spec 定义的形状( 三字符段标识符、 消息类型、 版本、 已知的字符集标签) 并保留其它任何内容 , 才会重复符号 .

**它保留你所不持有的一切.** 解析返回一个 `Hl7Message` 信息包含在物体上,没有其它地方 没有缓存,没有集合,也没有模块级的信息数据存储,所以当您放弃引用时内容会被放出. 库所保存的全过程状态的一块是可选的已注册默认配置,它持有解析配置,而不是耐心数据.

**写作和寄出什么.** 没有打开文件, 没有写入目录, 也没有网络连接: 仅导入库 `node:buffer` 财务报告和审定财务报表 `node:crypto` 从标准库中获取,并具有零运行时间依赖性. `parseStream` 读取您提供的溪流并打开任何本身. `toString()`, (中文(简体) ), `toJSON()`,以及 `prettyPrint()` 将信件内容按设计带回给您;接下来是您的电话 `prettyPrint()` 特别是真实病人数据的调试视图,而不是编辑的.

**留你的东西.** 运输安全、储存、保留和审计、在任何东西到达日志或错误跟踪器之前进行编辑,以及访问控制都是消耗性应用程序。 一个解析器不能使一个系统符合HIPAA,而这个系统并不声称符合.

* * *

## 捐款

欢迎供应商-Quirk固定装置、配置图改进和独立配置图包。 测试套件所覆盖的更真实世界边缘案例,解析器得到的强度也越高. 每个出版的简介包都是通过信号和回馈的贡献.

该组织 [贡献指南](https://github.com/cosyte/.github/blob/main/CONTRIBUTING.md) 财务报告和审定财务报表 [行为守则](https://github.com/cosyte/.github/blob/main/CODE_OF_CONDUCT.md) 在此应用. [捐款额](https://github.com/cosyte/hl7/blob/main/CONTRIBUTING.md) 添加此寄存器的具体内容: dev setup, 大门, 以及如何提交 PR .

* * *

## 商标

Epic、Cerner、MEDITECH、Athenahealth、LabCorp、Quest诊断、Visge(影像成像)和Philips(Vue PACS)是其各自所有者的商标。 Cosyte不附属于、经核可或 由其中任何一个赞助:名称表示其真实世界信息对内置配置文件所容纳的系统产生震动。 见 [贸易](https://github.com/cosyte/hl7/blob/main/TRADEMARKS.md)。 。 。 .

## 许可证

MIT,版权 (c) 2026 Cosyte LLC. 见 [自由主义](https://github.com/cosyte/hl7/blob/main/LICENSE)。 。 。 .

* * *

_由 [调和](https://cosyte.com/)。 。 。 ._

## 常见问题

### @cosyte/hl7 是什么？

面向Node\.js和TypeScript的开发者HL7 v2工具包,消息解析和构建,突变和序列化,以及一行帮助\.

### 如何安装 @cosyte/hl7？

在项目目录运行 npm install @cosyte/hl7，或使用 pnpm add / yarn add / bun add。

### @cosyte/hl7 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cosyte/hl7 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cosyte/hl7 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cosyte/hl7 可以商用吗？

@cosyte/hl7 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cosyte/hl7 的下载量有多少？

根据 npm 官方下载统计，@cosyte/hl7 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,138 次，日均约 205 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cosyte/hl7 还在维护吗？

最新版本 0\.1\.8 发布于 2026/11/10（今天）；至今共发布 19 个版本，其中过去 12 个月发布了 19 个；首次发布于 2026/07/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。