Cloud Healthcare API (healthcare:v1beta1)

2026-10-04

1 removed method

Deletions

    Methods

  • ▼ ▲ healthcare.projects.locations.datasets.fhirStores.executeCohort

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

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

          Required : Yes

          Description : Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

      Scopes :

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

      • Description : Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:executeCohort

      HTTP Method : POST

      Path : v1beta1/{+name}:executeCohort

1 new method

Additions

    Methods

  • ▼ ▲ healthcare.projects.locations.datasets.fhirStores.executeCohort

      Parameter Order : name

      Parameters :

        name

          Location : path

          Type : string

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

          Required : Yes

          Description : Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

      Scopes :

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

      • Description : Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:executeCohort

      HTTP Method : POST

      Path : v1beta1/{+name}:executeCohort