[−][src]Struct google_healthcare1_beta1::ProjectLocationDatasetFhirStoreFhirSearchCall
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 theGET
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 contains a JSON-encoded representation
of a Bundle
resource of type searchset
, containing the results of the
search.
Errors generated by the FHIR store 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
contains
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.
A builder for the locations.datasets.fhirStores.fhir.search method supported by a project resource.
It is not used directly, but through a ProjectMethods
instance.
Example
Instantiate a resource method builder
use healthcare1_beta1::SearchResourcesRequest; // As the method needs a request, you would usually fill it with the desired information // into the respective structure. Some of the parts shown here might not be applicable ! // Values shown here are possibly random and not representative ! let mut req = SearchResourcesRequest::default(); // You can configure optional parameters by calling the respective setters at will, and // execute the final call using `doit()`. // Values shown here are possibly random and not representative ! let result = hub.projects().locations_datasets_fhir_stores_fhir_search(req, "parent") .doit();
Implementations
impl<'a, C, A> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, HttpBody)>
[src]
Perform the operation you have build so far.
pub fn request(
self,
new_value: SearchResourcesRequest
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
[src]
self,
new_value: SearchResourcesRequest
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn parent(
self,
new_value: &str
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
[src]
self,
new_value: &str
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
Name of the FHIR store to retrieve resources from.
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
[src]
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
pub fn param<T>(
self,
name: T,
value: T
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A> where
T: AsRef<str>,
[src]
self,
name: T,
value: T
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A> where
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- access_token (query-string) - OAuth access token.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- callback (query-string) - JSONP
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.
pub fn add_scope<T, S>(
self,
scope: T
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
self,
scope: T
) -> ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope
variant
Scope::CloudPlatform
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
Trait Implementations
impl<'a, C, A> CallBuilder for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
[src]
Auto Trait Implementations
impl<'a, C, A> !RefUnwindSafe for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
impl<'a, C, A> !Send for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
impl<'a, C, A> !Sync for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
impl<'a, C, A> Unpin for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
impl<'a, C, A> !UnwindSafe for ProjectLocationDatasetFhirStoreFhirSearchCall<'a, C, A>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Typeable for T where
T: Any,
T: Any,