com.google.api.services.healthcare.v1

Class CloudHealthcare.Projects.Locations.Datasets.FhirStores

java.lang.Object

com.google.api.services.healthcare.v1.CloudHealthcare.Projects.Locations.Datasets.FhirStores

Enclosing class:

CloudHealthcare.Projects.Locations.Datasets

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

The "fhirStores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.CloudHealthcareImport
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Create
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Deidentify
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Delete
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Export
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir The "fhir" collection of methods.
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Get
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetFHIRStoreMetrics
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.List
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Patch
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.Rollback
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.SetIamPolicy
class	CloudHealthcare.Projects.Locations.Datasets.FhirStores.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
FhirStores()

Method Summary

Modifier and Type	Method and Description
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Create	create(String parent, FhirStore content) Creates a new FHIR store within the parent dataset.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Deidentify	deidentify(String sourceStore, DeidentifyFhirStoreRequest content) De-identifies data from the source store and writes it to the destination store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Delete	delete(String name) Deletes the specified FHIR store and removes all resources within it.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Export	export(String name, ExportResourcesRequest content) Export resources from the FHIR store to the specified destination.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir	fhir() An accessor for creating requests from the Fhir collection.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Get	get(String name) Gets the configuration of the specified FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetFHIRStoreMetrics	getFHIRStoreMetrics(String name) Gets metrics associated with the FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.CloudHealthcareImport	healthcareImport(String name, ImportResourcesRequest content) Imports resources to the FHIR store by loading data from the specified sources.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.List	list(String parent) Lists the FHIR stores in the given dataset.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Patch	patch(String name, FhirStore content) Updates the configuration of the specified FHIR store.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.Rollback	rollback(String name, RollbackFhirResourcesRequest content) Rolls back resources from the FHIR store to the specified time.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
CloudHealthcare.Projects.Locations.Datasets.FhirStores.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

FhirStores

public FhirStores()

Method Detail

create

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

Creates a new FHIR store within the parent dataset. Create a request for the method "fhirStores.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 dataset this FHIR store belongs to.

content - the FhirStore

Returns:

the request

Throws:

IOException

deidentify

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Deidentify deidentify(String sourceStore,
                                                                                    DeidentifyFhirStoreRequest content)
                                                                             throws IOException

De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how- tos/logging)). Create a request for the method "fhirStores.deidentify". 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:

sourceStore - Required. Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_stor e_id}`.

content - the DeidentifyFhirStoreRequest

Returns:

the request

Throws:

IOException

delete

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

Deletes the specified FHIR store and removes all resources within it. Create a request for the method "fhirStores.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 resource name of the FHIR store to delete.

Returns:

the request

Throws:

IOException

export

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Export export(String name,
                                                                            ExportResourcesRequest content)
                                                                     throws IOException

Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. Create a request for the method "fhirStores.export". 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 FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_stor e_id}`.

content - the ExportResourcesRequest

Returns:

the request

Throws:

IOException

get

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Get get(String name)
                                                               throws IOException

Gets the configuration of the specified FHIR store. Create a request for the method "fhirStores.get". 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 resource name of the FHIR store to get.

Returns:

the request

Throws:

IOException

getFHIRStoreMetrics

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetFHIRStoreMetrics getFHIRStoreMetrics(String name)
                                                                                               throws IOException

Gets metrics associated with the FHIR store. Create a request for the method "fhirStores.getFHIRStoreMetrics". 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 resource name of the FHIR store to get metrics for.

Returns:

the request

Throws:

IOException

getIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.GetIamPolicy getIamPolicy(String resource)
                                                                                 throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "fhirStores.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

healthcareImport

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.CloudHealthcareImport healthcareImport(String name,
                                                                                                     ImportResourcesRequest content)
                                                                                              throws IOException

Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. 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 Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. Create a request for the method "fhirStores.import". 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 FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_stor e_id}`.

content - the ImportResourcesRequest

Returns:

the request

Throws:

IOException

list

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.List list(String parent)
                                                                 throws IOException

Lists the FHIR stores in the given dataset. Create a request for the method "fhirStores.list". 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 dataset.

Returns:

the request

Throws:

IOException

patch

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

Updates the configuration of the specified FHIR store. Create a request for the method "fhirStores.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 - Output only. Identifier. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.

content - the FhirStore

Returns:

the request

Throws:

IOException

rollback

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Rollback rollback(String name,
                                                                                RollbackFhirResourcesRequest content)
                                                                         throws IOException

Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. Create a request for the method "fhirStores.rollback". 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 FHIR store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}".

content - the RollbackFhirResourcesRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.SetIamPolicy setIamPolicy(String resource,
                                                                                        SetIamPolicyRequest content)
                                                                                 throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "fhirStores.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.TestIamPermissions testIamPermissions(String resource,
                                                                                                    TestIamPermissionsRequest content)
                                                                                             throws IOException

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Create a request for the method "fhirStores.testIamPermissions". 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:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

fhir

public CloudHealthcare.Projects.Locations.Datasets.FhirStores.Fhir fhir()

An accessor for creating requests from the Fhir collection.

The typical use is:

    CloudHealthcare healthcare = new CloudHealthcare(...);
    CloudHealthcare.Fhir.List request = healthcare.fhir().list(parameters ...)
 

Returns:

the resource collection