Cloud Healthcare API (healthcare:v1beta1)

2025-09-03

5 new methods

Additions

    Methods
  • healthcare.projects.locations.datasets.dicomStores.updateInstances

      Path : v1beta1/{+parent}/dicomWeb/{+dicomWebPath}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies

      HTTP Method : PUT

      Parameters :

        parent

          Description : Required. 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}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$

          Location : path

          Required : Yes

          Type : string

        dicomWebPath

          Description : Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.

          Pattern : ^studies$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • parent
    • dicomWebPath
    • Scopes :

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform
    • Description : UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).

  • healthcare.projects.locations.datasets.dicomStores.studies.updateInstances

      Path : v1beta1/{+parent}/dicomWeb/{+dicomWebPath}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}

      HTTP Method : PUT

      Parameters :

        parent

          Description : Required. 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}`.

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$

          Location : path

          Required : Yes

          Type : string

        dicomWebPath

          Description : Required. The path of the UpdateInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.

          Pattern : ^studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • parent
    • dicomWebPath
    • Scopes :

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform
    • Description : UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID).

  • healthcare.projects.locations.datasets.dicomStores.studies.updateMetadata

      Path : v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata

      HTTP Method : PATCH

      Parameters :

        parent

          Description : Required. 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}`).

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$

          Location : path

          Required : Yes

          Type : string

        dicomWebPath

          Description : Required. The path of the UpdateStudyMetadata request (for example, `studies/{study_uid}`).

          Pattern : ^studies/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • parent
    • dicomWebPath
    • Scopes :

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform
    • Description : UpdateStudyMetadata modifies the metadata of all instances in the given study. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the study.

  • healthcare.projects.locations.datasets.dicomStores.studies.series.updateMetadata

      Path : v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata

      HTTP Method : PATCH

      Parameters :

        parent

          Description : Required. 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}`).

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$

          Location : path

          Required : Yes

          Type : string

        dicomWebPath

          Description : Required. The path of the UpdateSeriesMetadata request (for example, `studies/{study_uid}/series/{series_uid}`).

          Pattern : ^studies/[^/]+/series/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • parent
    • dicomWebPath
    • Scopes :

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform
    • Description : UpdateSeriesMetadata modifies the metadata of all instances in the given series. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of all instances within the series.

  • healthcare.projects.locations.datasets.dicomStores.studies.series.instances.updateMetadata

      Path : v1beta1/{+parent}/dicomWeb/{+dicomWebPath}/metadata

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata

      HTTP Method : PATCH

      Parameters :

        parent

          Description : Required. 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}`).

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$

          Location : path

          Required : Yes

          Type : string

        dicomWebPath

          Description : Required. The path of the UpdateInstanceMetadata request (for example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`).

          Pattern : ^studies/[^/]+/series/[^/]+/instances/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • parent
    • dicomWebPath
    • Scopes :

    • https://www.googleapis.com/auth/cloud-healthcare
    • https://www.googleapis.com/auth/cloud-platform
    • Description : UpdateInstanceMetadata modifies the metadata of a single instance. The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.