healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest
POST {{baseUrl}}/v1/:parent/messages:ingest?$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (ACK) message when successful or a negative acknowledgement (NACK) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
Request Body
{"message"=>{"createTime"=>"nulla ipsum non pariatur", "data"=>"<byte>", "labels"=>"<object>", "messageType"=>"<string>", "name"=>"<string>", "parsedData"=>{"segments"=>[{"segmentId"=>"dolor", "setId"=>"proident dolor aliquip magna"}, {"segmentId"=>"ex fugiat proident sit", "setId"=>"id veniam fugia"}]}, "patientIds"=>[{"type"=>"<string>", "value"=>"<string>"}, {"type"=>"<string>", "value"=>"<string>"}], "sendFacility"=>"<string>", "sendTime"=>"<google-datetime>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"hl7Ack":"cupidatat enim","message":{"createTime":"dolor fugiat esse","data":"\u003cbyte\u003e","labels":"\u003cobject\u003e","messageType":"\u003cstring\u003e","name":"\u003cstring\u003e","parsedData":{"segments":[{"fields":{},"segmentId":"mollit aute incididunt in","setId":"pariatur"},{"fields":{},"segmentId":"ea commodo quis laboris","setId":"sit est in"}]},"patientIds":[{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"sendFacility":"\u003cstring\u003e","sendTime":"\u003cgoogle-datetime\u003e"}}