Method: messages.list

Full name: projects.locations.datasets.hl7V2Stores.messages.list

Lists all the messages in the given HL7v2 store with support for filtering.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Name of the HL7v2 store to retrieve messages from.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Messages.list

Query parameters

Parameters
pageSize

number

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 nextPageToken value returned from the previous List request, if any.

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:

  • messageType, from the MSH-9 segment; for example NOT messageType = "ADT"
  • send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's timeZone, from the MSH-7 segment; for example send_date < "2017-01-02"
  • sendTime, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example sendTime < "2017-01-02T00:00:00-05:00"
  • sendFacility, the care center that the message came from, from the MSH-4 segment; for example sendFacility = "ABC"
  • HL7RegExp(expr), which does regular expression matching of expr against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example HL7RegExp("^.*\|.*\|EMERG")
  • 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":*.

Limitations on conjunctions:

  • Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: NOT PatientId("123456", "MRN"), NOT labels."tag1":*, NOT labels."tag2"="val2".
  • Conjunction of multiple patient ID functions is not supported, for example this query is invalid: PatientId("123456", "MRN") AND PatientId("456789", "MRN").
  • Conjunction of multiple labels fields is also not supported, for example this query is invalid: labels."tag1":* AND labels."tag2"="val2".
  • Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: PatientId("123456", "MRN") AND labels."tag1":* AND messageType = "ADT".

orderBy

string

Orders messages returned by the specified orderBy clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order

Fields available for ordering are:

  • sendTime

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Lists the messages in the specified HL7v2 store.

JSON representation
{
  "messages": [
    string
  ],
  "nextPageToken": string
}
Fields
messages[]

string

The returned message names. Won't be more values than the value of pageSize in the request.

nextPageToken

string

Token to retrieve the next page of results or empty if there are no more results in the list.

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.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API