com.google.api.services.healthcare.v1beta1

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir

java.lang.Object

com.google.api.services.healthcare.v1beta1.CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets.FhirStores

public class CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir
extends Object

The "fhir" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryCreate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryRead
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryUpdate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryVread
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Capabilities
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapSearchTranslate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapTranslate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalPatch
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalUpdate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConsentEnforcementStatus
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Create
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Delete
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.EncounterEverything
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ExecuteBundle
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.History
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ObservationLastn
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Patch
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientConsentEnforcementStatus
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Read
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceIncomingReferences
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourcePurge
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceValidate
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.SearchType
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Update
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread

Constructor Summary

Constructors

Constructor and Description
Fhir()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryCreate	binaryCreate(String parent, HttpBody content) Creates a FHIR Binary resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryRead	binaryRead(String name) Gets the contents of a FHIR Binary resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryUpdate	binaryUpdate(String name, HttpBody content) Updates the entire contents of a Binary resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryVread	binaryVread(String name) Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Capabilities	capabilities(String name) Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapSearchTranslate	conceptMapSearchTranslate(String parent) Translates a code from one value set to another by searching for appropriate concept maps.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapTranslate	conceptMapTranslate(String name) Translates a code from one value set to another using a concept map.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete	conditionalDelete(String parent, String type) Deletes FHIR resources that match a search query.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalPatch	conditionalPatch(String parent, String type, HttpBody content) If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalUpdate	conditionalUpdate(String parent, String type, HttpBody content) If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConsentEnforcementStatus	consentEnforcementStatus(String name) Returns the consent enforcement status of a single consent resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Create	create(String parent, String type, HttpBody content) Creates a FHIR resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Delete	delete(String name) Deletes a FHIR resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.EncounterEverything	encounterEverything(String name) Retrieves an Encounter resource and resources related to that Encounter.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ExecuteBundle	executeBundle(String parent, HttpBody content) Executes all the requests in the given Bundle.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.History	history(String name) Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ObservationLastn	observationLastn(String parent) Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Patch	patch(String name, HttpBody content) Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientConsentEnforcementStatus	patientConsentEnforcementStatus(String name) Returns the consent enforcement status of all consent resources for a patient.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything	patientEverything(String name) Retrieves a Patient resource and resources related to that patient.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Read	read(String name) Gets the contents of a FHIR resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceIncomingReferences	resourceIncomingReferences(String parent) Lists all the resources that directly refer to the given target FHIR resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourcePurge	resourcePurge(String name) Deletes all the historical versions of a resource (excluding the current version) from the FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceValidate	resourceValidate(String parent, String type, HttpBody content) Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search	search(String parent, SearchResourcesRequest content) Searches for resources in the given FHIR store according to criteria specified as query parameters.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.SearchType	searchType(String parent, String resourceType, SearchResourcesRequest content) Searches for resources in the given FHIR store according to criteria specified as query parameters.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Update	update(String name, HttpBody content) Updates the entire contents of a resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread	vread(String name) Gets the contents of a version (current or historical) of a FHIR resource by version ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Fhir

public Fhir()

Method Detail

binaryCreate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryCreate binaryCreate(String parent,
                                                                                             HttpBody content)
                                                                                      throws IOException

Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare- api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare- api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir- pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. Create a request for the method "fhir.Binary-create". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

content - the HttpBody

Returns:

the request

Throws:

IOException

binaryRead

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryRead binaryRead(String name)
                                                                                  throws IOException

Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. Create a request for the method "fhir.Binary-read". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the Binary resource to retrieve.

Returns:

the request

Throws:

IOException

binaryUpdate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryUpdate binaryUpdate(String name,
                                                                                             HttpBody content)
                                                                                      throws IOException

Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export- bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir- pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. Create a request for the method "fhir.Binary-update". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to update.

content - the HttpBody

Returns:

the request

Throws:

IOException

binaryVread

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.BinaryVread binaryVread(String name)
                                                                                    throws IOException

Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. Create a request for the method "fhir.Binary-vread". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the Binary resource version to retrieve.

Returns:

the request

Throws:

IOException

conceptMapSearchTranslate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapSearchTranslate conceptMapSearchTranslate(String parent)
                                                                                                                throws IOException

Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. 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. Create a request for the method "fhir.ConceptMap-search-translate". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name for the FHIR store containing the concept map(s) to use for the translation.

