API 구조

이 페이지에서는 Cloud Healthcare API 경로 및 작업의 구조와 이를 사용하여 데이터에 액세스하고 관리하는 방법을 설명합니다.

개요

데이터 세트 및 데이터 저장소의 의료 데이터는 다음을 사용하여 각 데이터 저장소를 식별하는 REST API를 사용하여 액세스하고 관리할 수 있습니다.

  • Google Cloud 프로젝트
  • Google Cloud 위치
  • 데이터 세트 ID입니다.
  • 데이터 저장소 유형
  • 데이터 저장소 ID

또한 API는 해당 모달리티의 업계 표준과 일치하는 액세스를 위한 모달별 특정 표준을 구현합니다.

관리 작업

관리 작업은 데이터 세트 및 모든 데이터 저장소에 사용할 수 있습니다. 주로 데이터 세트 및 데이터 저장소 생성, 읽기, 업데이트, 삭제(CRUD)로 구성됩니다. 관리 작업은 대부분의 Google Cloud(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 표준 경로 구조와 일치합니다.