Full name: projects.locations.datasets.hl7V2Stores.export
Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7).
This API returns an Operation
that can be used to track the status of the job by calling operations.get
.
Immediate fatal errors appear in the error
field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse
is returned in the response
field. The metadata
field type for this operation is OperationMetadata
.
HTTP request
POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:export
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the source HL7v2 store, in the format Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "startTime": string, "endTime": string, "filter": string, // Union field |
Fields | |
---|---|
startTime |
The start of the range in This value has to come before the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The end of the range in This value has to come after the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
filter |
Restricts messages exported to those matching a filter, only applicable to
The following fields and functions are available for filtering:
Note: The filter will be applied to every message in the HL7v2 store whose |
Union field destination . Export destination. destination can be only one of the following: |
|
gcsDestination |
Export to a Cloud Storage destination. |
pubsubDestination |
Export messages to a Pub/Sub topic. |
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.
GcsDestination
The Cloud Storage output destination.
The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin
Cloud IAM roles on the Cloud Storage location.
JSON representation |
---|
{ "uriPrefix": string, "messageView": enum( |
Fields | |
---|---|
uriPrefix |
URI of an existing Cloud Storage directory where the server writes result files, in the format |
messageView |
Specifies the parts of the Message resource to include in the export. If not specified, FULL is used. |
contentStructure |
The format of the exported HL7v2 message files. |
ContentStructure
The content structure of the exported HL7v2 message files.
Enums | |
---|---|
CONTENT_STRUCTURE_UNSPECIFIED |
If the content structure is not specified, the default value MESSAGE_JSON will be used. |
MESSAGE_JSON |
Messages are printed using the JSON format returned from the GetMessage API. Messages are delimited with newlines. |
PubsubDestination
The Pub/Sub output destination.
The Cloud Healthcare Service Agent requires the roles/pubsub.publisher
Cloud IAM role on the Pub/Sub topic.
JSON representation |
---|
{ "pubsubTopic": string } |
Fields | |
---|---|
pubsubTopic |
The Pub/Sub topic that Pub/Sub messages are published on. Supplied by the client. The
Topic names must be scoped to a project. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. |