API 結構

本頁說明 Cloud Healthcare API 路徑和作業的結構,以及如何用於存取及管理資料。

總覽

您可以使用 REST API 存取及管理資料集和資料儲存庫中的醫療照護資料,該 API 會使用以下方式識別每個資料儲存庫:

  • Google Cloud 專案
  • Google Cloud 位置
  • 資料集 ID
  • 資料儲存庫類型
  • 資料儲存庫 ID

這個 API 也實作了與該模式相關的存取標準,這些標準與該模式的業界標準一致。

管理作業

管理作業可用於資料集和所有資料儲存庫。主要包括建立、讀取、更新及刪除 (CRUD) 資料集和資料儲存庫。管理作業與大多數Google Cloud (Google Cloud) API 一致,且不需要遵循任何特定模式標準。

行政作業的例子包括:

  • 建立、刪除、取得、列出及修補資料集和資料儲存庫
  • 設定、取得及測試身分與存取權管理權限

資源名稱

資源名稱至少包含專案 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 是病患資源的模式路徑 (依 FHIR 標準結構化),其 ID 由 PATIENT_ID 指定。

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 標準路徑結構一致。