GoogleApi.HealthCare.V1beta1.Api.Projects.healthcare_projects_locations_datasets_fhir_stores_fhir_search
healthcare_projects_locations_datasets_fhir_stores_fhir_search
, go back to GoogleApi.HealthCare.V1beta1.Api.Projects module for more information.
healthcare_projects_locations_datasets_fhir_stores_fhir_search(connection, projects_id, locations_id, datasets_id, fhir_stores_id, optional_params \\ [], opts \\ [])
View SourceSpecs
healthcare_projects_locations_datasets_fhir_stores_fhir_search( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.HealthCare.V1beta1.Model.HttpBody.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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 four 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]/_search?[parameters]
as an alternate form having the same semantics as the GET
method across all resources. POST [base]/[type]/_search?[parameters]
as an alternate form having the same semantics as the GET
method for the specified type. The GET
and POST
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. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.
Parameters
-
connection
(type:GoogleApi.HealthCare.V1beta1.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Name of the FHIR store to retrieve resources from. -
locations_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
datasets_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
fhir_stores_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.HealthCare.V1beta1.Model.SearchResourcesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.HealthCare.V1beta1.Model.HttpBody{}}
on success -
{:error, info}
on failure