מבנה API

בדף הזה מוסבר על המבנה של הנתיבים והפעולות ב-Cloud Healthcare API, ואיך אפשר להשתמש בהם כדי לגשת לנתונים ולנהל אותם.

סקירה כללית

אפשר לגשת לנתונים של שירותי בריאות במערכי נתונים ובמאגרי נתונים ולנהל אותם באמצעות REST API שמזהה כל מאגר נתונים באמצעות:

  • פרויקט Google Cloud
  • מיקום ב- Google Cloud
  • מזהה מערך הנתונים
  • סוג מאגר הנתונים
  • המזהה של מאגר הנתונים

בנוסף, ה-API מטמיע תקנים ספציפיים לאופן הגישה, שתואמים לתקנים המקובלים בתחום לאופן הגישה הזה.

פעולות ניהוליות

פעולות ניהול זמינות עבור מערכי נתונים וכל מאגרי הנתונים. הן כוללות בעיקר יצירה, קריאה, עדכון ומחיקה (CRUD) של מערכי נתונים ומאגרי נתונים. פעולות ניהוליות עקביות עם רוב ממשקי ה-API שלGoogle Cloud (Google Cloud) ולא נדרשת התאמה לסטנדרטים ספציפיים של אופנות.

דוגמאות לפעולות אדמיניסטרטיביות:

  • יצירה, מחיקה, אחזור, הצגה ועדכון של מערכי נתונים ומאגרי נתונים
  • הגדרת הרשאות IAM, קבלת הרשאות IAM ובדיקת הרשאות IAM

שמות המשאבים

שם משאב מורכב לפחות ממזהה פרויקט וממיקום. הוא יכול לכלול מערך נתונים, מאגר נתונים וכל אחד ממשאבי הצאצא של מאגר הנתונים.

הפורמט של שם משאב של מאגר נתונים שנמצא במערך נתונים של Cloud Healthcare API נראה כך:

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

לדוגמה, שם המשאב של חנות HL7v2 שנקראת clinical-store1 נראה כך:

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

שם המשאב הזה מציין פרויקט בשם my-project באזור us-central1. הפרויקט מכיל מערך נתונים בשם my-dataset, ומערך הנתונים מכיל חנות HL7v2 בשם clinical-store1.

כדי לבצע פעולות על מיקום, מערך נתונים, מאגר נתונים או כל משאב צאצא של מאגר נתונים, צריך לספק שם משאב בנתיב REST או בבקשת gRPC.

נתיבי מודאליות לפעולות ספציפיות למודאליות

פעולות שמתבצעות כדי לגשת לנתונים במאגר נתונים ספציפי למודאליות משתמשות בנתיב בקשה שמורכב משני חלקים: שם המשאב (לזיהוי מאגר הנתונים שאליו רוצים לגשת) ונתיב המודאליות (לזיהוי הנתונים בפועל שרוצים לאחזר).

נתיבים של אופני משאבי FHIR

לדוגמה, נתיב הבקשה המלא לקריאת משאב ספציפי של FHIR Patient באמצעות מזהה המטופל יכול להיראות כך:

RESOURCE_NAME/resources/Patient/PATIENT_ID

כאשר /Patient/PATIENT_ID הוא נתיב המודאליות (מובנה לפי תקן FHIR) של משאב המטופל שמזהה שלו מצוין על ידי 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.