Full name: projects.locations.datasets.fhirStores.bulk-export-group
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 theOperationOutcomeresponse. Onlyapplication/fhir+jsonis supported.Prefer: specifies whether the response is immediate or asynchronous. Must be torespond-asyncbecause only asynchronous responses are supported.
Specify the destination for the server to write result files by setting the Cloud Storage location bulkExportGcsDestination 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}_{resourceType}.ndjson.organizeOutputBy: resource type to organize the output by. Required and must be set toPatient. 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/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/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.
HTTP request
GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Group/*}/$export
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name |
Required. Name of the Group resource that is exported, in format Authorization requires the following IAM permission on the specified resource
|
Query parameters
| Parameters | |
|---|---|
_since |
Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, |
_type |
Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. |
outputFormat |
Optional. Output format of the export. This field is optional and only |
organizeOutputBy |
Optional. Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output files are grouped as follows:
Resources may be duplicated across multiple Patients. For example, if two Patient resources reference the same Organization resource, it will appear twice, once after each Patient. The Group resource from the request does not appear in the Patient files. |
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-healthcarehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.