ibmcom/ibm-fhir-server

IBM FHIR Server 镜像文档

概述

IBM FHIR Server 实现了 HL7 FHIR HTTP API 的 4.0.1 版（R4），支持全套 FHIR 定义的资源类型。

有关服务器及其功能的更多信息，请查看 https://ibm.github.io/FHIR%E3%80%82

运行

1. 启动服务器

4.6.0 及以上版本：

docker run -p 9443:9443 -e BOOTSTRAP_DB=true ibmcom/ibm-fhir-server

之前版本：

docker run -p 9443:9443 -e FHIR_TRANSACTION_MANAGER_TIMEOUT=240s ibmcom/ibm-fhir-server

2. 测试服务器

curl -k -i -u 'fhiruser:change-password' 'https://localhost:9443/fhir-server/api/v4/$healthcheck'

此健康检查用于测试应用服务器与数据库的连接，成功时应返回 HTTP 200 OK 响应：

sh
HTTP/2 200 
date: Wed, 14 Jul 2021 14:17:08 GMT
content-length: 0
content-language: en-US

早期版本的 IBM FHIR Server 还会返回包含单个 issue 的 OperationOutcome，详细文本为 "All OK"。

要了解此服务器的更多功能，请参见 [***] FHIR Server 的默认 [base] URL 为 https://[host]:9443/fhir-server/api/v4。

注意：4.6.0 版本之前，需设置 FHIR_TRANSACTION_MANAGER_TIMEOUT 以延长嵌入式 Derby 数据库的引导事务超时时间。从 4.6.0 版本开始，引导需通过 BOOTSTRAP_DB 环境变量手动启用，且引导过程在服务器启动前执行（因此不受服务器事务管理器限制）。虽然嵌入式数据库便于快速启动，但强烈建议在生产环境中使用外部数据库。

配置

服务器包含两个主要配置文件：

4.7.0 及以上版本：

• /opt/ol/wlp/usr/servers/defaultServer/server.xml
• /opt/ol/wlp/usr/servers/defaultServer/config/default/fhir-server-config.json

之前版本：

• /opt/ol/wlp/usr/servers/fhir-server/server.xml
• /opt/ol/wlp/usr/servers/fhir-server/config/default/fhir-server-config.json

以下部分将使用最新容器路径（defaultServer）进行说明。

server.xml

server.xml 格式由 OpenLiberty 项目 定义。可通过将扩展配置放入 /opt/ol/wlp/usr/servers/defaultServer/configDropins/overrides 目录来覆盖默认配置的特定部分。

配置端口

服务器默认仅启用 9443 端口（HTTPS）。要修改端口号，需修改 httpEndpoint 元素中的值。

配置密钥库/信任库

服务器默认包含一个密钥库文件，其中包含一个用于 localhost 的自签名证书。

生产环境中，必须为 FHIR 服务器部署创建并配置自定义密钥库和信任库文件（即生成自有服务器证书或获取可信证书，并将公钥证书分发给 API 消费者以插入其客户端信任库）。

配置认证/授权

服务器默认包含一个基本用户注册表，包含两个用户：

• 用户名 fhiruser，默认密码 change-password
• 用户名 fhiradmin，默认密码 change-password

默认密码可分别通过设置环境变量 FHIR_USER_PASSWORD 和 FHIR_ADMIN_PASSWORD 覆盖。

生产环境中，需根据具体场景配置认证/授权。有关在 Liberty 中配置用户注册表的信息，请参见 [***]

配置数据源

默认情况下，FHIR 服务器在 /opt/ol/wlp/usr/servers/fhir-server/configDropins/defaults 下包含一个嵌入式 Derby 数据源定义，JNDI 名称为 jdbc/bootstrap_default_default。

生产环境中，建议使用 PostgreSQL 或 IBM Db2。有关配置 JDBC 持久层的信息，可参见 IBM FHIR Server https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide#331-the-jdbc-persistence-layer%E3%80%82

从 4.6.0 版本开始，数据源定义必须通过 server.xml 的 configDropins 提供。镜像的 /opt/ol/wlp/usr/servers/defaultServer/configDropins/disabled 目录中包含示例定义。

fhir-server-config.json

server.xml 用于通用 Liberty 配置，而 fhir-server-config.json 用于 IBM FHIR Server 的特定配置。

有关支持的完整属性列表，请参见 https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide#51-configuration-properties-reference%E3%80%82

配置持久化

默认情况下，FHIR 服务器配置了 JDBC 持久层，使用单租户嵌入式 Derby 数据源，JNDI 名称为 jdbc/bootstrap_default_default。

生产环境中，建议使用 PostgreSQL 或 IBM Db2。有关配置 JDBC 持久层的信息，可参见 IBM FHIR Server https://ibm.github.io/FHIR/guides/FHIRServerUsersGuide#331-the-jdbc-persistence-layer%E3%80%82

要添加对其他关系型数据库的支持或“自定义持久化”，请参见 https://ibm.github.io/FHIR/guides/BringYourOwnPersistence%E3%80%82

使用 Docker 配置 IBM FHIR Server

以下是几种可重复配置 IBM FHIR Server 的模式：

将配置复制为镜像层

创建自定义 Dockerfile，添加层以复制配置到镜像中：

dockerfile
FROM ibmcom/ibm-fhir-server:your-version
COPY --chown=1001:0 fhir-server-config.json /opt/ol/wlp/usr/servers/defaultServer/config/default
COPY --chown=1001:0 overrides/ /opt/ol/wlp/usr/servers/defaultServer/configDropins/

将配置放入卷中

将 https://github.com/IBM/FHIR/tree/master/fhir-server/liberty-config/config 目录复制到本地文件夹 <local_fhir_config_dir>。

在本地系统创建 server.xml 覆盖文件夹 <local_liberty_overrides_dir>。

通过挂载本地文件夹为卷运行 Docker：

bash
docker run -p 9443:9443 \
    -v <local_fhir_config_dir>:/opt/ol/wlp/usr/servers/defaultServer/config \
    -v <local_liberty_overrides_dir>:/opt/ol/wlp/usr/servers/defaultServer/configDropins/overrides \
    ibmcom/ibm-fhir-server

在 local_fhir_config_dir 中，每个租户应有一个配置文件夹。例如，默认租户需使用 default/fhir-server-config.json，而非直接使用 fhir-server-config.json。

注意：可组合使用其他卷挂载方式。此方法的优势是配置不存储在临时存储中。

许可证

IBM FHIR Server 采用 Apache 2.0 许可证。完整许可证文本可参见 https://github.com/IBM/FHIR/blob/master/LICENSE%E3%80%82

FHIR® 是 HL7 的注册商标，经 HL7 许可使用。使用 FHIR 商标并不表示 HL7 认可本产品。

IBM 和 IBM 徽标是国际商业机器公司的商标，在全球多个司法管辖区注册。其他产品和服务名称可能是 IBM 或其他公司的商标。IBM 商标的最新列表可在 ibm.com/trademark 上获取。