Full name:

Searches for resources in the given FHIR store according to criteria specified as query parameters.

Implements the FHIR standard search interaction using the search semantics described in the FHIR Search specification.

Supports three methods of search defined by the specification:

  • GET [base]?[parameters] to search across all resources.
  • GET [base]/[type]?[parameters] to search resources of a specified type.
  • POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method.

The GET methods do not support compartment searches. The POST method does not support application/x-www-form-urlencoded search parameters.

On success, the response body will contain a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

Search Parameters

The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry.

Search Modifiers

Modifier Supported
:missing Yes
:exact Yes
:contains Yes
:text Yes
:in Yes
:not-in Yes
:above Yes
:below Yes
:[type] Yes
:not Yes
:recurse No

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Name of the FHIR store to retrieve resources from.

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

  • healthcare.fhirResources.get



The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index.

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:


For more information, see the Authentication Overview.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API