预览

本产品或功能须遵守服务专用条款的“通用服务条款”部分中的“非正式版产品条款”。 正式发布前产品和功能“按原样”提供，可能仅提供有限支持。 如需了解详情，请参阅发布阶段说明。

HL7

HL7 连接器提供与 HL7 TCP 和 REST 端点的连接。

准备工作

在使用 HL7 连接器之前，请先完成以下任务：

• 在您的 Google Cloud 项目中：
  • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
  • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
  • 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor
    • role Healthcare HL7v2 Message Ingest，仅当所选的目标协议为 REST (Google Cloud HealthCare API) 时，才需要此参数，用于将 HL7 消息提取到 HL7v2 存储区。

    服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。如需了解详情，请参阅创建服务账号。

  • 启用以下服务：
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    如需了解如何启用服务，请参阅启用服务。

  如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。

• 创建 HL7 存储区。
• 如需将 TCP(MLLP) 用作目标协议，请确保有一个 MLLP 服务器处于启动和运行状态，以接收消息。在添加目标位置时提供服务器详细信息。

配置连接器

配置连接器时，您需要创建与医疗保健系统或 Google Cloud Healthcare API 的连接。一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下步骤：

1. 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。

   转到“连接”页面

2. 点击 + 新建以打开创建连接页面。
3. 在位置部分中，选择连接的位置。
   1. 区域：从下拉列表中选择一个位置。

      如需查看所有受支持区域的列表，请参阅位置。

   2. 点击下一步。
4. 在连接详情部分中，完成以下操作：
   1. 连接器：从可用连接器的下拉列表中选择 HL7。
   2. 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
   3. 在连接名称字段中，输入连接实例的名称。

      连接名称必须符合以下条件：

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
   4. （可选）输入连接实例的说明。
   5. 服务账号：选择具有所需角色的服务账号。
   6. 如需将该关联用于事件订阅，请选择启用事件订阅。选择此选项可启用包含操作的事件订阅。
      注意 ：此连接不支持 Enable only event subscription 选项。
   7. 接收超时：在等待 MLLP 帧开始时，使用 SO_TIMEOUT 值（以毫秒为单位）。默认值为 15000 毫秒。
   8. 目标协议：从下拉菜单中选择目标协议。
   1. 如果选择 TCP (MLLP) 作为目标协议，请在添加目标时输入 MLLP 服务器的主机名和端口。
   2. 如果选择 REST (Google Cloud HealthCare API) 作为目标协议，请指定以下详细信息：
      1. 项目 ID：HL7 存储区所在的 Google Cloud 项目 ID。
      2. 位置：数据集和 HL7v2 存储区的位置。
      3. 数据集 ID：包含 HL7v2 存储区的数据集的 ID。
      4. HL7 存储区 ID：存储 HL7v2 消息的 HL7v2 存储区的 ID。
   9. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

      节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   10. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   11. 点击下一步。
5. 如果您选择了 TCP(MLLP) 作为目标协议，请在目标部分中输入要连接的远程主机 (MLLP 服务器) 的详细信息。
   1. 目标类型：选择目标类型。
      • 从列表中选择主机地址，以指定目标的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意： 如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将显示在端点连接列表中。

      如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。

      注意： 此连接器仅支持一个目标位置。
   2. 点击下一步。
6. HL7 连接不需要任何身份验证。点击下一步。
7. 如果您已启用事件订阅，则“创建关联”页面上会显示事件订阅详情部分。如需了解如何配置事件订阅详情，请参阅配置事件订阅。
8. 查看：查看您的连接和身份验证详细信息。
9. 点击创建。

配置事件订阅

在事件订阅详情部分，配置与事件相关的详细信息。

• 项目名称：Pub/Sub 实例所在的 Google Cloud 项目。
• Pub/Sub 主题名称：要与将发送通知消息的 HL7v2 存储区关联的 Pub/Sub 主题名称。
• 输入死信配置。如果您配置了死信，连接会将未处理的事件写入指定的 Pub/Sub 主题。输入以下详细信息：
  1. 退信项目 ID ：您配置退信 Pub/Sub 主题的 Google Cloud 项目 ID。
  2. 死信主题 ：您要将未处理事件的详细信息写入的 Pub/Sub 主题。

提示：如需了解如何在集成中使用事件订阅，请参阅 HL7 触发器。

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

• 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。

  但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，Entities 列表将为空。

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • 列表
  • 获取
  • 创建
  • 更新
  • 删除

  从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则 Operations 列表中不会列出此类不受支持的操作。

• 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作将具有一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，Actions 列表将为空。

注意： 所有实体和操作都具有与之关联的架构。例如，动作架构将包含参数详细信息，例如：参数名称及其相应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新不会自动反映在现有连接中；您必须手动刷新架构。如需刷新连接的架构，请打开连接的连接详情页面，然后点击刷新连接架构。

系统限制

HL7 连接器每秒可处理每个节点以下数量的事务，并会节流超出此限制的事务：

