Skip to main content

dicom_stores

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

Overview

Namedicom_stores
TypeResource
Idgoogle.healthcare.dicom_stores

Fields

NameDatatypeDescription
namestringIdentifier. Resource name of the DICOM store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}.
labelsobjectUser-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.
notificationConfigobjectSpecifies where to send notifications upon changes to a data store.
streamConfigsarrayOptional. 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

NameAccessible byRequired ParamsDescription
getSELECTdatasetsId, dicomStoresId, locationsId, projectsIdGets the specified DICOM store.
listSELECTdatasetsId, locationsId, projectsIdLists the DICOM stores in the given dataset.
createINSERTdatasetsId, locationsId, projectsIdCreates a new DICOM store within the parent dataset.
deleteDELETEdatasetsId, dicomStoresId, locationsId, projectsIdDeletes the specified DICOM store and removes all images that are contained within it.
patchUPDATEdatasetsId, dicomStoresId, locationsId, projectsIdUpdates the specified DICOM store.
deidentifyEXECdatasetsId, dicomStoresId, locationsId, projectsIdDe-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).
exportEXECdatasetsId, dicomStoresId, locationsId, projectsIdExports 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.
importEXECdatasetsId, dicomStoresId, locationsId, projectsIdImports 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.
search_for_instancesEXECdatasetsId, dicomStoresId, locationsId, projectsIdSearchForInstances 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.
search_for_seriesEXECdatasetsId, dicomStoresId, locationsId, projectsIdSearchForSeries 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_studiesEXECdatasetsId, dicomStoresId, locationsId, projectsIdSearchForStudies 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.
set_blob_storage_settingsEXECdatasetsId, dicomStoresId, locationsId, projectsIdSetBlobStorageSettings sets the blob storage settings of the specified resources.
store_instancesEXECdatasetsId, dicomStoresId, locationsId, projectsIdStoreInstances 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.

SELECT examples

Lists the DICOM stores in the given dataset.

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

INSERT example

Use the following StackQL query and manifest file to create a new dicom_stores resource.

/*+ create */
INSERT INTO google.healthcare.dicom_stores (
datasetsId,
locationsId,
projectsId,
name,
notificationConfig,
labels,
streamConfigs
)
SELECT
'{{ datasetsId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ notificationConfig }}',
'{{ labels }}',
'{{ streamConfigs }}'
;

UPDATE example

Updates a dicom_stores resource.

/*+ update */
UPDATE google.healthcare.dicom_stores
SET
name = '{{ name }}',
notificationConfig = '{{ notificationConfig }}',
labels = '{{ labels }}',
streamConfigs = '{{ streamConfigs }}'
WHERE
datasetsId = '{{ datasetsId }}'
AND dicomStoresId = '{{ dicomStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified dicom_stores resource.

/*+ delete */
DELETE FROM google.healthcare.dicom_stores
WHERE datasetsId = '{{ datasetsId }}'
AND dicomStoresId = '{{ dicomStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';