Package google.cloud.healthcare.v1beta1.dicomweb

Index

DicomWebService

A service for accessing medical images (in DICOM format) in a DICOM store inside a healthcare dataset.

This service supports access via the following industry-standard REST APIs:

STOW-RS [http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.6.html] Allows DICOM images to be written to the dataset.

WADO-RS [http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.5.html] Allows DICOM images to be retrieved from the dataset.

QIDO-RS [http://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_6.7.html] Allows DICOM images to be queried (e.g., by patient name or image modality).

We also support a DELETE request that uses the same paths as WADO-RS and allows DICOM instances/series/studies to be deleted.

DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Empty)

DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

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.

DeleteSeries

rpc DeleteSeries(DeleteSeriesRequest) returns (Empty)

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

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.

DeleteStudy

rpc DeleteStudy(DeleteStudyRequest) returns (Empty)

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard.

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.

RetrieveFrames

rpc RetrieveFrames(RetrieveFramesRequest) returns (HttpBody)

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.4.

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.

RetrieveInstance

rpc RetrieveInstance(RetrieveInstanceRequest) returns (HttpBody)

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.3.

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.

RetrieveInstanceMetadata

rpc RetrieveInstanceMetadata(RetrieveInstanceMetadataRequest) returns (HttpBody)

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.

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.

RetrieveRenderedFrames

rpc RetrieveRenderedFrames(RetrieveRenderedFramesRequest) returns (HttpBody)

RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.

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.

RetrieveRenderedInstance

rpc RetrieveRenderedInstance(RetrieveRenderedInstanceRequest) returns (HttpBody)

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.8.

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.

RetrieveSeries

rpc RetrieveSeries(RetrieveSeriesRequest) returns (HttpBody)

RetrieveSeries returns all instances within the given study and series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.2.

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.

RetrieveSeriesMetadata

rpc RetrieveSeriesMetadata(RetrieveSeriesMetadataRequest) returns (HttpBody)

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.

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.

RetrieveStudy

rpc RetrieveStudy(RetrieveStudyRequest) returns (HttpBody)

RetrieveStudy returns all instances within the given study. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.1.

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.

RetrieveStudyMetadata

rpc RetrieveStudyMetadata(RetrieveStudyMetadataRequest) returns (HttpBody)

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.5.6.

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.

SearchForInstances

rpc SearchForInstances(SearchForInstancesRequest) returns (HttpBody)

SearchForInstances returns a list of matching instances. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7

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.

SearchForSeries

rpc SearchForSeries(SearchForSeriesRequest) returns (HttpBody)

SearchForSeries returns a list of matching series. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7

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.

SearchForStudies

rpc SearchForStudies(SearchForStudiesRequest) returns (HttpBody)

SearchForStudies returns a list of matching studies. See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.7

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.

StoreInstances

rpc StoreInstances(StoreInstancesRequest) returns (HttpBody)

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_6.6.1.

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.

DeleteInstanceRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebDelete

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instances/{instance_id}).

DeleteSeriesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebDelete

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}).

DeleteStudyRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebDelete

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}).

RetrieveFramesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}).

RetrieveInstanceMetadataRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instances/{instance_id}/metadata).

RetrieveInstanceRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instance/{instance_id}).

RetrieveRenderedFramesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instance/{instance_id}/frames/{frame_list}/rendered).

RetrieveRenderedInstanceRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/instance/{instance_id}/rendered).

RetrieveSeriesMetadataRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}/metadata.

RetrieveSeriesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series/{series_id}).

RetrieveStudyMetadataRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/metadata.

RetrieveStudyRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}).

SearchForInstancesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., instances).

SearchForSeriesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., series).

SearchForStudiesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebRead

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies).

StoreInstancesRequest

Fields
parent

string

The name of the DICOM store that is being accessed (e.g., projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}).

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.dicomStores.dicomWebWrite

dicom_web_path

string

The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}).

request_body

HttpBody

The raw HTTP body for this request.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API