radarbase/radar-redcapintegration

RADAR-Base REDCap 集成

![构建状态]([***]

REDCap 是一个安全的Web应用，用于构建和管理在线调查和数据库。虽然REDCap可用于收集几乎任何类型的数据（包括符合21 CFR Part 11、FISMA和HIPAA标准的环境），但它特别适用于支持研究和操作中的在线或离线数据采集。REDCap联盟是一个庞大的协作者支持网络，由来自一百多个国家的数千个活跃机构合作伙伴组成，他们以各种方式使用和支持REDCap。

REDCap集成Web应用将REDCap项目与https://github.com/RADAR-base/ManagementPortal%E4%B8%8A%E7%9A%84%E9%A1%B9%E7%9B%AE%E9%9B%86%E6%88%90%EF%BC%8C%E9%93%BE%E6%8E%A5%E4%B8%A4%E4%B8%AA%E7%B3%BB%E7%BB%9F%E4%B8%AD%E7%9A%84%E5%AF%B9%E5%BA%94%E5%8F%97%E8%AF%95%E8%80%85%E3%80%82%E8%BF%99%E7%A1%AE%E4%BF%9D%E4%B8%AA%E4%BA%BA%E8%BA%AB%E4%BB%BD%E4%BF%A1%E6%81%AF%E5%AE%89%E5%85%A8%E5%AD%98%E5%82%A8%E5%9C%A8REDCap%E4%B8%AD%EF%BC%88%E4%B8%8D%E5%9C%A8https://github.com/RADAR-base/RADAR-Docker%E5%B9%B3%E5%8F%B0%E5%86%85%EF%BC%89%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87%E5%81%87%E5%90%8D%E5%8C%96%E6%95%B0%E6%8D%AE%EF%BC%88%E4%BA%BA%E7%B1%BB%E5%8F%AF%E8%AF%BBID%E5%92%8CUUID%EF%BC%89%E8%BF%9B%E8%A1%8C%E9%93%BE%E6%8E%A5%E3%80%82%E9%9D%9E%E8%BA%AB%E4%BB%BD%E8%AF%86%E5%88%AB%E7%9A%84%E4%BC%A0%E6%84%9F%E5%99%A8%E6%95%B0%E6%8D%AE%E5%AD%98%E5%82%A8%E5%9C%A8RADAR-base%E5%B9%B3%E5%8F%B0%E4%B8%AD%E3%80%82

在REDCap中，可以将“数据录入触发器”设置为高级功能。它提供了一种让REDCap触发对远程Web地址（URL）调用的方式，当项目中任何数据收集工具或调查的任何记录或调查响应被创建或修改时（不会由数据导入触发，仅由调查和数据录入表单上的正常数据录入触发），REDCap会向指定URL发送HTTP POST请求。其主要目的是在记录/响应创建或修改时通知REDCap外部的其他远程系统，以触发远程网站的某种操作，例如调用REDCap API。

设置“数据录入触发器”的步骤：

1. 使用项目管理员账户登录REDCap项目
2. 进入“项目设置”视图
3. 进入“启用可选模块和自定义”并点击“额外自定义”
4. 添加有效的URL
5. 验证REDCap是否可访问该URL
6. 启用“数据录入触发器”
7. 点击“保存”

本项目暴露的REST端点位于<host>:<port>/redcap/trigger，若端口映射到8080，则可通过<host>/redcap/trigger访问。

强烈建议使用加密连接（即SSL/HTTPS）来访问设置的“数据录入触发器”。

工作原理

服务接收到请求后，会验证触发器是否与REDCap入组事件相关。若是，则触发在https://github.com/RADAR-base/ManagementPortal%E4%B8%AD%E5%88%9B%E5%BB%BA%E5%8F%97%E8%AF%95%E8%80%85%E3%80%82%E5%88%9B%E5%BB%BA%E6%96%B0%E5%8F%97%E8%AF%95%E8%80%85%E5%90%8E%EF%BC%8C%E6%9C%8D%E5%8A%A1%E4%BC%9A%E6%9B%B4%E6%96%B0RADAR REDCap的“RADAR入组”表单，添加：

• RADAR-Base 受试者标识符：RADAR-Base平台实例内的唯一标识符
• 人类可读标识符：用于数据可视化的唯一标识符 流程结束后，“RADAR入组”状态将变为“已完成”。

“RADAR入组”建立了REDCap中存储的数据与RADAR-Base平台中存储的数据之间的关联。

配置

本服务需要名为radar.yml的配置文件，可存储在以下位置：

• /usr/local/etc/radar-redcap-int/
• 环境变量REDCAP_INTEGRATION_CONFIG_FOLDER指定的路径

配置应遵循此模板。对于每个支持的项目，projects变量应包含如下条目：

yaml
redcap_info:
  url: #指向REDCap实例的URL
  project_id: #REDCap项目标识符
  enrolment_event: #入组事件的唯一标识符
  integration_form: #集成REDCap表单的名称
  token: #用于REDCap用户在REDCap实例中身份验证的API令牌
  attributes:
    - field_name: #REDCap中指定的属性字段名，支持多个field_name
mp_info:
  project_name: #管理门户项目标识符

服务在部署阶段会验证配置文件。若文件无效，部署将停止。

日志文件

本项目设计为部署在https://javaee.github.io/grizzly/%E4%B8%8A%E3%80%82%E5%BA%94%E7%94%A8%E6%97%A5%E5%BF%97%E9%87%8D%E5%AE%9A%E5%90%91%E5%88%B0%60%E6%A0%87%E5%87%86%E8%BE%93%E5%87%BA%60%E3%80%82

Docker部署示例

1. 更新根目录下的radar.yml以确保配置正确。
2. 使用根目录中的Dockerfile构建名为redcapintegration的Docker镜像： $ docker build -t redcapintegration .
3. 使用上述创建的镜像运行容器，将主机8080端口映射到容器8080端口： $ docker run --name redcapintegration -v "/your/absolute/path/radar.yml:/usr/local/conf/radar/redcap-int/" -it --rm -d -p 8080:8080 redcapintegration
4. 访问入口点： $ curl -X POST "<Host IP或URL>:<Port>/redcap/trigger"
5. 若在容器所在机器上访问： $ curl -X POST "http://localhost:8080/redcap/trigger
6. 请注意，radar.yml配置文件必须有效，否则部署将失败。

Docker-compose示例

若使用docker-compose与其他组件一起运行，可在services标签下添加以下内容到docker-compose.yml文件：

yaml
  redcap-integration:
    build: .
    image: redcapintegration
    networks:
      - default
    restart: always
    volumes:
      - "./radar.yml:/usr/local/conf/radar/redcap-int/"
    healthcheck:
      test: ["CMD", "curl", "-IX", "POST", "http://localhost:8080/redcap/trigger"]
      interval: 1m
      timeout: 5s
      retries: 3

更多信息请查看RADAR-base平台的https://github.com/RADAR-base/RADAR-Docker/blob/master/dcompose-stack/radar-cp-hadoop-stack/docker-compose.yml%E3%80%82

脚本

脚本文件夹下有一个Python脚本，用于从REDCap项目下载非身份识别数据并上传到指定的FTP服务器。它作为RADAR-Base项目的cron任务运行，为数据分析师提供REDCap数据。FTP认证详情可通过.netrc文件或脚本参数提供。需要requests库。

使用方法：

python3 scripts/redcap-extract.py --help
python3 scripts/redcap-extract.py PROJECT_NAME REDCAP_TOKEN --redcap-url URL --ftp-ip IP 

credits

本文档部分内容摘录自REDCap文档。