Method: fhirStores.deidentify

Full name: projects.locations.datasets.fhirStores.deidentify

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

HTTP request

POST https://healthcare.googleapis.com/v1/{sourceStore=projects/*/locations/*/datasets/*/fhirStores/*}:deidentify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
sourceStore

string

Required. Source FHIR store resource name. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}.

R5 stores are not supported.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "destinationStore": string,
  "config": {
    object(DeidentifyConfig)
  },
  "gcsConfigUri": string,
  "resourceFilter": {
    object(FhirFilter)
  },
  "skipModifiedResources": boolean
}
Fields
destinationStore

string

Required. The name of the FHIR store to create and write the redacted data to. For example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}.

  • The destination dataset must exist.
  • The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported.
  • The destination FHIR store must exist.
  • The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store.
config

object(DeidentifyConfig)

Deidentify configuration. Only one of config and gcsConfigUri can be specified.
gcsConfigUri

string

Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form gs://{bucket_id}/path/to/object. The Cloud Storage location must grant the Cloud IAM role roles/storage.objectViewer to the project's Cloud Healthcare Service Agent service account. Only one of config and gcsConfigUri can be specified.
resourceFilter

object(FhirFilter)

A filter specifying the resources to include in the output. If not specified, all resources are included in the output.
skipModifiedResources

boolean

If true, skips resources that are created or modified after the de-identify operation is created.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

FhirFilter

Filter configuration.

JSON representation 
{

  // Union field filter can be only one of the following:
  "resources": {
    object(Resources)
  }
  // End of list of possible types for union field filter.
}
Fields

Union field filter.

filter can be only one of the following:
resources

object(Resources)

List of resources to include in the output. If this list is empty or not specified, all resources are included in the output.

Resources

A list of FHIR resources.

JSON representation 
{
  "resources": [
    string
  ]
}
Fields
resources[]

string

List of resources IDs. For example, "Patient/1234".