Struktur API

Halaman ini menjelaskan struktur jalur dan operasi Cloud Healthcare API serta cara penggunaannya untuk mengakses dan mengelola data.

Ringkasan

Data layanan kesehatan dalam set data dan penyimpanan data dapat diakses dan dikelola menggunakan REST API yang mengidentifikasi setiap penyimpanan data menggunakan:

  • Project Google Cloud
  • Lokasi Google Cloud
  • ID set data
  • Jenis penyimpanan data
  • ID penyimpanan data

API juga menerapkan standar khusus modalitas untuk akses yang konsisten dengan standar industri untuk modalitas tersebut.

Operasi administratif

Operasi administratif tersedia untuk set data dan semua penyimpanan data. Fungsi utamanya terutama terdiri dari membuat, membaca, memperbarui, dan menghapus set data (CRUD) serta penyimpanan data. Operasi administratif konsisten dengan sebagian besar API Google Cloud (Google Cloud) dan tidak memerlukan kepatuhan terhadap standar modalitas tertentu.

Contoh operasi administratif meliputi:

  • Membuat, menghapus, mendapatkan, mencantumkan, dan mem-patch set data dan penyimpanan data
  • Menetapkan, mendapatkan, dan menguji izin IAM

Nama resource

Nama resource terdiri dari, minimal, project ID dan lokasi. Library ini dapat diperluas hingga mencakup set data, penyimpanan data, dan resource turunan dari penyimpanan data.

Format nama resource untuk penyimpanan data yang berada dalam set data Cloud Healthcare API akan terlihat seperti ini:

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

Misalnya, nama resource untuk penyimpanan HL7v2 bernama clinical-store1 akan terlihat seperti ini:

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

Nama resource ini menampilkan project bernama my-project di region us-central1. Project ini berisi set data yang disebut my-dataset, dan set data berisi penyimpanan HL7v2 yang disebut clinical-store1.

Operasi pada lokasi, set data, penyimpanan data, atau salah satu resource turunan penyimpanan data, semuanya mengharuskan nama resource diberikan di jalur REST atau permintaan gRPC.

Jalur modalitas untuk operasi khusus modalitas

Operasi yang mengakses data dalam penyimpanan data khusus modalitas menggunakan jalur permintaan yang terdiri dari dua bagian: nama resource (untuk mengidentifikasi penyimpanan data yang akan diakses), dan jalur modalitas (untuk mengidentifikasi data aktual yang akan diambil).

Jalur modalitas resource FHIR

Misalnya, jalur permintaan lengkap untuk membaca resource Pasien FHIR tertentu menggunakan ID pasien mungkin terlihat seperti berikut:

RESOURCE_NAME/resources/Patient/PATIENT_ID

dengan /Patient/PATIENT_ID menjadi jalur modalitas (distrukturkan sesuai dengan standar FHIR) untuk resource Pasien yang ID-nya ditentukan oleh PATIENT_ID.

Jalur modalitas DICOMweb

Permintaan DICOMweb untuk mengambil semua studi untuk pasien tertentu akan terlihat seperti ini:

RESOURCE_NAME/dicomWeb/studies?PatientName=PATIENT_NAME

Sebagai contoh lain, permintaan untuk mengambil semua instance dalam studi dan rangkaian tertentu akan terlihat seperti ini:

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

Permintaan untuk mengambil instance akan terlihat seperti ini:

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

Dalam semua contoh ini, spesifikasi jalur modalitas konsisten dengan struktur jalur standar DICOMweb.