jtravan3/hapi-fhir-validator-api

HAPI FHIR 验证器 API

!https://github.com/jtravan3/hapi-fhir-validator-api/workflows/Java%20CI/badge.svg https://img.shields.io/badge/License-MIT-yellow.svg](https://opensource.org/licenses/MIT) https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square]([***]

什么是 FHIR 验证器 API？

HAPI FHIR 验证器 API 是一个简单的 REST API，用于验证 FHIR 对象的结构和内容。该 API 基于 HAPI FHIR 框架，支持所有版本的 FHIR 对象验证。FHIR（Fast Healthcare Interoperability Resources，快速互操作性资源）是领域数据传输的标准。

API 结构

查看我们的 Swagger Hub API
若要查看原始 JSON，请访问 http://localhost:5000/v2/api-docs

开始使用

查看我们的 https://github.com/jtravan3/hapi-fhir-validator-api/blob/master/docs/how-to-validate-fhir-resources.md

快速开始

bash
docker run --name hapi-fhir-validator-api -p 5000:5000 jtravan3/hapi-fhir-validator-api:latest

访问 http://localhost:5000/swagger-ui/index.html 即可使用 API，可直接调用端点。

开发者设置

无 Docker 环境设置

1. 安装 Maven 3.6.0 和 Java JDK 11。JDK 可从 https://openjdk.java.net/install/ 获取，或使用仓库中的 Maven 包装器。

   bash
   brew install maven
   

2. 从 GitHub 克隆仓库

   bash
   git clone git@github.com:jtravan3/hapi-fhir-validator-api.git
   

3. 配置属性后构建项目

   bash
   ./mvnw clean install
   

4. 运行 API

   bash
   ./mvnw spring-boot:run
   

   项目配置了 Spring Dev Tools，支持热重载无需重启应用。修改后重建项目（IntelliJ 中使用 Build -> Build Project 或 CMD + F9）即可自动重新部署。
5. 访问 http://localhost:5000/swagger-ui/index.html 使用 API。
6. 成功！

Docker 环境设置

1. 安装 Docker（https://docs.docker.com/docker-for-mac/install/%EF%BC%89%E3%80%82
2. 从 GitHub 克隆仓库

   bash
   git clone git@github.com:jtravan3/hapi-fhir-validator-api.git
   

3. 运行 API

   bash
   docker-compose up
   

4. 访问 http://localhost:5000/swagger-ui/index.html 使用 API。
5. 成功！

使用 Swagger

1. 访问 http://localhost:5000/swagger-ui/index.html%E3%80%82
2. 选择要测试的验证端点。
3. 将 {} 替换为要验证的 FHIR JSON 对象，并选择 X-Validate-Ignore-Codesystem 头的值。
4. 点击 Execute，然后向下滚动查看响应。若成功，将返回如下 JSON：

   json
   {
     "successful": true,
     "errors": [],
     "warnings": [],
     "info": [],
     "exception": null
   }
   

   若存在问题，消息将按严重级别分类：

   json
   {
     "successful": false,
     "errors": [
       {
         "message": "Unrecognised property '@nae'",
         "locationString": "/Parameters/parameter",
         "severity": "ERROR",
         "locationLine": null,
         "locationCol": null
       }
     ],
     "warnings": [],
     "info": [],
     "exception": null
   }
   

放松验证

若需放松验证，可传递头信息 X-Validate-Ignore-Codesystem 并设置值为 true，以忽略某些代码系统和配置文件。这将仅验证 FHIR 资源的结构而非系统内容，适用于无法控制数据源的场景。

贡献

详情请查看 https://github.com/jtravan3/hapi-fhir-validator-api/blob/master/CONTRIBUTING.md%E3%80%82

问题

若遇到 bug，请提交 issue。通用问题请在 https://stackoverflow.com/search?q=hapi-fhir-validator-api 上使用标签 hapi-fhir-validator-api 提问。

许可证

项目内容本身采用 https://creativecommons.org/licenses/by/3.0/ 许可证，底层源代码采用 https://github.com/jtravan3/hapi-fhir-validator-api/blob/master/LICENSE.md%E3%80%82

资源

Spring Boot

• https://start.spring.io/
• https://spring.io/guides/gs/spring-boot/

Maven

• https://spring.io/guides/gs/spring-boot/
• https://maven.apache.org/guides/index.html
• https://maven.apache.org/guides/getting-started/