ohdsi/webapi

OHDSI WebAPI 中文技术文档

镜像概述和主要用途

OHDSI WebAPI 是一个集成了所有 OHDSI RESTful 服务的应用程序，可被各类 OHDSI 应用调用，提供标准化的数据访问和分析能力，支持基于通用数据模型（CDM）的***数据分析流程。

核心功能和特性

• 提供集中式 API，支持与 1 个或多个转换为 https://github.com/OHDSI/CommonDataModel%EF%BC%88CDM%EF%BC%89v5 的数据库交互
• 搜索 OMOP 标准化词汇表中的医学概念，构建概念集
• 定义队列（cohort）定义，用于识别患者群体
• 队列表征分析
• 发病率计算
• 患者档案检索
• 设计人群水平评估和患者水平预测研究

使用场景和适用范围

OHDSI WebAPI 适用于***健康领域的数据分析与研究场景，包括但不限于：

• 基于 CDM 标准数据库的多源***数据整合与访问
• 医学概念标准化与概念集构建（如疾病、药物、症状等）
• 特定患者群体的识别与特征分析（如某疾病患者的人口统计学特征、合并症等）
• 流行病学研究中的发病率计算与趋势分析
• 临床研究设计中的人群水平评估和预测模型开发

技术架构

• 开发语言：Java 8
• 数据库依赖：PostgreSQL（用于数据存储）
• 部署形式：Web 应用程序

API 文档

完整 API 文档可访问：[***]

使用方法和配置说明

系统要求与安装

详细的系统要求和安装步骤参见 https://github.com/OHDSI/WebAPI/wiki%E3%80%82

SAML 认证配置

通过以下参数配置 SAML 认证（键值对形式）：

Okta 配置示例：提供以下元数据文件模板

• saml/dev/idp-metadata-okta.xml（IdP 元数据）
• saml/dev/sp-metadata-okta.xml（SP 元数据）

认证提供者管理

通过以下参数启用/禁用特定认证提供者（布尔值 true/false）：

地理空间支持

地理空间功能扩展配置参见 https://github.com/OHDSI/webapi-component-geospatial%E3%80%82

Docker 部署方案示例

docker run 命令示例

bash
docker run -d \
  --name ohdsi-webapi \
  -p 8080:8080 \
  -e SPRING_DATASOURCE_URL=jdbc:postgresql://postgres-host:5432/webapi \
  -e SPRING_DATASOURCE_USERNAME=dbuser \
  -e SPRING_DATASOURCE_PASSWORD=dbpass \
  -e security.auth.jdbc.enabled=true \
  ohdsi/webapi:latest

docker-compose 配置示例

yaml
version: '3.8'
services:
  webapi:
    image: ohdsi/webapi:latest
    ports:
      - "8080:8080"
    environment:
      - SPRING_DATASOURCE_URL=jdbc:postgresql://postgres:5432/webapi
      - SPRING_DATASOURCE_USERNAME=postgres
      - SPRING_DATASOURCE_PASSWORD=postgres
      - security.auth.jdbc.enabled=true
      - security.saml.enabled=false  # 禁用 SAML（如需启用需挂载元数据文件）
    depends_on:
      - postgres

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_DB=webapi
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

测试说明

单元测试使用嵌入式 PostgreSQL 而非 H2，原因是 H2 不支持以下功能：

• 窗口函数
• md5 函数
• HEX 到 BIT 转换
• setval 函数
• set datestyle 命令
• CTAS 与 CTE 结合使用

支持与反馈

• 开发者问题/评论/反馈：OHDSI 论坛
• 缺陷/问题/增强需求跟踪：https://github.com/OHDSI/WebAPI/issues

版本控制

• 遵循 语义化版本 规范；
• 发布分支/标签的 POM.xml 中仅包含非 SNAPSHOT 依赖。

GitHub 仓库

https://github.com/OHDSI/WebAPI

许可证

OHDSI WebAPI 基于 Apache License 2.0 许可。