Returns:

the request

Throws:

IOException

conceptMapTranslate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConceptMapTranslate conceptMapTranslate(String name)
                                                                                                    throws IOException

Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap- translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. 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. Create a request for the method "fhir.ConceptMap-translate". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The URL for the concept map to use for the translation.

Returns:

the request

Throws:

IOException

consentEnforcementStatus

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConsentEnforcementStatus consentEnforcementStatus(String name)
                                                                                                              throws IOException

Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2. Create a request for the method "fhir.Consent-enforcement-status". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the consent resource to find enforcement status, in the format `projects/{proj ect_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Cons ent/{consent_id}`

Returns:

the request

Throws:

IOException

encounterEverything

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.EncounterEverything encounterEverything(String name)
                                                                                                    throws IOException

Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. 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 resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension. Create a request for the method "fhir.Encounter-everything". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the Encounter resource for which the information is required.

Returns:

the request

Throws:

IOException

observationLastn

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ObservationLastn observationLastn(String parent)
                                                                                              throws IOException

Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. 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. Create a request for the method "fhir.Observation-lastn". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the FHIR store to retrieve resources from.

Returns:

the request

Throws:

IOException

patientConsentEnforcementStatus

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientConsentEnforcementStatus patientConsentEnforcementStatus(String name)
                                                                                                                            throws IOException

Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2. Create a request for the method "fhir.Patient-consent-enforcement-status". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the patient to find enforcement statuses, in the format `projects/{project_id} /locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Patient/{pa tient_id}`

Returns:

the request

Throws:

IOException

patientEverything

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.PatientEverything patientEverything(String name)
                                                                                                throws IOException

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient- operations.html#everything), [STU3](https://hl7.org/implement/standards/fhir/STU3/patient- operations.html#everything), [R4](https://hl7.org/implement/standards/fhir/R4/patient- operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. 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 resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](https://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient- everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#getting_all_patient_compartment_resources). Create a request for the method "fhir.Patient-everything". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the `Patient` resource for which the information is required.

Returns:

the request

Throws:

IOException

resourceIncomingReferences

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceIncomingReferences resourceIncomingReferences(String parent)
                                                                                                                  throws IOException

Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On success, the response body contains a Bundle with type `searchset`, where each entry in the Bundle contains the full content of the resource. If the operation fails, an `OperationOutcome` is returned describing the failure. If the request cannot be mapped to a valid API method on a FHIR store, a generic Google Cloud error might be returned instead. Create a request for the method "fhir.Resource-incoming-references". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store that holds the target resource.

Returns:

the request

Throws:

IOException

resourcePurge

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourcePurge resourcePurge(String name)
                                                                                        throws IOException

Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource- purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#deleting_historical_versions_of_a_fhir_resource). Create a request for the method "fhir.Resource-purge". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to purge.

Returns:

the request

Throws:

IOException

resourceValidate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ResourceValidate resourceValidate(String parent,
                                                                                                     String type,
                                                                                                     HttpBody content)
                                                                                              throws IOException

Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), [STU3](http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or [R4](http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content- Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation 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. Create a request for the method "fhir.Resource-validate". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store that holds the profiles being used for validation.

type - Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), or [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.

content - the HttpBody

Returns:

the request

Throws:

IOException

capabilities

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Capabilities capabilities(String name)
                                                                                      throws IOException

Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. Create a request for the method "fhir.capabilities". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the FHIR store to retrieve the capabilities for.

Returns:

the request

Throws:

IOException

conditionalDelete

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalDelete conditionalDelete(String parent,
                                                                                                       String type)
                                                                                                throws IOException

Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#conditionally_deleting_a_fhir_resource). Create a request for the method "fhir.conditionalDelete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

type - Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).

Returns:

the request

Throws:

IOException

conditionalPatch

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalPatch conditionalPatch(String parent,
                                                                                                     String type,
                                                                                                     HttpBody content)
                                                                                              throws IOException

If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON- encoded representation of the updated resource, including the server-assigned version ID. 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. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#conditionally_patching_a_fhir_resource). Create a request for the method "fhir.conditionalPatch". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

type - Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).

content - the HttpBody

Returns:

the request

Throws:

IOException