• 如果您主要使用 TCP(MLLP) 执行 sendMessage 操作，则最多可发出 39 笔事务。
• 如果您主要使用 REST(Google Cloud HealthCare API) 执行 sendMessage 操作，则最多可执行 40 笔交易。

默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

注意：集成连接器节点的数量将根据您的使用情况动态扩缩。不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。连接处理越多事务就需要越多节点。相反，如果连接处理的事务较少，则需要的节点就越少。如需配置节点值，请执行以下操作：

• 如果您是随用随付客户，请在“修改关联”页面中配置节点的最小值和最大值。
• 如果您是订阅型客户，请与支持团队联系。

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

操作

HL7 连接支持以下操作：

• sendMessage 向 TCP(MLLP) 或 REST(Google Cloud HealthCare API) 发送消息。
• transformHl7ToJson 将有效的 HL7 消息发送到 TCP(MLLP) 或 REST(Google Cloud HealthCare API)，并返回 JSON 格式的邮件。
• transformJsonToHl7 将有效的 JSON 消息发送到 TCP(MLLP) 或 REST(Google Cloud HealthCare API)，并返回 HL7 格式的邮件。
• transformAndSendHl7BatchMessage 用于将 HL7 批量消息转换为 HL7 消息列表。

sendMessage 操作

下表介绍了 sendMessage 操作的输入和输出参数。

sendMessage 操作的输入参数

参数名称	需要	数据类型	说明
消息	是	字符串	要发送到 TCP(MLLP) 服务器或 REST(Google Cloud HealthCare API) 的消息。
messageContentType	是	字符串	可指定为 Text 或 Bytes 的消息内容类型。如果您要发送二进制数据，则必须将类型设置为 Bytes。 如需以二进制格式发送消息，您必须执行以下任务： 将二进制消息编码为 Base64 字符串，然后将 message 参数设置为编码值。 将 messageContentType 参数的值设置为 Bytes。
validateMessage	否	布尔值	指示是否执行了邮件验证。
hl7Version	否	字符串	HL7 消息的版本（即 2.3、2.4 等）。
hl7MessageType	否	字符串	HL7 消息类型（例如 ADT^A01、ADT^A02 等）。

使用 TCP(MLLP) 的 sendMessage 操作的输出参数

参数名称	数据类型	说明
messageId	字符串	已发消息的 ID。
状态	字符串	已发送消息的状态。

使用 REST(Google Cloud HealthCare API) 的 sendMessage 操作的输出参数

参数名称	数据类型	说明
ack	字符串	Google Cloud HealthCare API 发送的已确认消息。
状态	字符串	已发送消息的状态。

transformhl7tojson 操作

下表介绍了 transformhl7tojson 操作的输入和输出参数。

transformhl7tojson 操作的输入参数

参数名称	需要	数据类型	说明
hl7Message	是	字符串	要转换为 JSON 的 HL7 消息。

transformhl7tojson 操作的输出参数

参数名称	数据类型	说明
hl7Json	字符串	从 HL7 消息转换而来的 JSON。

transformJsonToHl7 操作

下表介绍了 transformJsonToHl7 操作的输入和输出参数。

transformJsonToHl7 操作的输入参数

参数名称	需要	数据类型	说明
hl7Json	是	字符串	要转换为 HL7 消息的 JSON。

transformJsonToHl7 操作的输出参数

参数名称	数据类型	说明
hl7Message	字符串	从 JSON 转换的 HL7 消息。

transformAndSendHl7BatchMessage 操作

下表介绍了 transformAndSendHl7BatchMessage 操作的输入和输出参数。

“转换并将 HL7 批量消息发送到医疗保健系统”操作的输入参数

参数名称	需要	数据类型	说明
hl7BatchMessage	是	字符串	要转换和发送的 HL7 批量消息。
hl7BatchMessageDelimiter	否	字符串	HL7 批量消息细分分隔符。默认值为 \r。
hl7BatchMessageContentType	是	字符串	HL7 批量消息内容类型（文本/字节）。

“转换并将 HL7 批量消息发送到医疗保健系统”操作的输出参数

参数名称	数据类型	说明
sendHl7BatchMessageResponse	字符串	向医疗保健系统发送 HL7 批量消息的响应。

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新的连接。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

如需查看用于创建连接的 Terraform 模板示例，请参阅模板示例。

使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：

参数名称	数据类型	必需	说明
项目 ID	STRING	True	创建 HL7 数据存储区所在项目的 ID，仅当通过 REST(Google Cloud Healthare API) 建立连接时才需要。
位置	STRING	True	数据集和 HL7v2 存储区的所在位置，仅当通过 REST(Google Cloud Healthare API) 建立连接时才需要。
数据集 ID	STRING	True	包含 HL7v2 存储区的相应数据集的 ID，仅当通过 REST(Google Cloud Healthare API) 建立连接时才需要。
HL7 存储区 ID	STRING	True	存储 HL7v2 消息的 HL7v2 存储区 ID，仅当通过 REST（Google Cloud Healthare API）建立连接时才需要。

在集成中使用 HL7 连接

创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 社区的 Cloud 论坛中发布您的问题以及讨论此连接器。

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。