Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

The "fhirStores" collection of methods.

Inheritance

System.Object

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.CloudHealthcare.v1

Assembly: Google.Apis.CloudHealthcare.v1.dll

Syntax

public class 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

Methods

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.
System.String	parent	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. If errors occur, error is set. Error details are also logged to Cloud Logging (see Viewing logs).

Declaration

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

Parameters

Type	Name	Description
DeidentifyFhirStoreRequest	body	The body of the request.
System.String	sourceStore	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
System.String	name	The resource name of the FHIR store to delete.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeleteRequest

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 logs). 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.
System.String	name	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

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
System.String	name	The resource name of the FHIR store to get.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetRequest

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
System.String	resource	REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetIamPolicyRequest

Import(ImportResourcesRequest, String)

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.

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 below. 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 logs). 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.
System.String	name	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

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
System.String	parent	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.
System.String	name	Output only. Resource name of the FHIR store, of the form projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.PatchRequest

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.
System.String	resource	REQUIRED: The resource for which the policy is being specified. See the operation documentation 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.
System.String	resource	REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.TestIamPermissionsRequest