smartchartsuite/omoponfhir-main-v54-r4

OMOPonFHIR 镜像文档

镜像概述和主要用途

OMOPonFHIR 是一个可安装的服务器部署包，通过子模块锁定包含组件的版本。该镜像支持 FHIR R4 与 OMOP v5.4 之间的映射，已通过 Google Big Query 实例测试，提供 FHIR API 及相关操作，适用于***数据标准化转换与 FHIR 服务部署。

核心功能和特性

• 版本锁定：通过子模块固定组件版本，确保部署一致性
• 映射支持：支持 FHIR R4 与 OMOP v5.4 数据模型映射
• 数据库兼容：已测试 Google Big Query，支持 PostgreSQL 等数据库（通过配置指定）
• 词汇表管理：支持独立词汇表 schema，可多实例共享，简化词汇管理
• FHIR API 支持：提供 FHIR 标准 API 接口，包含元数据接口（/fhir/metadata）
• 灵活配置：通过环境变量自定义数据库连接、权限认证、部署路径等参数

使用场景和适用范围

• ***数据从 OMOP CDM v5.4 格式转换为 FHIR R4 标准格式
• 部署 FHIR 服务以提供标准化***数据访问接口
• 多实例共享词汇表的***数据平台构建
• 与 Google Big Query 或 PostgreSQL 数据库集成的***数据分析系统

详细使用方法和配置说明

下载与安装

bash
# 克隆仓库（包含子模块）
git clone --recurse https://github.com/omoponfhir/omoponfhir-main-v54-r4.git
cd omoponfhir-main-v54-r4/

# 编译打包
mvn clean install

# 进入目标目录
cd omoponfhir-r4-server/target/

数据库准备

新建 OMOP 数据库

若尚无 OMOP 数据库，需创建并初始化。参考 https://github.com/omoponfhir/omopv5_4_setup 从步骤 1 开始执行。

已有 OMOP 数据库

需添加额外表/视图，参考 https://github.com/omoponfhir/omopv5_4_setup 从步骤 6 开始执行。

词汇表 Schema 设置

1. 确保词汇表 schema 包含必要表，可参考 https://github.com/SmartChartSuite/Registry-Database/blob/main/omoponfhir_v5_4_setup/OMOPCDM_postgresql_5.4_vocabulary_ONLY_ddl.sql

2. 设置环境变量指定数据与词汇表 schema：

bash
export JDBC_DATA_SCHEMA="omopv54"      # 数据所在 schema
export JDBC_VOCABS_SCHEMA="vocab"      # 词汇表所在 schema

部署方式

Tomcat 部署

bash
# 复制 war 包到 Tomcat webapps 目录
cp omoponfhir-r4-server.war <tomcat_directory>/webapps/

# 配置环境变量
cd <tomcat_directory>/bin
vi setenv.sh  # 添加环境变量配置（见下方配置说明）

Docker 部署

1. 构建镜像：

bash
sudo docker build -t omoponfhir .

2. 运行容器（直接指定环境变量）：

bash
sudo docker run --name omoponfhir -p 8080:8080 -d \
  -e JDBC_URL="jdbc:postgresql://url" \
  -e JDBC_USERNAME="your_username" \
  -e JDBC_PASSWORD="your_password" \
  omoponfhir:latest

3. 使用环境变量文件部署：

bash
# 创建 env.list 文件，包含所有环境变量
docker run --env-file env.list --name omoponfhir -p 8080:8080 -d docker.xuanyuan.run/omoponfhir:latest

验证部署

• 本地部署：访问 http://localhost:8080/ 查看 HAPI FHIR GUI
• 远程部署：使用服务器 URL 访问
• API 验证：通过 GET 请求 http://<server_url>:8080/fhir/metadata 检查服务状态

配置说明

核心环境变量

认证相关变量

数据库特定变量

注意事项

• 子模块说明：本仓库包含必要子模块，开发贡献建议直接使用各独立仓库（见下方）：
  • omoponfhir-omopv5-sql: https://github.com/omoponfhir/omoponfhir-omopv5-sql.git (分支 5.4)
  • omoponfhir-omopv5-r4-mapping: https://github.com/omoponfhir/omoponfhir-omopv5-r4-mapping.git (分支 sqlRender)
  • omoponfhir-r4-server: https://github.com/omoponfhir/omoponfhir-r4-server.git (分支 sqlRender)
• Docker 部署：默认将 war 包部署为 ROOT.war，服务路径为根目录（/）
• 服务异常排查：若服务未正常运行，优先检查数据库连接及凭据配置