gcp_healthcare_dicom_store

ancestors

Type: UNORDERED_LIST_STRING

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Identifier. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.

notification_config

Type: STRUCT
Provider name: notificationConfig
Description: Optional. Notification destination for new DICOM instances. Supplied by the client.

• pubsub_topic
  Type: STRING
  Provider name: pubsubTopic
  Description: The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can’t be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren’t submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
  
• send_for_bulk_import
  Type: BOOLEAN
  Provider name: sendForBulkImport
  Description: Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
  

notification_configs

Type: UNORDERED_LIST_STRUCT
Provider name: notificationConfigs
Description: Optional. Specifies where and whether to send notifications upon changes to a DICOM store.

• pubsub_topic
  Type: STRING
  Provider name: pubsubTopic
  Description: Required. The Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a PubsubMessage with the following fields: * PubsubMessage.Data contains the resource name. * PubsubMessage.MessageId is the ID of this notification. It is guaranteed to be unique within the topic. * PubsubMessage.PublishTime is the time when the message was published. * PubsubMessage.Attributes contains the following attributes: * action: The name of the endpoint that generated the notification. Possible values are StoreInstances, SetBlobSettings, ImportDicomData, etc. * lastUpdatedTime: The latest timestamp when the DICOM instance was updated. * storeName: The resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}. * studyInstanceUID: The study UID of the DICOM instance that was changed. * seriesInstanceUID: The series UID of the DICOM instance that was changed. * sopInstanceUID: The instance UID of the DICOM instance that was changed. * versionId: The version ID of the DICOM instance that was changed. * modality: The modality tag of the DICOM instance that was changed. * previousStorageClass: The storage class where the DICOM instance was previously stored if the storage class was changed. * storageClass: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the pubsub.topics.publish permission (which is typically included in roles/pubsub.publisher role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can’t be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.
  

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

stream_configs

Type: UNORDERED_LIST_STRUCT
Provider name: streamConfigs
Description: Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to stream_configs, DICOM instance insertions are streamed to the new destination. When a config is removed from stream_configs, the server stops streaming to that destination. Each config must contain a unique destination.

• bigquery_destination
  Type: STRUCT
  Provider name: bigqueryDestination
  Description: Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination’s table schema will be automatically updated in case a new instance’s data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
  
  • force
    Type: BOOLEAN
    Provider name: force
    Description: Optional. Use write_disposition instead. If write_disposition is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.
    
  • table_uri
    Type: STRING
    Provider name: tableUri
    Description: Optional. BigQuery URI to a table, up to 2000 characters long, in the format bq://projectId.bqDatasetId.tableId
    
  • write_disposition
    Type: STRING
    Provider name: writeDisposition
    Description: Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the force parameter is ignored.
    Possible values:
    
    • WRITE_DISPOSITION_UNSPECIFIED - Default behavior is the same as WRITE_EMPTY.
      
    • WRITE_EMPTY - Only export data if the destination table is empty.
      
    • WRITE_TRUNCATE - Erase all existing data in the destination table before writing the instances.
      
    • WRITE_APPEND - Append data to the destination table.
      

tags

Type: UNORDERED_LIST_STRING