conditionalUpdate

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ConditionalUpdate conditionalUpdate(String parent,
                                                                                                       String type,
                                                                                                       HttpBody content)
                                                                                                throws IOException

If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON- encoded representation of the updated resource, including the server-assigned version ID. 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. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#conditionally_updating_a_fhir_resource). Create a request for the method "fhir.conditionalUpdate". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

type - Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.

content - the HttpBody

Returns:

the request

Throws:

IOException

create

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Create create(String parent,
                                                                                 String type,
                                                                                 HttpBody content)
                                                                          throws IOException

Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. 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. For samples that show how to call `create`, see [Creating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#creating_a_fhir_resource). Create a request for the method "fhir.create". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the FHIR store this resource belongs to.

type - Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content.

content - the HttpBody

Returns:

the request

Throws:

IOException

delete

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Delete delete(String name)
                                                                          throws IOException

Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see [Deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#deleting_a_fhir_resource). Create a request for the method "fhir.delete". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to delete.

Returns:

the request

Throws:

IOException

executeBundle

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.ExecuteBundle executeBundle(String parent,
                                                                                               HttpBody content)
                                                                                        throws IOException

Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch`, `transaction` and `history`, processing `batch` and `transaction` bundles according to the batch processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content- Type: application/fhir+json`. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a `transaction` or `history` bundle, the response body contains 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. This method checks permissions for each request in the bundle. The `executeBundle` permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the `healthcare.fhirResources.create` permission. `history` bundles also check the `import` permission. You can use audit logs to view the permissions for `executeBundle` and each request in the bundle. For more information, see [Viewing Cloud Audit logs](https://cloud.google.com/healthcare-api/docs/how-tos/audit-logging). For samples that show how to call `executeBundle`, see [Managing FHIR resources using FHIR bundles](https://cloud.google.com/healthcare/docs/how-tos/fhir-bundles). Create a request for the method "fhir.executeBundle". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the FHIR store in which this bundle will be executed.

content - the HttpBody

Returns:

the request

Throws:

IOException

history

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.History history(String name)
                                                                            throws IOException

Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. 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. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#listing_fhir_resource_versions). Create a request for the method "fhir.history". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to retrieve.

Returns:

the request

Throws:

IOException

patch

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Patch patch(String name,
                                                                               HttpBody content)
                                                                        throws IOException

Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. 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. For samples that show how to call `patch`, see [Patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#patching_a_fhir_resource). Create a request for the method "fhir.patch". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to update.

content - the HttpBody

Returns:

the request

Throws:

IOException

read

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Read read(String name)
                                                                      throws IOException

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If- Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. 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. For samples that show how to call `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#getting_a_fhir_resource). Create a request for the method "fhir.read". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to retrieve.

Returns:

the request

Throws:

IOException

search

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Search search(String parent,
                                                                                 SearchResourcesRequest content)
                                                                          throws IOException

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). 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](https://hl7.org/implement/standards/fhir/STU3/searchparameter- registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). 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` (DSTU2 and STU3) or `:iterate` (R4). 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. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. 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 changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced- search). Create a request for the method "fhir.search". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the FHIR store to retrieve resources from.

content - the SearchResourcesRequest

Returns:

the request

Throws:

IOException

searchType

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.SearchType searchType(String parent,
                                                                                         String resourceType,
                                                                                         SearchResourcesRequest content)
                                                                                  throws IOException

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/search.html), [R4](https://hl7.org/implement/standards/fhir/R4/search.html)). 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](https://hl7.org/implement/standards/fhir/STU3/searchparameter- registry.html), [R4](https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). 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` (DSTU2 and STU3) or `:iterate` (R4). 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. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. 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 changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced- search). Create a request for the method "fhir.search-type". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Name of the FHIR store to retrieve resources from.

resourceType - Required. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).

content - the SearchResourcesRequest

Returns:

the request

Throws:

IOException

update

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Update update(String name,
                                                                                 HttpBody content)
                                                                          throws IOException

Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. 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. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#updating_a_fhir_resource). Create a request for the method "fhir.update". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource to update.

content - the HttpBody

Returns:

the request

Throws:

IOException

vread

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir.Vread vread(String name)
                                                                        throws IOException

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. 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. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir- resources#retrieving_a_fhir_resource_version). Create a request for the method "fhir.vread". This request holds the parameters needed by the healthcare server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the resource version to retrieve.

Returns:

the request

Throws:

IOException