.TH "GCLOUD_HEALTHCARE_FHIR\-STORES_EXPORT_BQ" 1



.SH "NAME"
.HP
gcloud healthcare fhir\-stores export bq \- export Cloud Healthcare API FHIR resources to BigQuery



.SH "SYNOPSIS"
.HP
\f5gcloud healthcare fhir\-stores export bq\fR (\fIFHIR_STORE\fR\ :\ \fB\-\-dataset\fR=\fIDATASET\fR\ \fB\-\-location\fR=\fILOCATION\fR) \fB\-\-bq\-dataset\fR=\fIBQ_DATASET\fR \fB\-\-schema\-type\fR=\fISCHEMA_TYPE\fR [\fB\-\-async\fR] [\fB\-\-recursive\-depth\fR=\fIRECURSIVE_DEPTH\fR] [\fB\-\-resource\-type\fR=\fIRESOURCE_TYPE\fR] [\fB\-\-since\fR=\fISINCE\fR] [\fB\-\-write\-disposition\fR=\fIWRITE_DISPOSITION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Export Cloud Healthcare API FHIR resources to BigQuery.



.SH "EXAMPLES"

To export the fhir\-store 'test\-fhir\-store' to the BigQuery dataset
\'bqdataset', run:

.RS 2m
$ gcloud healthcare fhir\-stores export bq test\-fhir\-store \e
    \-\-bq\-dataset=bq://my\-project.bqdataset \-\-dataset=test\-dataset
.RE

To perform the same export, but with the 'ANALYTICS' schema and the recursive
structure depth of 3, run:

.RS 2m
$ gcloud healthcare fhir\-stores export bq test\-fhir\-store \e
    \-\-bq\-dataset=bq://my\-project.bqdataset \-\-dataset=test\-dataset \e
    \-\-schema\-type=analytics \-\-recursive\-depth=3
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

FhirStore resource \- Cloud Healthcare API FHIR store to export resources from.
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5fhir_store\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIFHIR_STORE\fR

ID of the fhirStore or fully qualified identifier for the fhirStore.

To set the \f5fhir_store\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5fhir_store\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-dataset\fR=\fIDATASET\fR

Cloud Healthcare dataset.

To set the \f5dataset\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5fhir_store\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-dataset\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Google Cloud location.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5fhir_store\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5healthcare/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-bq\-dataset\fR=\fIBQ_DATASET\fR

BigQuery dataset that houses the BigQuery tables.

.TP 2m
\fB\-\-schema\-type\fR=\fISCHEMA_TYPE\fR

Specifies the output schema type. \fISCHEMA_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBanalytics\fR
Analytics schema defined by the FHIR community. See
https://github.com/rbrush/sql\-on\-fhir/blob/master/sql\-on\-fhir.md.

.TP 2m
\fBanalytics_v2\fR
Analytics V2, similar to Analytics schema type, with added support for
extensions with one or more occurrences and contained resources to be
represented in stringified JSON.

.RE
.sp



.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-recursive\-depth\fR=\fIRECURSIVE_DEPTH\fR

The depth for all recursive structures in the output analytics schema. For
example, concept in the CodeSystem resource is a recursive structure; when the
depth is 2, the CodeSystem table will have a column called concept.concept but
not concept.concept.concept. If not specified or set to 0, the server will use
the default value 2.

.TP 2m
\fB\-\-resource\-type\fR=\fIRESOURCE_TYPE\fR

String of comma\-delimited FHIR resource types. If provided, only resources of
the specified resource type(s) are exported.

.TP 2m
\fB\-\-since\fR=\fISINCE\fR

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,
\f52015\-02\-07T13:28:17.239+02:00\fR or \f52017\-01\-01T00:00:00Z\fR. The time
must be specified to the second and include a time zone.

.TP 2m
\fB\-\-write\-disposition\fR=\fIWRITE_DISPOSITION\fR

Determines whether existing tables in the destination dataset are overwritten or
appended to. \fIWRITE_DISPOSITION\fR must be one of:

.RS 2m
.TP 2m
\fBwrite\-append\fR
Append data to the existing tables.

.TP 2m
\fBwrite\-empty\fR
Only export data if the destination tables are empty.

.TP 2m
\fBwrite\-truncate\fR
Erase all existing data in the tables before writing the instances.

.RE
.sp



.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBhealthcare/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/healthcare



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha healthcare fhir\-stores export bq
.RE

.RS 2m
$ gcloud beta healthcare fhir\-stores export bq
.RE