Method: fhirStores.configureSearch

Full name: projects.locations.datasets.fhirStores.configureSearch

Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration.

The target SearchParameter resources need to exist in the store before calling fhirStores.configureSearch, otherwise an error will occur.

This method returns an Operation that can be used to track the progress of the reindexing by calling operations.get.

HTTP request

POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:configureSearch

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the FHIR store to configure, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}.

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

  • healthcare.fhirStores.configureSearch

Request body

The request body contains data with the following structure:

JSON representation
{
  "canonicalUrls": [
    string
  ],
  "validateOnly": boolean
}
Fields
canonicalUrls[]

string

The canonical URLs of the search parameters that are intended to be used for the FHIR store. See https://www.hl7.org/fhir/references.html#canonical for explanation on FHIR canonical urls

validateOnly

boolean

If validateOnly is set to true, the method will compile all the search parameters without actually setting the search config for the store and triggering the reindex.

Response body

If successful, the response body contains an instance of Operation.

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.