healthcare.projects.locations.datasets.hl7V2Stores.messages.list
GET {{baseUrl}}/v1/:parent/messages?filter=<string>&orderBy=<string>&pageSize=<integer>&pageToken=<string>&view=<string>&$.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>
Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: * message_type, from the MSH-9.1 field. For example, NOT message_type = "ADT". * send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, send_date < "2017-01-02". * send_time, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, send_time < "2017-01-02T00:00:00-05:00". * send_facility, the care center that the message came from, from the MSH-4 segment. For example, send_facility = "ABC". * PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, PatientId("123456", "MRN"). * labels.x, a string value of the label with key x as set using the Message.labels map. For example, labels."priority"="high". The operator :* can be used to assert the existence of a label. For example, labels."priority":*. | |
orderBy | string | Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * send_time | |
pageSize | string | Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. | |
pageToken | string | The next_page_token value returned from the previous List request, if any. | |
view | string | Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a page_size larger than the default can generate a large response, which impacts the performance of this method. | |
$.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"). |
RESPONSES
status: OK
{"hl7V2Messages":[{"createTime":"in cillum deserunt id","data":"\u003cbyte\u003e","labels":"\u003cobject\u003e","messageType":"\u003cstring\u003e","name":"\u003cstring\u003e","parsedData":{"segments":[{"fields":{},"segmentId":"voluptate nisi in","setId":"ipsum"},{"fields":{},"segmentId":"et enim eiusmod","setId":"cillum eiusmod"}]},"patientIds":[{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"sendFacility":"\u003cstring\u003e","sendTime":"\u003cgoogle-datetime\u003e"},{"createTime":"labore veniam","data":"\u003cbyte\u003e","labels":"\u003cobject\u003e","messageType":"\u003cstring\u003e","name":"\u003cstring\u003e","parsedData":{"segments":[{"fields":{},"segmentId":"in tempor veniam","setId":"velit"},{"fields":{},"segmentId":"cillum enim elit non est","setId":"nostrud deserunt ipsum magna"}]},"patientIds":[{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"sendFacility":"\u003cstring\u003e","sendTime":"\u003cgoogle-datetime\u003e"}],"nextPageToken":"irure quis officia"}