Index
DicomService
(interface)BigQueryDestination
(message)CreateDicomStoreRequest
(message)DeleteDicomStoreRequest
(message)DicomStore
(message)ExportDicomDataRequest
(message)ExportDicomDataResponse
(message)GcsDestination
(message)GcsSource
(message)GetDicomStoreRequest
(message)ImportDicomDataRequest
(message)ImportDicomDataResponse
(message)ListDicomStoresRequest
(message)ListDicomStoresResponse
(message)UpdateDicomStoreRequest
(message)
DicomService
A service for handling collections of medical images in DICOM format.
CreateDicomStore | |
---|---|
Creates a new DICOM store within the parent dataset.
|
DeleteDicomStore | |
---|---|
Deletes the specified DICOM store and removes all images that are contained within it.
|
ExportDicomData | |
---|---|
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 logs. The
|
GetDicomStore | |
---|---|
Gets the specified DICOM store.
|
ImportDicomData | |
---|---|
Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing logs. The
|
ListDicomStores | |
---|---|
Lists the DICOM stores in the given dataset.
|
UpdateDicomStore | |
---|---|
Updates the specified DICOM store.
|
BigQueryDestination
The BigQuery table where the server writes the output.
Fields | |
---|---|
table_uri |
BigQuery URI to a table, up to 2000 characters long, in the format |
force |
If the destination table already exists and this flag is |
CreateDicomStoreRequest
Creates a new DICOM store.
Fields | |
---|---|
parent |
The name of the dataset this DICOM store belongs to. Authorization requires the following IAM permission on the specified resource
|
dicom_store_id |
The ID of the DICOM store that is being created. Any string value up to 256 characters in length. |
dicom_store |
The DICOM store to create. |
DeleteDicomStoreRequest
Deletes the specified DICOM store and removes all images that are contained within it.
Fields | |
---|---|
name |
The resource name of the DICOM store to delete. Authorization requires the following IAM permission on the specified resource
|
DicomStore
Represents a DICOM store.
Fields | |
---|---|
name |
Resource name of the DICOM store, of the form |
notification_config |
Notification destination for new DICOM instances. Supplied by the client. |
labels |
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. |
ExportDicomDataRequest
Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted.
Fields | ||
---|---|---|
name |
The DICOM store resource name from which to export the data. For example, Authorization requires the following IAM permission on the specified resource
|
|
Union field To enable the Cloud Healthcare API to write to resources in your project, such as Cloud Storage buckets, you must give the Cloud Healthcare API service account the proper permissions. The service account is: |
||
gcs_destination |
The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the |
|
bigquery_destination |
The BigQuery output destination. You can only export to a BigQuery dataset that's in the same project as the DICOM store you're exporting from. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: |
ExportDicomDataResponse
Returns additional information in regards to a completed DICOM store export.
GcsDestination
The Cloud Storage location where the server writes the output and the export configuration.
Fields | |
---|---|
uri_prefix |
The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes the result files, in the format |
mime_type |
MIME types supported by DICOM spec. Each file is written in the following format: Supported MIME types are consistent with supported formats in DICOMweb: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. Specifically, the following are supported:
The following extensions are used for output files:
If unspecified, the instances are exported in the original DICOM format they were uploaded in. |
GcsSource
Specifies the configuration for importing data from Cloud Storage.
Fields | |
---|---|
uri |
Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: |
GetDicomStoreRequest
Gets the specified DICOM store.
Fields | |
---|---|
name |
The resource name of the DICOM store to get. Authorization requires the following IAM permission on the specified resource
|
ImportDicomDataRequest
Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.
Fields | |
---|---|
name |
The name of the DICOM store resource into which the data is imported. For example, Authorization requires the following IAM permission on the specified resource
|
gcs_source |
Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the |
ImportDicomDataResponse
Returns additional information in regards to a completed DICOM store import.
ListDicomStoresRequest
Lists the DICOM stores in the given dataset.
Fields | |
---|---|
parent |
Name of the dataset. Authorization requires the following IAM permission on the specified resource
|
page_size |
Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
page_token |
The next_page_token value returned from the previous List request, if any. |
filter |
Restricts stores returned to those matching a filter. The following syntax is available:
Only filtering on labels is supported. For example, |
ListDicomStoresResponse
Lists the DICOM stores in the given dataset.
Fields | |
---|---|
dicom_stores[] |
The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. |
next_page_token |
Token to retrieve the next page of results or empty if there are no more results in the list. |
UpdateDicomStoreRequest
Updates the DICOM store.
Fields | |
---|---|
dicom_store |
The DICOM store resource that updates the resource on the server. Only the fields listed in Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |