API 结构

本页面介绍 Cloud Healthcare API 路径和操作的结构,以及如何使用它们访问和管理数据。

概览

使用 REST API 可以访问和管理数据集和数据存储区中的医疗保健数据,可使用以下项通过 REST API 识别每个数据存储区:

  • Google Cloud 项目
  • Google Cloud 位置
  • 数据集 ID
  • 数据存储区类型
  • 数据存储区 ID

该 API 还实现了模态专属的访问标准,这些标准与该模态的行业标准一致。

管理操作

管理操作适用于数据集和所有数据存储区。主要包括创建、读取、更新和删除(即 CRUD)数据集和数据存储区。管理操作与大多数 Google Cloud API 一致,无需遵循特定的模态标准。

管理操作的示例包括:

  • 创建、删除、获取、列出和修补数据集和数据存储区
  • 设置、获取和测试 IAM 权限

资源名称

资源名称至少包含一个项目 ID 和一个位置。它可以扩展为包含数据集、数据存储区以及任何数据存储区的子资源。

位于 Cloud Healthcare API 数据集内的数据存储区的资源名称格式如下所示:

/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/DATA_STORE_TYPE/DATA_STORE_ID

例如,名为 clinical-store1 的 HL7v2 存储区的资源名称如下所示:

/projects/my-project/locations/us-central1/datasets/my-dataset/hl7V2Stores/clinical-store1

此资源名称会在 us-central1 地区中显示名为 my-project 的项目。该项目包含一个名为 my-dataset 的数据集,而该数据集包含一个名为 clinical-store1 的 HL7v2 存储区。

如需对位置、数据集、数据存储区或任何数据存储区的子资源进行操作,需要在 REST 路径或 gRPC 请求中提供资源名称。

模态专属操作的模态路径

访问模态专属数据存储区中的数据的操作使用的请求路径包含两个部分:资源名称(用于识别要访问的数据存储区)和模态路径(用于识别要检索的实际数据)。

FHIR 资源模态路径

例如,使用患者 ID 读取特定 FHIR 患者资源的完整请求路径可能如下所示:

RESOURCE_NAME/resources/Patient/PATIENT_ID

其中 /Patient/PATIENT_ID 是其标识符由 PATIENT_ID 指定的患者资源的模态路径(根据 FHIR 标准构建)。

DICOMweb 模态路径

检索指定患者的所有研究的 DICOMweb 请求如下所示:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

再举一例,检索指定研究和系列中的所有实例的请求如下所示:

RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances

检索实例的请求如下所示:

RESOURCE_NAME/dicomWeb/studies/STUDY_UID/series/SERIES_UID/instances/INSTANCE_UID

在以上所有示例中,模态路径规范都与 DICOMweb 标准路径结构一致。