dicom_stores

Creates, updates, deletes, gets or lists a dicom_stores resource.

Overview

Name	dicom_stores
Type	Resource
Id	google.healthcare.dicom_stores

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.
labels	object	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}{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.
notificationConfig	object	Optional. Notification destination for new DICOM instances. Supplied by the client. (id: NotificationConfig)
notificationConfigs	array	Optional. Specifies where and whether to send notifications upon changes to a DICOM store.
streamConfigs	array	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.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.
labels	object	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}{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.
notificationConfig	object	Optional. Notification destination for new DICOM instances. Supplied by the client. (id: NotificationConfig)
notificationConfigs	array	Optional. Specifies where and whether to send notifications upon changes to a DICOM store.
streamConfigs	array	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, datasetsId, dicomStoresId		Gets the specified DICOM store.
list	select	projectsId, locationsId, datasetsId	pageSize, pageToken, filter	Lists the DICOM stores in the given dataset.
create	insert	projectsId, locationsId, datasetsId	dicomStoreId	Creates a new DICOM store within the parent dataset.
patch	update	projectsId, locationsId, datasetsId, dicomStoresId	updateMask	Updates the specified DICOM store.
delete	delete	projectsId, locationsId, datasetsId, dicomStoresId		Deletes the specified DICOM store and removes all images that are contained within it.
deidentify	exec	projectsId, locationsId, datasetsId, dicomStoresId		De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).
set_blob_storage_settings	exec	projectsId, locationsId, datasetsId, dicomStoresId		SetBlobStorageSettings sets the blob storage settings of the specified resources.
import	exec	projectsId, locationsId, datasetsId, dicomStoresId		Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.
export	exec	projectsId, locationsId, datasetsId, dicomStoresId		Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.
search_for_studies	exec	projectsId, locationsId, datasetsId, dicomStoresId		SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.
store_instances	exec	projectsId, locationsId, datasetsId, dicomStoresId		StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.
search_for_series	exec	projectsId, locationsId, datasetsId, dicomStoresId		SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.
search_for_instances	exec	projectsId, locationsId, datasetsId, dicomStoresId		SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.
retrieve_frames	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId, instancesId, framesId		RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.
retrieve_rendered	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId, instancesId, framesId	viewport	RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.
retrieve_bulkdata	exec	projectsId, locationsId, datasetsId, dicomStoresId, studiesId, seriesId, instancesId, bulkdataId, bulkdataId1		Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See Retrieve Transaction. For details on the implementation of RetrieveBulkdata, see Bulkdata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see Retrieve bulkdata.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bulkdataId	string
bulkdataId1	string
datasetsId	string
dicomStoresId	string
framesId	string
instancesId	string
locationsId	string
projectsId	string
seriesId	string
studiesId	string
dicomStoreId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
viewport	string

SELECT examples

get

Gets the specified DICOM store.

SELECT
name,
labels,
notificationConfig,
notificationConfigs,
streamConfigs
FROM google.healthcare.dicom_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND dicomStoresId = '{{ dicomStoresId }}' -- required;

list

Lists the DICOM stores in the given dataset.

SELECT
name,
labels,
notificationConfig,
notificationConfigs,
streamConfigs
FROM google.healthcare.dicom_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new DICOM store within the parent dataset.

INSERT INTO google.healthcare.dicom_stores (
data__name,
data__notificationConfig,
data__labels,
data__streamConfigs,
data__notificationConfigs,
projectsId,
locationsId,
datasetsId,
dicomStoreId
)
SELECT 
'{{ name }}',
'{{ notificationConfig }}',
'{{ labels }}',
'{{ streamConfigs }}',
'{{ notificationConfigs }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ datasetsId }}',
'{{ dicomStoreId }}'
RETURNING
name,
labels,
notificationConfig,
notificationConfigs,
streamConfigs
;

Manifest

