Class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest : CloudHealthcareBaseServiceRequest<ListMessagesResponse>, IClientServiceRequest<ListMessagesResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| string | parent |
Properties
Filter
Restricts messages returned to those matching a filter. The following syntax is
available: * A string field value can be written as text inside quotation marks, for
example "query text". The only valid relational operation for text fields is equality
(=), where text is searched within the field, rather than having the field be equal to
the text. For example, "Comment = great" returns messages with great in the comment
field. * A number field value can be written as an integer, a decimal, or an
exponential. The valid relational operators for number fields are the equality operator
(=), along with the less than/greater than operators (<, <=,
>, >=). Note that there is no inequality (!=) operator. You can
prepend the NOT operator to an expression to negate it. * A date field value must be
written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format.
Leading zeros are required for one-digit months and days. The valid relational operators
for date fields are the equality operator (=) , along with the less than/greater than
operators (<, <=, >, >=). Note that there is no
inequality (!=) operator. You can prepend the NOT operator to an expression to
negate it. * Multiple field query expressions can be combined in one query by adding
AND or OR operators between the expressions. If a boolean operator appears within a
quoted string, it is not treated as special, it's just another part of the character
string to be matched. You can prepend the NOT operator to an expression to negate it.
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". * create_time, the
timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format
for comparisons. For example, create_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":*.
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }Property Value
| Type | Description |
|---|---|
| string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
OrderBy
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
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PageSize
Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }Property Value
| Type | Description |
|---|---|
| int? |
PageToken
The next_page_token value returned from the previous List request, if any.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Parent
Required. Name of the HL7v2 store to retrieve messages from.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }Property Value
| Type | Description |
|---|---|
| string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
View
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.
Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest.ViewEnum? View { get; set; }Property Value
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest.ViewEnum? |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()