Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest

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

Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4).

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.

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 (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page.

Supported search modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below, :[type], :not, and :recurse.

Supported search result parameters: _sort, _count, _include, _revinclude, _summary=text, _summary=data, and _elements.

The maximum number of search results returned defaults to 100, which can be overridden by the _count parameter up to a maximum limit of 1000. If there are additional results, the returned Bundle will contain pagination links.

Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases.

Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<HttpBody>
CloudHealthcareBaseServiceRequest<HttpBody>
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class SearchRequest : CloudHealthcareBaseServiceRequest<HttpBody>, IClientServiceRequest<HttpBody>, IClientServiceRequest

Constructors

SearchRequest(IClientService, SearchResourcesRequest, String)

Constructs a new Search request.

Declaration
public SearchRequest(IClientService service, SearchResourcesRequest body, string parent)
Parameters
Type Name Description
IClientService service
SearchResourcesRequest body
System.String parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.HttpBody>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.HttpBody>.MethodName

Parent

Name of the FHIR store to retrieve resources from.

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.HttpBody>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudHealthcare.v1.Data.HttpBody>.GetBody()

InitParameters()

Initializes Search parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.CloudHealthcare.v1.CloudHealthcareBaseServiceRequest<Google.Apis.CloudHealthcare.v1.Data.HttpBody>.InitParameters()

Implements