# Description fields are for documentation purposes
- name: dicom_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the dicom_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the dicom_stores resource.
    - name: datasetsId
      value: string
      description: Required parameter for the dicom_stores resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.
        
    - name: notificationConfig
      value: object
      description: >
        Optional. Notification destination for new DICOM instances. Supplied by the client.
        
    - name: labels
      value: object
      description: >
        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}{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.
        
    - name: streamConfigs
      value: array
      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.
        
    - name: notificationConfigs
      value: array
      description: >
        Optional. Specifies where and whether to send notifications upon changes to a DICOM store.
        
    - name: dicomStoreId
      value: string

UPDATE examples

patch

Updates the specified DICOM store.

UPDATE google.healthcare.dicom_stores
SET 
data__name = '{{ name }}',
data__notificationConfig = '{{ notificationConfig }}',
data__labels = '{{ labels }}',
data__streamConfigs = '{{ streamConfigs }}',
data__notificationConfigs = '{{ notificationConfigs }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND dicomStoresId = '{{ dicomStoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
labels,
notificationConfig,
notificationConfigs,
streamConfigs;

DELETE examples

delete

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

DELETE FROM google.healthcare.dicom_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND dicomStoresId = '{{ dicomStoresId }}' --required;

Lifecycle Methods

deidentify

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

EXEC google.healthcare.dicom_stores.deidentify 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required 
@@json=
'{
"destinationStore": "{{ destinationStore }}", 
"config": "{{ config }}", 
"gcsConfigUri": "{{ gcsConfigUri }}", 
"filterConfig": "{{ filterConfig }}"
}';

set_blob_storage_settings

SetBlobStorageSettings sets the blob storage settings of the specified resources.

EXEC google.healthcare.dicom_stores.set_blob_storage_settings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required 
@@json=
'{
"filterConfig": "{{ filterConfig }}", 
"blobStorageSettings": "{{ blobStorageSettings }}"
}';

import

Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

EXEC google.healthcare.dicom_stores.import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required 
@@json=
'{
"gcsSource": "{{ gcsSource }}", 
"blobStorageSettings": "{{ blobStorageSettings }}"
}';

export

Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

EXEC google.healthcare.dicom_stores.export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required 
@@json=
'{
"gcsDestination": "{{ gcsDestination }}", 
"bigqueryDestination": "{{ bigqueryDestination }}"
}';

search_for_studies

SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.

EXEC google.healthcare.dicom_stores.search_for_studies 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required;

store_instances

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.

EXEC google.healthcare.dicom_stores.store_instances 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required 
@@json=
'{
"contentType": "{{ contentType }}", 
"data": "{{ data }}", 
"extensions": "{{ extensions }}"
}';

search_for_series

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.

EXEC google.healthcare.dicom_stores.search_for_series 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required;

search_for_instances

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.

EXEC google.healthcare.dicom_stores.search_for_instances 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required;

retrieve_frames

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.

EXEC google.healthcare.dicom_stores.retrieve_frames 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required, 
@seriesId='{{ seriesId }}' --required, 
@instancesId='{{ instancesId }}' --required, 
@framesId='{{ framesId }}' --required;

retrieve_rendered

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.

EXEC google.healthcare.dicom_stores.retrieve_rendered 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required, 
@seriesId='{{ seriesId }}' --required, 
@instancesId='{{ instancesId }}' --required, 
@framesId='{{ framesId }}' --required, 
@viewport='{{ viewport }}';

retrieve_bulkdata

Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See Retrieve Transaction. For details on the implementation of RetrieveBulkdata, see Bulkdata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see Retrieve bulkdata.

EXEC google.healthcare.dicom_stores.retrieve_bulkdata 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@datasetsId='{{ datasetsId }}' --required, 
@dicomStoresId='{{ dicomStoresId }}' --required, 
@studiesId='{{ studiesId }}' --required, 
@seriesId='{{ seriesId }}' --required, 
@instancesId='{{ instancesId }}' --required, 
@bulkdataId='{{ bulkdataId }}' --required, 
@bulkdataId1='{{ bulkdataId1 }}' --required;