医院价格透明CLI验证器
CLI 用于验证 CMS 医院价格透明机器可读文件
开始
先决条件
这些是用于开发CLI工具的最低限度版本。 建议更新节点和国家预防机制的最新发布.
- 节点(20.x版)
- 国家预防机制(8.5.x版)
安装
在全球安装 CLI
npm install -g @cmsgov/hpt-validator-cli
使用量
cms-hpt-validator --help
Usage: cms-hpt-validator [options] <filepath> <version>
Arguments:
filepath filepath to validate
version version of data dictionary requirements to validate against (choices: "v2.1", "v2.2", "v3.0")
Options:
-V, --version output the CLI version number
-f, --format <string> file format of file (choices: "csv", "json")
-o, --output <string> output format (choices: "table", "json", default: "table")
-e, --error-limit <value> maximum number for errors (default: 1000)
-h, --help display help for command
数据词典版本
参见 医院价格透明数据词典仓库 用于所有所需版本的文件.
实例
基本用途:
cms-hpt-validator ./sample.csv v3.0
覆盖默认错误限制以显示50个错误 :
cms-hpt-validator ./sample.csv v3.0 -e 50
覆盖默认错误限制以显示所有错误 :
cms-hpt-validator ./sample.csv v3.0 -e 0
使用 JSON 输出格式 :
cms-hpt-validator ./sample.csv v3.0 -o json
使用带有有限错误的 JSON 输出格式 :
cms-hpt-validator ./sample.csv v3.0 -o json -e 10
输出格式
CLI 支持两种输出格式:
表格格式( 默认)
默认的表格格式提供了带有有色文字的可人阅读输出,以结构化的表格格式显示验证结果.
JSON 格式
JSON格式提供机器可读输出,包括:
- 文件信息(路径、验证器版本、时间戳)
- 验证状态(有效/无效)
- 错误和提醒计数
- 详细错误和提醒阵列
示例 JSON 输出 :
{
"file": "/path/to/sample.csv",
"version": "1.10.0",
"timestamp": "2025-01-11T17:00:00.000Z",
"valid": false,
"errorCount": 2,
"alertCount": 1,
"errors": [
{
"path": "C4",
"field": "code | 1 | type",
"message": "Invalid code type"
}
],
"alerts": [
{
"path": "D5",
"field": "estimated_amount",
"message": "Nine 9s used for estimated amount"
}
]
}
机器可读文件扩展名
目前HPT MRF的两个允许文件格式是CSV和JSON. CLI 将自动检测传递到工具中的文件格式, 以结束文件 .csv 或者说 .json 并运行该文件的适当验证符。 CLI还可以检测被gzip压缩出的文件. 以 .gz 扩展将在验证前解压缩 。 这些文件格式检测可以合并,所以文件以 .csv.gz 或者说 .json.gz 将分别被解压和验证为CSV或JSON。 对于结束于 .gz,使用 -f 选项.
限制
可能存在CLI工具会因为在被验证文件中发现的错误数量而耗尽内存的情况. 如果您碰到了这个 NODE 错误, 请将错误的大小更新到一个较小的值, 允许随该值一起收集 -e, --error-limit 旗帜.
捐款
感谢您考虑为美国开放源码项目捐款 政府! 关于我们捐款准则的更多信息,见 捐款额
警卫
关于我们的安全、脆弱和负责任的更多信息 披露政策,见 警卫。 。 。 .
作者和维护者
撰稿人完整名单可在以下网址查阅: https://github.cms.gov/CMSGov/hpt-validator-cli/graphs/controducers. 互联网档案馆的存檔,存档日期2014-12-21。 。 。 .
公有领域
这个项目在美国的公有领域获得许可, 作品的版权和相关权利 CC0 1.0 普遍公有领域 承诺。 。 。 .
所有对该项目的贡献将在CC0专注下发布. 以 你同意遵守这项豁免 版权权益.