שימוש בתוויות של משאבים

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

אפשר להשתמש בתוויות עם המשאבים הבאים של Cloud Healthcare API:

  • מאגרי FHIR
  • מאגרי DICOM
  • מאגרי הסכמה
  • מאגרי HL7v2
  • הודעות HL7v2

אפשר להשתמש בתוויות באמצעות ממשקי ה-API ל-REST או ל-RPC. התוויות לא זמינות ב-Google Cloud CLI או במסוף Google Cloud .

דרישות לגבי תוויות

התוויות שמוחלות על משאב צריכות לעמוד בדרישות הבאות:

  • לכל משאב יכולות להיות כמה תוויות, עד 64 לכל היותר.
  • כל תווית חייבת להיות צמד מפתח/ערך.
  • האורך המינימלי של המפתחות הוא תו אחד, והאורך המקסימלי הוא 63 תווים. המפתחות לא יכולים להיות ריקים. הערכים יכולים להיות ריקים, והאורך המקסימלי שלהם הוא 63 תווים.
  • המפתחות והערכים יכולים להכיל רק אותיות קטנות, ספרות, קווים תחתונים ומקפים. כל התווים צריכים להיות בקידוד UTF-8, ואפשר להשתמש בתווים בינלאומיים.
  • המפתח של תווית חייב להיות ייחודי במשאב יחיד, אבל אפשר להשתמש באותו מפתח בכמה משאבים.
  • המפתחות צריכים להתחיל באות קטנה או בתו בינלאומי.

הוספת תווית

בדוגמה הבאה אפשר לראות איך מוסיפים תווית לחנות FHIR קיימת.

לדוגמה, אפשר להשתמש בתווית כדי לציין שמאגר ה-FHIR משמש כסביבת בדיקה. המפתח של התווית יהיה environment והערך יהיה test.

curl

כדי להוסיף תווית למאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • השם של מאגר FHIR
  • נתוני התווית לעדכון
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

הדוגמה הבאה מציגה בקשת PATCH באמצעות curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY' : 'VALUE'
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

אם הבקשה מצליחה, השרת מחזיר את התגובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

PowerShell

כדי להוסיף תווית למאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • השם של מאגר FHIR
  • נתוני התווית לעדכון
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

בדוגמה הבאה מוצגת בקשת PATCH באמצעות Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY': 'VALUE'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

אם הבקשה מצליחה, השרת מחזיר את התשובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

הוספת כמה תוויות

בדוגמה הבאה אפשר לראות איך מוסיפים כמה תוויות למאגר FHIR קיים. כדי להוסיף כמה תוויות, מפרידים ביניהן באמצעות פסיק.

לדוגמה, אפשר להשתמש בתוויות כדי לציין שמאגר ה-FHIR משמש כסביבת בדיקה ושהוא משמש צוות מחקר.

המפתח של התווית הראשונה יהיה environment והערך יהיה test. המפתח של התווית השנייה יהיה team והערך יהיה research.

curl

כדי להוסיף כמה תוויות למאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • שם מאגר ה-FHIR
  • נתוני התווית לעדכון כרשימה של צמדי מפתח/ערך שמופרדים בפסיקים
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

הדוגמה הבאה מציגה בקשת PATCH באמצעות curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY_1' : 'VALUE_1',
        'KEY_2' : 'VALUE_2'
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

אם הבקשה מצליחה, השרת מחזיר את התגובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY_1": "VALUE_1",
    "KEY_2": "VALUE_2"
  }
}

PowerShell

כדי להוסיף תווית למאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • שם מאגר ה-FHIR
  • נתוני התווית לעדכון כרשימה של צמדי מפתח/ערך שמופרדים בפסיקים
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

בדוגמה הבאה מוצגת בקשת PATCH באמצעות Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY_1': 'VALUE_1',
        'KEY_2': 'VALUE_2'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

