Method: dicomStores.export

Full name: projects.locations.datasets.dicomStores.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.

HTTP request

POST https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:export

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The DICOM store resource name from which to export the data. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.dicomStores.export

Request body

The request body contains data with the following structure:

JSON representation 
{
  "filterConfig": {
    object(DicomFilterConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsDestination": {
    object(GcsDestination)
  },
  "bigqueryDestination": {
    object(BigQueryDestination)
  }
  // End of mutually exclusive fields.
}
Fields
filterConfig

object(DicomFilterConfig)

Specifies the filter configuration.

Specifies the destination of the output.

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: 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. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
gcsDestination

object(GcsDestination)

The Cloud Storage output destination.

The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM roles on the Cloud Storage location.
bigqueryDestination

object(BigQueryDestination)

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: roles/bigquery.dataEditor and roles/bigquery.jobUser.
End of mutually exclusive fields.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GcsDestination

The Cloud Storage location where the server writes the output and the export configuration.

JSON representation 
{
  "uriPrefix": string,
  "mimeType": string
}
Fields
uriPrefix

string

The Cloud Storage destination to export to.

URI for a Cloud Storage directory where the server writes the result files, in the format gs://{bucket-id}/{path/to/destination/dir}). If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uriPrefix.
mimeType

string

MIME types supported by DICOM spec. Each file is written in the following format: .../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension} The frame_number component exists only for multi-frame instances.

Supported MIME types are consistent with supported formats in DICOMweb: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction. Specifically, the following are supported:

  • application/dicom; transfer-syntax=1.2.840.10008.1.2 (DICOM Implicit VR Little Endian)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.1 (DICOM Explicit VR Little Endian)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.1.99 (DICOM Deflated Explicit VR Little Endian)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with embedded JPEG Baseline)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.51 (DICOM with embedded JPEG Extended)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.57 (DICOM with embedded JPEG Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.70 (DICOM with embedded JPEG Lossless First-Order Prediction)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.80 (DICOM with embedded JPEG-LS Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.81 (DICOM with embedded JPEG-LS Lossy (Near-Lossless))
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000 Lossless Only)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.91 (DICOM with embedded JPEG 2000)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.110 (DICOM with embedded JPEG XL Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.111 (DICOM with embedded JPEG XL JPEG Recompression)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.112 (DICOM with embedded JPEG XL)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.201 (DICOM with embedded High-Throughput JPEG 2000 Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.202 (DICOM with embedded High-Throughput JPEG 2000 with RPCL Options Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.4.203 (DICOM with embedded High-Throughput JPEG 2000)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.5 (DICOM with embedded RLE Lossless)
  • application/dicom; transfer-syntax=1.2.840.10008.1.2.8.1 (DICOM with embedded Deflated Image Frame Compression)
  • application/dicom; transfer-syntax=* (DICOM with no transcoding)
  • application/octet-stream; transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData)
  • application/octet-stream; transfer-syntax=* (raw PixelData in whatever format it was uploaded in)
  • image/jpeg; transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG)
  • image/png

The following extensions are used for output files:

  • application/dicom -> .dcm
  • image/jpeg -> .jpg
  • image/png -> .png
  • application/octet-stream -> no extension

If unspecified, the instances are exported in the original DICOM format they were uploaded in.