gcloud alpha healthcare fhir-stores export bq Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha healthcare fhir-stores export bq - export Cloud Healthcare API FHIR resources to BigQuery
- SYNOPSIS
gcloud alpha healthcare fhir-stores export bq(FHIR_STORE:--dataset=DATASET--location=LOCATION)--bq-dataset=BQ_DATASET--schema-type=SCHEMA_TYPE[--async][--recursive-depth=RECURSIVE_DEPTH][--resource-type=RESOURCE_TYPE][--since=SINCE][--write-disposition=WRITE_DISPOSITION][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Export Cloud Healthcare API FHIR resources to BigQuery.- EXAMPLES
- To export the fhir-store 'test-fhir-store' to the BigQuery dataset 'bqdataset',run:
gcloudalphahealthcarefhir-storesexportbqtest-fhir-store--bq-dataset=bq://my-project.bqdataset--dataset=test-datasetTo perform the same export, but with the 'ANALYTICS' schema and the recursivestructure depth of 3, run:
gcloudalphahealthcarefhir-storesexportbqtest-fhir-store--bq-dataset=bq://my-project.bqdataset--dataset=test-dataset--schema-type=analytics--recursive-depth=3 - POSITIONAL ARGUMENTS
- FhirStore resource - Cloud Healthcare API FHIR store to export resources from.The arguments in this group can be used to specify the attributes of thisresource. (NOTE) Some attributes are not given arguments in this group but canbe set in other ways.
To set the
projectattribute:- provide the argument
fhir_storeon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
FHIR_STORE- ID of the fhirStore or fully qualified identifier for the fhirStore.
To set the
fhir_storeattribute:- provide the argument
fhir_storeon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--dataset=DATASET- Cloud Healthcare dataset.
To set the
datasetattribute:- provide the argument
fhir_storeon the command line with a fullyspecified name; - provide the argument
--dataseton the command line.
- provide the argument
--location=LOCATION- Google Cloud location.
To set the
locationattribute:- provide the argument
fhir_storeon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
healthcare/location.
- provide the argument
- provide the argument
- FhirStore resource - Cloud Healthcare API FHIR store to export resources from.The arguments in this group can be used to specify the attributes of thisresource. (NOTE) Some attributes are not given arguments in this group but canbe set in other ways.
- REQUIRED FLAGS
--bq-dataset=BQ_DATASET- BigQuery dataset that houses the BigQuery tables.
--schema-type=SCHEMA_TYPE- Specifies the output schema type. If unspecified, the default is
LOSSLESS.SCHEMA_TYPEmust be one of:analytics- Analytics schema defined by the FHIR community. Seehttps://github.com/rbrush/sql-on-fhir/blob/master/sql-on-fhir.md.
analytics_v2- Analytics V2, similar to schema defined by the FHIR community, with addedsupport for extensions with one or more occurrences and contained resources instringified JSON.
lossless- Schema generated from original FHIR data.
- OPTIONAL FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--recursive-depth=RECURSIVE_DEPTH- The depth for all recursive structures in the output analytics schema. Forexample, concept in the CodeSystem resource is a recursive structure; when thedepth is 2, the CodeSystem table will have a column called concept.concept butnot concept.concept.concept. If not specified or set to 0, the server will usethe default value 2.
--resource-type=RESOURCE_TYPE- String of comma-delimited FHIR resource types. If provided, only resources ofthe specified resource type(s) are exported.
--since=SINCE- If provided, only resources updated after this time are exported. The time usesthe format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example,
2015-02-07T13:28:17.239+02:00or2017-01-01T00:00:00Z.The time must be specified to the second and include a time zone. --write-disposition=WRITE_DISPOSITION- Determines whether existing tables in the destination dataset are overwritten orappended to.
WRITE_DISPOSITIONmust be one of:write-append- Append data to the existing tables.
write-empty- Only export data if the destination tables are empty.
write-truncate- Erase all existing data in the tables before writing the instances.
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$gcloud helpfor details. - API REFERENCE
- This command uses the
healthcare/v1alpha2API. The fulldocumentation for this API can be found at:https://cloud.google.com/healthcare - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudhealthcarefhir-storesexportbqgcloudbetahealthcarefhir-storesexportbq
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.