Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

The "fhirStores" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudHealthcare.v1beta1

Assembly: Google.Apis.CloudHealthcare.v1beta1.dll

Syntax

public class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

Constructors

FhirStoresResource(IClientService)

Constructs a new resource.

Declaration

public FhirStoresResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Fhir

Gets the Fhir resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource Fhir { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.OperationsResource

Methods

ApplyAdminConsents(ApplyAdminConsentsRequest, string)

Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the consent_config.enforced_admin_consents field of the FhirStore unless validate_only=true in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the consent_config.enforced_admin_consents field will be unchanged. To enforce a consent check for data access, consent_config.access_enforced must be set to true for the FhirStore.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyAdminConsentsRequest ApplyAdminConsents(ApplyAdminConsentsRequest body, string name)

Parameters

Type	Name	Description
ApplyAdminConsentsRequest	body	The body of the request.
string	name	Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyAdminConsentsRequest

ApplyConsents(ApplyConsentsRequest, string)

Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). To enforce consent check for data access, consent_config.access_enforced must be set to true for the FhirStore.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyConsentsRequest ApplyConsents(ApplyConsentsRequest body, string name)

Parameters

Type	Name	Description
ApplyConsentsRequest	body	The body of the request.
string	name	Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyConsentsRequest

BulkExportGroup(string)

Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide $export group of patients. The following headers must be set in the request: * Accept: specifies the format of the OperationOutcome response. Only application/fhir+json is supported. * Prefer: specifies whether the response is immediate or asynchronous. Must be to respond-async because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * _type: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * _since: if provided, only resources updated after the specified time are exported. * _outputFormat: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * organizeOutputBy: resource type to organize the output by. Required and must be set to Patient. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the Content-Location header of response is set to a URL that you can use to query the status of the export. The URL is in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.BulkExportGroupRequest BulkExportGroup(string name)

Parameters

Type	Name	Description
string	name	Required. Name of the Group resource that is exported, in format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Group/{group_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.BulkExportGroupRequest

ConfigureSearch(ConfigureSearchRequest, string)

Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ConfigureSearchRequest ConfigureSearch(ConfigureSearchRequest body, string name)

Parameters

Type	Name	Description
ConfigureSearchRequest	body	The body of the request.
string	name	Required. The name of the FHIR store to configure, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ConfigureSearchRequest

Create(FhirStore, string)

Creates a new FHIR store within the parent dataset.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.CreateRequest Create(FhirStore body, string parent)

Parameters

Type	Name	Description
FhirStore	body	The body of the request.
string	parent	Required. The name of the dataset this FHIR store belongs to.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.CreateRequest

Deidentify(DeidentifyFhirStoreRequest, string)

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. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeidentifyRequest Deidentify(DeidentifyFhirStoreRequest body, string sourceStore)

Parameters

Type	Name	Description
DeidentifyFhirStoreRequest	body	The body of the request.
string	sourceStore	Required. Source FHIR store resource name. For example, projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeidentifyRequest

Delete(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the FHIR store to delete.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeleteRequest

ExplainDataAccess(string)

Explains all the permitted/denied actor, purpose and environment for a given resource.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExplainDataAccessRequest ExplainDataAccess(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the FHIR store to enforce, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExplainDataAccessRequest

Export(ExportResourcesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExportRequest Export(ExportResourcesRequest body, string name)

Parameters

Type	Name	Description
ExportResourcesRequest	body	The body of the request.
string	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_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExportRequest

ExportHistory(ExportResourcesHistoryRequest, string)

Export resources including historical versions from the FHIR store to the specified destination. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. 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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExportHistoryRequest ExportHistory(ExportResourcesHistoryRequest body, string name)

Parameters

Type	Name	Description
ExportResourcesHistoryRequest	body	The body of the request.
string	name	Required. The name of the FHIR store to export resource from, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExportHistoryRequest

Get(string)

Gets the configuration of the specified FHIR store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the FHIR store to get.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetRequest

GetFHIRStoreMetrics(string)

Gets metrics associated with the FHIR store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetFHIRStoreMetricsRequest GetFHIRStoreMetrics(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the FHIR store to get metrics for.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetFHIRStoreMetricsRequest

GetIamPolicy(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetIamPolicyRequest

Import(ImportResourcesRequest, string)

Import 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 is 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 are 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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ImportRequest Import(ImportResourcesRequest body, string name)

Parameters

Type	Name	Description
ImportResourcesRequest	body	The body of the request.
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}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ImportRequest

ImportHistory(ImportResourcesHistoryRequest, string)

Import resource historical versions from Cloud Storage source to destination fhir store. The exported resource, along with previous versions, will be exported in one or more FHIR history bundles. 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 ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ImportHistoryRequest ImportHistory(ImportResourcesHistoryRequest body, string name)

Parameters

Type	Name	Description
ImportResourcesHistoryRequest	body	The body of the request.
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}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ImportHistoryRequest

List(string)

Lists the FHIR stores in the given dataset.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. Name of the dataset.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ListRequest

Patch(FhirStore, string)

Updates the configuration of the specified FHIR store.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.PatchRequest Patch(FhirStore body, string name)

Parameters

Type	Name	Description
FhirStore	body	The body of the request.
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}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.PatchRequest

Rollback(RollbackFhirResourcesRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.RollbackRequest Rollback(RollbackFhirResourcesRequest body, string name)

Parameters

Type	Name	Description
RollbackFhirResourcesRequest	body	The body of the request.
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}".

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.RollbackRequest

SetIamPolicy(SetIamPolicyRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)

Parameters

Type	Name	Description
TestIamPermissionsRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.TestIamPermissionsRequest