class ProjectsLocationsDatasetsFhirStores extends Resource (View source)

The "fhirStores" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $fhirStores = $healthcareService->projects_locations_datasets_fhirStores;

Methods

create(string $parent, FhirStore $postBody, array $optParams = [])

Creates a new FHIR store within the parent dataset. (fhirStores.create)

deidentify(string $sourceStore, DeidentifyFhirStoreRequest $postBody, array $optParams = [])

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).

delete(string $name, array $optParams = [])

Deletes the specified FHIR store and removes all resources within it.

export(string $name, ExportResourcesRequest $postBody, array $optParams = [])

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).

get(string $name, array $optParams = [])

Gets the configuration of the specified FHIR store. (fhirStores.get)

getFHIRStoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the FHIR store. (fhirStores.getFHIRStoreMetrics)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (fhirStores.getIamPolicy)

import(string $name, ImportResourcesRequest $postBody, array $optParams = [])

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.

listProjectsLocationsDatasetsFhirStores(string $parent, array $optParams = [])

Lists the FHIR stores in the given dataset.

patch(string $name, FhirStore $postBody, array $optParams = [])

Updates the configuration of the specified FHIR store. (fhirStores.patch)

rollback(string $name, RollbackFhirResourcesRequest $postBody, array $optParams = [])

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).

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (fhirStores.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

FhirStore create(string $parent, FhirStore $postBody, array $optParams = [])

Creates a new FHIR store within the parent dataset. (fhirStores.create)

Parameters

string $parent

Required. The name of the dataset this FHIR store belongs to.

FhirStore $postBody
array $optParams

Optional parameters.

Return Value

FhirStore

Exceptions

Exception

Operation deidentify(string $sourceStore, DeidentifyFhirStoreRequest $postBody, array $optParams = [])

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).

(fhirStores.deidentify)

Parameters

string $sourceStore

Required. Source FHIR store resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}.

DeidentifyFhirStoreRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

HealthcareEmpty delete(string $name, array $optParams = [])

Deletes the specified FHIR store and removes all resources within it.

(fhirStores.delete)

Parameters

string $name

Required. The resource name of the FHIR store to delete.

array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

Operation export(string $name, ExportResourcesRequest $postBody, array $optParams = [])

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).

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. (fhirStores.export)

Parameters

string $name

Required. The name of the FHIR store to export resource from, in the format of projects/{project_id}/locations/{location_id}/dataset s/{dataset_id}/fhirStores/{fhir_store_id}.

ExportResourcesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

FhirStore get(string $name, array $optParams = [])

Gets the configuration of the specified FHIR store. (fhirStores.get)

Parameters

string $name

Required. The resource name of the FHIR store to get.

array $optParams

Optional parameters.

Return Value

FhirStore

Exceptions

Exception

FhirStoreMetrics getFHIRStoreMetrics(string $name, array $optParams = [])

Gets metrics associated with the FHIR store. (fhirStores.getFHIRStoreMetrics)

Parameters

string $name

Required. The resource name of the FHIR store to get metrics for.

array $optParams

Optional parameters.

Return Value

FhirStoreMetrics

Exceptions

Exception

Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (fhirStores.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

Operation import(string $name, ImportResourcesRequest $postBody, array $optParams = [])

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). 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. (fhirStores.import)

Parameters

string $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_store_id}.

ImportResourcesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

ListFhirStoresResponse listProjectsLocationsDatasetsFhirStores(string $parent, array $optParams = [])

Lists the FHIR stores in the given dataset.

(fhirStores.listProjectsLocationsDatasetsFhirStores)

Parameters

string $parent

Required. Name of the dataset.

array $optParams

Optional parameters.

Return Value

ListFhirStoresResponse

Exceptions

Exception

FhirStore patch(string $name, FhirStore $postBody, array $optParams = [])

Updates the configuration of the specified FHIR store. (fhirStores.patch)

Parameters

string $name

Output only. Identifier. Resource name of the FHIR store, of the form projects/{project_id}/locations/{location}/datasets/{dataset_id} /fhirStores/{fhir_store_id}.

FhirStore $postBody
array $optParams

Optional parameters.

Return Value

FhirStore

Exceptions

Exception

Operation rollback(string $name, RollbackFhirResourcesRequest $postBody, array $optParams = [])

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).

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. (fhirStores.rollback)

Parameters

string $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}".

RollbackFhirResourcesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (fhirStores.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (fhirStores.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception