# @atomic-ehr/fhirschema 中文文档

规范地址：https://npmcn.com/package/%40atomic-ehr/fhirschema/

版本：0\.0\.14
npm 元数据更新时间：2026-07-24T07:05:29.555Z
中文译文更新时间：2026-11-07T03:25:00.767Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40atomic-ehr/fhirschema
原文对照：https://npmcn.com/package/%40atomic-ehr/fhirschema/?lang=original
项目主页：https://github.com/atomic-ehr/fhirschema#readme
源码仓库：https://github.com/atomic-ehr/fhirschema

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

- 包体积（解压后）：272 kB，83 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：typescript ^5
- 首次发布：2025-07-30T20:59:42.194Z
- 最新版本发布：2026-07-24T07:05:29.191Z
- 近 30 天下载量：8787（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 37 个）

## 中文简介

FHIRSchema 转换器和验证器的脚本类型

## 安装

```sh
npm install @atomic-ehr/fhirschema
```

也可以使用：`pnpm add @atomic-ehr/fhirschema`、`yarn add @atomic-ehr/fhirschema`、`bun add @atomic-ehr/fhirschema`

## README

# FHIRSCHEMA (法语)

[![npm canary](https://img.shields.io/npm/v/@atomic-ehr/fhirschema/canary.svg?label=canary)](https://www.npmjs.com/package/@atomic-ehr/fhirschema/v/canary) [![npm version](https://img.shields.io/npm/v/@atomic-ehr/fhirschema.svg)](https://www.npmjs.com/package/@atomic-ehr/fhirschema) [![CI](https://github.com/atomic-ehr/fhirschema/actions/workflows/ci.yml/badge.svg)](https://github.com/atomic-ehr/fhirschema/actions/workflows/ci.yml)

TypeScript执行FHIRSchema转换器和验证器.

## 概览

该项目提供:

-   **转换器**: 将 FHIR 结构转换为 FHIRSchema 格式
-   **验证器**:对照FHIRSchema定义验证FHIR资源

## 安装

```bash
npm install @atomic-ehr/fhirschema
```

或者安装最新的金丝雀版本 :

```bash
npm install @atomic-ehr/fhirschema@canary
```

## 使用量

### 将结构定义转换为 FHIRSchema

```typescript
import { translate } from '@atomic-ehr/fhirschema';

const structureDefinition = {
  resourceType: 'StructureDefinition',
  name: 'Patient',
  // ... rest of the StructureDefinition
};

const fhirSchema = translate(structureDefinition);
```

### 验证 FHIR 资源

```typescript
import { validate } from '@atomic-ehr/fhirschema';

const resource = {
  resourceType: 'Patient',
  // ... patient data
};

const schema = { /* FHIRSchema */ };
const context = { schemas: { Patient: schema } };

const result = validate(context, [], resource);
if (result.valid) {
  console.log('Resource is valid');
} else {
  console.log('Validation errors:', result.errors);
}
```

## 发展

### 运行测试

```bash
bun test
```

### 类型检查

```bash
bun run typecheck
```

### 大楼

```bash
bun run build
```

## 项目结构

```
├── src/
│   ├── converter/     # StructureDefinition to FHIRSchema converter
│   ├── validator/     # FHIRSchema validator
│   └── types.ts       # Shared TypeScript types
├── test/
│   ├── unit/          # Unit tests
│   └── golden/        # Golden tests with expected outputs
├── spec/              # Specifications and documentation
├── adr/               # Architecture Decision Records
└── tasks/             # Task management
```

## 发展

本项目使用:

-   **阿宝** 作为运行时间和测试跑者
-   **类型脚本** 类型安全
-   **GitHub 动作** 计算机/光盘

## 捐款

1.  叉子存储器
2.  创建您的特性分支( E)`git checkout -b feature/amazing-feature`(中文(简体) )
3.  提交更改( E)`git commit -m 'Add some amazing feature'`(中文(简体) )
4.  推向分行(`git push origin feature/amazing-feature`(中文(简体) )
5.  打开拉请求

## 许可证

\[资料待补\]

## 常见问题

### @atomic-ehr/fhirschema 是什么？

FHIRSchema 转换器和验证器的脚本类型

### 如何安装 @atomic-ehr/fhirschema？

在项目目录运行 npm install @atomic-ehr/fhirschema，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atomic-ehr/fhirschema 支持 TypeScript 吗？

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

### @atomic-ehr/fhirschema 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @atomic-ehr/fhirschema 可以商用吗？

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

### @atomic-ehr/fhirschema 的下载量有多少？

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

### @atomic-ehr/fhirschema 还在维护吗？

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