אם הבקשה מצליחה, השרת מחזיר את התשובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY_1": "VALUE_1",
    "KEY_2": "VALUE_2"
  }
}

הצגה וסינון לפי תוויות

אחרי שמוסיפים תווית למשאב ב-Cloud Healthcare API, אפשר להציג רשימה של משאבים ולסנן אותם לפי התוויות שלהם. לדוגמה, אחרי שמוסיפים תווית למאגר FHIR בדוגמאות הקודמות, אפשר להציג את מאגרי ה-FHIR במערך הנתונים ולסנן לפי התוויות שהוספתם.

להודעות HL7v2 יש אפשרויות סינון נוספות, שאפשר לראות ב-projects.locations.datasets.hl7V2Stores.messages.list.

curl

כדי לראות את מאגרי ה-FHIR במערך נתונים ולסנן אותם לפי תווית, שולחים GET בקשה ומספקים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • שם מאגר ה-FHIR
  • מחרוזת שאילתה שמכילה את המידע לסינון
  • טוקן גישה

בדוגמה הבאה מוצגת בקשת GET באמצעות curl.

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores?filter=labels.KEY=VALUE"

אם הבקשה מצליחה, השרת מחזיר את התשובה בפורמט JSON:

{
  "fhirStores": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "labels": {
        "KEY": "VALUE"
      }
    },
    {
      ...
    }
  ]
}

PowerShell

כדי להציג את מאגרי ה-FHIR במערך נתונים ולסנן אותם לפי תווית, שולחים בקשת GET ומספקים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • שם מאגר ה-FHIR
  • מחרוזת שאילתה שמכילה את המידע לסינון
  • טוקן גישה

בדוגמה הבאה מוצגת בקשת GET באמצעות Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores?filter=labels.KEY=VALUE" | Select-Object -Expand Content

אם הבקשה מצליחה, השרת מחזיר את התגובה בפורמט JSON:

{
  "fhirStores": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "labels": {
        "KEY": "VALUE"
      }
    },
    {
      ...
    }
  ]
}

הסרת תווית

יש שתי דרכים להסיר תווית:

  • כדי להסיר את התווית לגמרי, כלומר להסיר גם את המפתח וגם את הערך, צריך להשתמש בתבנית קריאה-תיקון-כתיבה:

    1. קוראים את התוויות הקיימות באמצעות ה-method ‏get() של המשאב.
    2. כדי להוסיף או להסיר מפתחות רלוונטיים והערכים שלהם, עורכים את התוויות שהוחזרו באמצעות כלי לעריכת טקסט או באופן פרוגרמטי.
    3. כותבים את התוויות המעודכנות באמצעות קריאה ל-method ‏patch() של המשאב.

  • כדי להשאיר את המפתח ולהסיר את הערך, מגדירים את הערך כ-null.

curl

בדוגמה הבאה אפשר לראות איך מסירים תווית על ידי הגדרת הערך של התווית ל-null.

כדי להסיר תווית ממאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • השם של מאגר FHIR
  • נתוני התווית לעדכון
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

הדוגמה הבאה מציגה בקשת PATCH באמצעות curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY' : null
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

אם הבקשה מצליחה, השרת מחזיר את התגובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY":
  }
}

PowerShell

בדוגמה הבאה אפשר לראות איך מסירים תווית על ידי הגדרת הערך של התווית ל-null.

כדי להסיר תווית ממאגר FHIR קיים, שולחים בקשת PATCH ומציינים את הפרטים הבאים:

  • השם של קבוצת הנתונים הראשית
  • השם של מאגר FHIR
  • נתוני התווית לעדכון
  • מסכת עדכון שהוגדרה ל-labels
  • טוקן גישה

בדוגמה הבאה מוצגת בקשת PATCH באמצעות Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY': nullresource_manager_api
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

אם הבקשה מצליחה, השרת מחזיר את התשובה בפורמט JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY":
  }
}

המאמרים הבאים

שימושים נוספים בתוויות באמצעות Cloud Resource Manager API