Method: frames.retrieveRendered

Full name: projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered

frames.retrieveRendered returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See RetrieveTransaction.

For details on the implementation of frames.retrieveRendered, see Rendered resources in the Cloud Healthcare API conformance statement.

For samples that show how to call frames.retrieveRendered, see Retrieve consumer image formats.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*/rendered}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the DICOM store that is being accessed. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}.

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

  • healthcare.dicomStores.dicomWebRead
dicomWebPath

string

Required. The path of the frames.retrieveRendered DICOMweb request. For example, studies/{studyUid}/series/{seriesUid}/instances/{instanceUid}/frames/{frame_list}/rendered.

Query parameters

Parameters
viewport

string

Optional. The viewport setting to use as specified in https://dicom.nema.org/medical/dicom/current/output/chtml/part18/sect_8.3.5.html#sect_8.3.5.1.3

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

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.