Cloud Healthcare API . projects . locations . datasets . dicomStores . studies

Instance Methods

series()

Returns the series Resource.

delete(parent, dicomWebPath, x__xgafv=None)

DeleteStudy deletes all instances within the given study. Delete requests

retrieveMetadata(parent, dicomWebPath, x__xgafv=None)

RetrieveStudyMetadata returns instance associated with the given study

retrieveStudy(parent, dicomWebPath, x__xgafv=None)

RetrieveStudy returns all instances within the given study. See

searchForInstances(parent, dicomWebPath, x__xgafv=None)

SearchForInstances returns a list of matching instances. See

searchForSeries(parent, dicomWebPath, x__xgafv=None)

SearchForSeries returns a list of matching series. See

storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)

StoreInstances stores DICOM instances associated with study instance unique

Method Details

delete(parent, dicomWebPath, x__xgafv=None)
DeleteStudy deletes all instances within the given study. Delete requests
are equivalent to the GET requests specified in the Retrieve transaction.
The method returns an Operation which
will be marked successful when the deletion is complete.

Args:
  parent: string, A parameter (required)
  dicomWebPath: string, The path of the DeleteStudy request. For example, `studies/{study_uid}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "done": True or False, # If the value is `false`, it means the operation is still in progress.
        # If `true`, the operation is completed, and either `error` or `response` is
        # available.
    "response": { # The normal response of the operation in case of success.  If the original
        # method returns no data on success, such as `Delete`, the response is
        # `google.protobuf.Empty`.  If the original method is standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    },
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  }
retrieveMetadata(parent, dicomWebPath, x__xgafv=None)
RetrieveStudyMetadata returns instance associated with the given study
presented as metadata with the bulk data removed. See
[RetrieveTransaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).

Args:
  parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
  dicomWebPath: string, The path of the RetrieveStudyMetadata DICOMweb request. For example,
`studies/{study_uid}/metadata`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns
        #       (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "extensions": [ # Application specific response metadata. Must be set in the first response
          # for streaming APIs.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "data": "A String", # The HTTP request/response body as raw binary.
      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    }
retrieveStudy(parent, dicomWebPath, x__xgafv=None)
RetrieveStudy returns all instances within the given study. See
[RetrieveTransaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4).

Args:
  parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
  dicomWebPath: string, The path of the RetrieveStudy DICOMweb request. For example,
`studies/{study_uid}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns
        #       (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "extensions": [ # Application specific response metadata. Must be set in the first response
          # for streaming APIs.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "data": "A String", # The HTTP request/response body as raw binary.
      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    }
searchForInstances(parent, dicomWebPath, x__xgafv=None)
SearchForInstances returns a list of matching instances. See
[Search Transaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6).

Args:
  parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
  dicomWebPath: string, The path of the SearchForInstancesRequest DICOMweb request. For example,
`instances`, `series/{series_uid}/instances`, or
`studies/{study_uid}/instances`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns
        #       (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "extensions": [ # Application specific response metadata. Must be set in the first response
          # for streaming APIs.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "data": "A String", # The HTTP request/response body as raw binary.
      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    }
searchForSeries(parent, dicomWebPath, x__xgafv=None)
SearchForSeries returns a list of matching series. See
[Search Transaction]
(http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6).

Args:
  parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
  dicomWebPath: string, The path of the SearchForSeries DICOMweb request. For example, `series` or
`studies/{study_uid}/series`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns
        #       (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "extensions": [ # Application specific response metadata. Must be set in the first response
          # for streaming APIs.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "data": "A String", # The HTTP request/response body as raw binary.
      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    }
storeInstances(parent, dicomWebPath, body=None, x__xgafv=None)
StoreInstances 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).

Args:
  parent: string, The name of the DICOM store that is being accessed. For example,
`projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required)
  dicomWebPath: string, The path of the StoreInstances DICOMweb request. For example,
`studies/[{study_uid}]`. Note that the `study_uid` is optional. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message that represents an arbitrary HTTP body. It should only be used for
      # payload formats that can't be represented as JSON, such as raw binary or
      # an HTML page.
      # 
      # 
      # This message can be used both in streaming and non-streaming API methods in
      # the request as well as the response.
      # 
      # It can be used as a top-level request field, which is convenient if one
      # wants to extract parameters from either the URL or HTTP template into the
      # request fields and also want access to the raw HTTP body.
      # 
      # Example:
      # 
      #     message GetResourceRequest {
      #       // A unique request id.
      #       string request_id = 1;
      # 
      #       // The raw HTTP body is bound to this field.
      #       google.api.HttpBody http_body = 2;
      #     }
      # 
      #     service ResourceService {
      #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
      #       rpc UpdateResource(google.api.HttpBody) returns
      #       (google.protobuf.Empty);
      #     }
      # 
      # Example with streaming methods:
      # 
      #     service CaldavService {
      #       rpc GetCalendar(stream google.api.HttpBody)
      #         returns (stream google.api.HttpBody);
      #       rpc UpdateCalendar(stream google.api.HttpBody)
      #         returns (stream google.api.HttpBody);
      #     }
      # 
      # Use of this type only changes how the request and response bodies are
      # handled, all other features will continue to work unchanged.
    "extensions": [ # Application specific response metadata. Must be set in the first response
        # for streaming APIs.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "data": "A String", # The HTTP request/response body as raw binary.
    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for
        # payload formats that can't be represented as JSON, such as raw binary or
        # an HTML page.
        #
        #
        # This message can be used both in streaming and non-streaming API methods in
        # the request as well as the response.
        #
        # It can be used as a top-level request field, which is convenient if one
        # wants to extract parameters from either the URL or HTTP template into the
        # request fields and also want access to the raw HTTP body.
        #
        # Example:
        #
        #     message GetResourceRequest {
        #       // A unique request id.
        #       string request_id = 1;
        #
        #       // The raw HTTP body is bound to this field.
        #       google.api.HttpBody http_body = 2;
        #     }
        #
        #     service ResourceService {
        #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
        #       rpc UpdateResource(google.api.HttpBody) returns
        #       (google.protobuf.Empty);
        #     }
        #
        # Example with streaming methods:
        #
        #     service CaldavService {
        #       rpc GetCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #       rpc UpdateCalendar(stream google.api.HttpBody)
        #         returns (stream google.api.HttpBody);
        #     }
        #
        # Use of this type only changes how the request and response bodies are
        # handled, all other features will continue to work unchanged.
      "extensions": [ # Application specific response metadata. Must be set in the first response
          # for streaming APIs.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "data": "A String", # The HTTP request/response body as raw binary.
      "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
    }