Google Git
Sign in
android / platform / external / python / google-api-python-client / 264792a7fb78d75fa0cc6b68c5efeb436a82969b / . / docs / dyn / healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.messages.html
blob: dcd8b1c8d3d1f384c502982241ff4a626f06c91b [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="healthcare_v1beta1.html">Cloud Healthcare API</a> . <a href="healthcare_v1beta1.projects.html">projects</a> . <a href="healthcare_v1beta1.projects.locations.html">locations</a> . <a href="healthcare_v1beta1.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.html">hl7V2Stores</a> . <a href="healthcare_v1beta1.projects.locations.datasets.hl7V2Stores.messages.html">messages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a message and sends a notification to the Cloud Pub/Sub topic. If</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an HL7v2 message.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None, view=None)</a></code></p>
<p class="firstline">Gets an HL7v2 message.</p>
<p class="toc_element">
<code><a href="#ingest">ingest(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Ingests a new HL7v2 message from the hospital and sends a notification to</p>
<p class="toc_element">
<code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
<p class="firstline">Lists all the messages in the given HL7v2 store with support for filtering.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the message.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>Creates a message and sends a notification to the Cloud Pub/Sub topic. If
configured, the MLLP adapter listens to messages created by this method and
sends those back to the hospital. A successful response indicates the
message has been persisted to storage and a Cloud Pub/Sub notification has
been sent. Sending to the hospital by the MLLP adapter happens
asynchronously.
Args:
parent: string, The name of the dataset this message belongs to. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Creates a new message.
"message": { # A complete HL7v2 message. # HL7v2 message.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A complete HL7v2 message.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an HL7v2 message.
Args:
name: string, The resource name of the HL7v2 message to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None, view=None)</code>
<pre>Gets an HL7v2 message.
Args:
name: string, The resource name of the HL7v2 message to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
view: string, Specifies which parts of the Message resource should be returned
in the response.
Returns:
An object of the form:
{ # A complete HL7v2 message.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="ingest">ingest(parent, body, x__xgafv=None)</code>
<pre>Ingests a new HL7v2 message from the hospital and sends a notification to
the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was
successfully stored. Otherwise an error is returned. If an identical
HL7v2 message is created twice only one resource is created on the server
and no error is reported.
Args:
parent: string, The name of the HL7v2 store this message belongs to. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Ingests a message into the specified HL7v2 store.
"message": { # A complete HL7v2 message. # HL7v2 message to ingest.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Acknowledges that a message has been ingested into the specified
# HL7v2 store.
"message": { # A complete HL7v2 message. # Created message resource.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
},
"hl7Ack": "A String", # HL7v2 ACK message.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
<pre>Lists all the messages in the given HL7v2 store with support for filtering.
Args:
parent: string, Name of the HL7v2 store to retrieve messages from. (required)
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: integer, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
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 segment; 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 of 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"`
* `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 message_type = "ADT"`.
Returns:
An object of the form:
{ # Lists the messages in the specified HL7v2 store.
"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more
# results in the list.
"messages": [ # The returned message names. Won't be more values than the value of
# page_size in the request.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
<pre>Update the message.
Args:
name: string, Resource name of the Message, of the form
`projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
Assigned by the server. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A complete HL7v2 message.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
}
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Only the `labels` field is allowed to be updated.
The labels in the request will be merged with the existing set of labels.
Existing labels with the same keys will be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A complete HL7v2 message.
# See http://www.hl7.org/implement/standards/index.cfm?ref=common for details
# on the standard.
"parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data.
"segments": [
{ # A segment in a structured format.
"fields": { # A mapping from the positional location to the value.
# The key string uses zero-based indexes separated by dots to identify
# Fields, components and sub-components. A bracket notation is also used to
# identify different instances of a repeated field.
# Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)?
#
# Examples of (key, value) pairs:
# - (0.1, "foo"): Component 1 of Field 0 has the value "foo".
# - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value
# "bar".
# - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated,
# has the value "baz".
"a_key": "A String",
},
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is
# missing or it is not applicable.
"segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID.
},
],
},
"name": "A String", # Resource name of the Message, of the form
# `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`.
# Assigned by the server.
"labels": { # User-supplied key-value pairs used to organize HL7v2 stores.
#
# Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
# of maximum 128 bytes, and must conform to the
# following PCRE regular expression:
# \p{Ll}\p{Lo}{0,62}
#
# Label values are optional, must be between 1 and 63 characters long, have
# a UTF-8 encoding of maximum 128 bytes, and must conform to the
# following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}
#
# No more than 64 labels can be associated with a given store.
"a_key": "A String",
},
"messageType": "A String", # The message type and trigger event for this message. MSH-9.
"sendFacility": "A String", # The hospital that this message came from. MSH-4.
"sendTime": "A String", # The datetime the sending application sent this message. MSH-7.
"data": "A String", # Raw message bytes.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this
# message.
{ # A patient identifier and associated type.
"type": "A String", # ID type, e.g. MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
}</pre>
</div>
</body></html>