REST Resource: projects.locations.datasets.dicomStores

Resource: DicomStore

Represents a DICOM store.

JSON representation
{
  "name": string,
  "notificationConfig": {
    object(NotificationConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "streamConfigs": [
    {
      object(StreamConfig)
    }
  ]
}
Fields
name

string

Resource name of the DICOM store, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}.

notificationConfig

object(NotificationConfig)

Notification destination for new DICOM instances. Supplied by the client.

labels

map (key: string, value: string)

User-supplied key-value pairs used to organize DICOM stores.

Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}

Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}

No more than 64 labels can be associated with a given store.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

streamConfigs[]

object(StreamConfig)

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 streamConfigs, DICOM instance insertions are streamed to the new destination. When a config is removed from streamConfigs, the server stops streaming to that destination. Each config must contain a unique destination.

StreamConfig

StreamConfig specifies configuration for a streaming DICOM export.

JSON representation
{
  "bigqueryDestination": {
    object(BigQueryDestination)
  }
}
Fields
bigqueryDestination

object(BigQueryDestination)

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 logs](/healthcare/docs/how- Viewing logs).

BigQueryDestination

The BigQuery table where the server writes output.

JSON representation
{
  "tableUri": string,
  "force": boolean,
  "writeDisposition": enum(WriteDisposition)
}
Fields
tableUri

string

BigQuery URI to a table, up to 2000 characters long, in the format bq://projectId.bqDatasetId.tableId

force

boolean

Use writeDisposition instead. If writeDisposition is specified, this parameter is ignored. force=false is equivalent to writeDisposition=WRITE_EMPTY and force=true is equivalent to writeDisposition=WRITE_TRUNCATE.

writeDisposition

enum(WriteDisposition)

Determines whether the existing table in the destination is to be overwritten or appended to. If a writeDisposition is specified, the force parameter is ignored.

WriteDisposition

The BigQuery WriteDispostion used by the export operation.

Enums
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 a table before writing the instances.
WRITE_APPEND Append data to the existing table.

Methods

create

Creates a new DICOM store within the parent dataset.

deidentify

De-identifies data from the source store and writes it to the destination store.

delete

Deletes the specified DICOM store and removes all images that are contained within it.

export

Exports data to the specified destination by copying it from the DICOM store.

get

Gets the specified DICOM store.

getIamPolicy

Gets the access control policy for a resource.

import

Imports data into the DICOM store by copying it from the specified source.

list

Lists the DICOM stores in the given dataset.

patch

Updates the specified DICOM store.

searchForInstances

SearchForInstances returns a list of matching instances.

searchForSeries

SearchForSeries returns a list of matching series.

searchForStudies

SearchForStudies returns a list of matching studies.

setIamPolicy

Sets the access control policy on the specified resource.

storeInstances

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).

testIamPermissions

Returns permissions that a caller has on the specified resource.