1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="healthcare_v1alpha2.html">Cloud Healthcare API</a> . <a href="healthcare_v1alpha2.projects.html">projects</a> . <a href="healthcare_v1alpha2.projects.locations.html">locations</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.html">datasets</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.hl7V2Stores.html">hl7V2Stores</a> . <a href="healthcare_v1alpha2.projects.locations.datasets.hl7V2Stores.messages.html">messages</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates a message and sends a notification to the Cloud Pub/Sub topic. If</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an HL7v2 message.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None, view=None)</a></code></p> 85<p class="firstline">Gets an HL7v2 message.</p> 86<p class="toc_element"> 87 <code><a href="#ingest">ingest(parent, body, x__xgafv=None)</a></code></p> 88<p class="firstline">Ingests a new HL7v2 message from the hospital and sends a notification to</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p> 91<p class="firstline">Lists all the messages in the given HL7v2 store with support for filtering.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Update the message.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 101 <pre>Creates a message and sends a notification to the Cloud Pub/Sub topic. If 102configured, the MLLP adapter listens to messages created by this method and 103sends those back to the hospital. A successful response indicates the 104message has been persisted to storage and a Cloud Pub/Sub notification has 105been sent. Sending to the hospital by the MLLP adapter happens 106asynchronously. 107 108Args: 109 parent: string, The name of the dataset this message belongs to. (required) 110 body: object, The request body. (required) 111 The object takes the form of: 112 113{ # Creates a new message. 114 "message": { # A complete HL7v2 message. # HL7v2 message. 115 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 116 # on the standard. 117 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 118 "segments": [ 119 { # A segment in a structured format. 120 "fields": { # A mapping from the positional location to the value. 121 # The key string uses zero-based indexes separated by dots to identify 122 # Fields, components and sub-components. A bracket notation is also used to 123 # identify different instances of a repeated field. 124 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 125 # 126 # Examples of (key, value) pairs: 127 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 128 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 129 # "bar". 130 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 131 # has the value "baz". 132 "a_key": "A String", 133 }, 134 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 135 # missing or it is not applicable. 136 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 137 }, 138 ], 139 }, 140 "name": "A String", # Resource name of the Message, of the form 141 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 142 # Assigned by the server. 143 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 144 # 145 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 146 # of maximum 128 bytes, and must conform to the 147 # following PCRE regular expression: 148 # \p{Ll}\p{Lo}{0,62} 149 # 150 # Label values are optional, must be between 1 and 63 characters long, have 151 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 152 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 153 # 154 # No more than 64 labels can be associated with a given store. 155 "a_key": "A String", 156 }, 157 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 158 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 159 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 160 "data": "A String", # Raw message bytes. 161 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 162 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 163 # message. 164 { # A patient identifier and associated type. 165 "type": "A String", # ID type, e.g. MRN or NHS. 166 "value": "A String", # The patient's unique identifier. 167 }, 168 ], 169 }, 170 } 171 172 x__xgafv: string, V1 error format. 173 Allowed values 174 1 - v1 error format 175 2 - v2 error format 176 177Returns: 178 An object of the form: 179 180 { # A complete HL7v2 message. 181 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 182 # on the standard. 183 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 184 "segments": [ 185 { # A segment in a structured format. 186 "fields": { # A mapping from the positional location to the value. 187 # The key string uses zero-based indexes separated by dots to identify 188 # Fields, components and sub-components. A bracket notation is also used to 189 # identify different instances of a repeated field. 190 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 191 # 192 # Examples of (key, value) pairs: 193 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 194 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 195 # "bar". 196 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 197 # has the value "baz". 198 "a_key": "A String", 199 }, 200 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 201 # missing or it is not applicable. 202 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 203 }, 204 ], 205 }, 206 "name": "A String", # Resource name of the Message, of the form 207 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 208 # Assigned by the server. 209 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 210 # 211 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 212 # of maximum 128 bytes, and must conform to the 213 # following PCRE regular expression: 214 # \p{Ll}\p{Lo}{0,62} 215 # 216 # Label values are optional, must be between 1 and 63 characters long, have 217 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 218 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 219 # 220 # No more than 64 labels can be associated with a given store. 221 "a_key": "A String", 222 }, 223 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 224 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 225 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 226 "data": "A String", # Raw message bytes. 227 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 228 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 229 # message. 230 { # A patient identifier and associated type. 231 "type": "A String", # ID type, e.g. MRN or NHS. 232 "value": "A String", # The patient's unique identifier. 233 }, 234 ], 235 }</pre> 236</div> 237 238<div class="method"> 239 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 240 <pre>Deletes an HL7v2 message. 241 242Args: 243 name: string, The resource name of the HL7v2 message to delete. (required) 244 x__xgafv: string, V1 error format. 245 Allowed values 246 1 - v1 error format 247 2 - v2 error format 248 249Returns: 250 An object of the form: 251 252 { # A generic empty message that you can re-use to avoid defining duplicated 253 # empty messages in your APIs. A typical example is to use it as the request 254 # or the response type of an API method. For instance: 255 # 256 # service Foo { 257 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 258 # } 259 # 260 # The JSON representation for `Empty` is empty JSON object `{}`. 261 }</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="get">get(name, x__xgafv=None, view=None)</code> 266 <pre>Gets an HL7v2 message. 267 268Args: 269 name: string, The resource name of the HL7v2 message to retrieve. (required) 270 x__xgafv: string, V1 error format. 271 Allowed values 272 1 - v1 error format 273 2 - v2 error format 274 view: string, Specifies which parts of the Message resource should be returned 275in the response. 276 277Returns: 278 An object of the form: 279 280 { # A complete HL7v2 message. 281 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 282 # on the standard. 283 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 284 "segments": [ 285 { # A segment in a structured format. 286 "fields": { # A mapping from the positional location to the value. 287 # The key string uses zero-based indexes separated by dots to identify 288 # Fields, components and sub-components. A bracket notation is also used to 289 # identify different instances of a repeated field. 290 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 291 # 292 # Examples of (key, value) pairs: 293 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 294 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 295 # "bar". 296 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 297 # has the value "baz". 298 "a_key": "A String", 299 }, 300 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 301 # missing or it is not applicable. 302 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 303 }, 304 ], 305 }, 306 "name": "A String", # Resource name of the Message, of the form 307 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 308 # Assigned by the server. 309 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 310 # 311 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 312 # of maximum 128 bytes, and must conform to the 313 # following PCRE regular expression: 314 # \p{Ll}\p{Lo}{0,62} 315 # 316 # Label values are optional, must be between 1 and 63 characters long, have 317 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 318 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 319 # 320 # No more than 64 labels can be associated with a given store. 321 "a_key": "A String", 322 }, 323 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 324 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 325 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 326 "data": "A String", # Raw message bytes. 327 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 328 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 329 # message. 330 { # A patient identifier and associated type. 331 "type": "A String", # ID type, e.g. MRN or NHS. 332 "value": "A String", # The patient's unique identifier. 333 }, 334 ], 335 }</pre> 336</div> 337 338<div class="method"> 339 <code class="details" id="ingest">ingest(parent, body, x__xgafv=None)</code> 340 <pre>Ingests a new HL7v2 message from the hospital and sends a notification to 341the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was 342successfully stored. Otherwise an error is returned. If an identical 343HL7v2 message is created twice only one resource is created on the server 344and no error is reported. 345 346Args: 347 parent: string, The name of the HL7v2 store this message belongs to. (required) 348 body: object, The request body. (required) 349 The object takes the form of: 350 351{ # Ingests a message into the specified HL7v2 store. 352 "message": { # A complete HL7v2 message. # HL7v2 message to ingest. 353 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 354 # on the standard. 355 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 356 "segments": [ 357 { # A segment in a structured format. 358 "fields": { # A mapping from the positional location to the value. 359 # The key string uses zero-based indexes separated by dots to identify 360 # Fields, components and sub-components. A bracket notation is also used to 361 # identify different instances of a repeated field. 362 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 363 # 364 # Examples of (key, value) pairs: 365 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 366 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 367 # "bar". 368 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 369 # has the value "baz". 370 "a_key": "A String", 371 }, 372 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 373 # missing or it is not applicable. 374 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 375 }, 376 ], 377 }, 378 "name": "A String", # Resource name of the Message, of the form 379 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 380 # Assigned by the server. 381 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 382 # 383 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 384 # of maximum 128 bytes, and must conform to the 385 # following PCRE regular expression: 386 # \p{Ll}\p{Lo}{0,62} 387 # 388 # Label values are optional, must be between 1 and 63 characters long, have 389 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 390 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 391 # 392 # No more than 64 labels can be associated with a given store. 393 "a_key": "A String", 394 }, 395 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 396 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 397 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 398 "data": "A String", # Raw message bytes. 399 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 400 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 401 # message. 402 { # A patient identifier and associated type. 403 "type": "A String", # ID type, e.g. MRN or NHS. 404 "value": "A String", # The patient's unique identifier. 405 }, 406 ], 407 }, 408 } 409 410 x__xgafv: string, V1 error format. 411 Allowed values 412 1 - v1 error format 413 2 - v2 error format 414 415Returns: 416 An object of the form: 417 418 { # Acknowledges that a message has been ingested into the specified 419 # HL7v2 store. 420 "message": { # A complete HL7v2 message. # Created message resource. 421 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 422 # on the standard. 423 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 424 "segments": [ 425 { # A segment in a structured format. 426 "fields": { # A mapping from the positional location to the value. 427 # The key string uses zero-based indexes separated by dots to identify 428 # Fields, components and sub-components. A bracket notation is also used to 429 # identify different instances of a repeated field. 430 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 431 # 432 # Examples of (key, value) pairs: 433 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 434 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 435 # "bar". 436 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 437 # has the value "baz". 438 "a_key": "A String", 439 }, 440 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 441 # missing or it is not applicable. 442 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 443 }, 444 ], 445 }, 446 "name": "A String", # Resource name of the Message, of the form 447 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 448 # Assigned by the server. 449 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 450 # 451 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 452 # of maximum 128 bytes, and must conform to the 453 # following PCRE regular expression: 454 # \p{Ll}\p{Lo}{0,62} 455 # 456 # Label values are optional, must be between 1 and 63 characters long, have 457 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 458 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 459 # 460 # No more than 64 labels can be associated with a given store. 461 "a_key": "A String", 462 }, 463 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 464 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 465 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 466 "data": "A String", # Raw message bytes. 467 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 468 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 469 # message. 470 { # A patient identifier and associated type. 471 "type": "A String", # ID type, e.g. MRN or NHS. 472 "value": "A String", # The patient's unique identifier. 473 }, 474 ], 475 }, 476 "hl7Ack": "A String", # HL7v2 ACK message. 477 }</pre> 478</div> 479 480<div class="method"> 481 <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code> 482 <pre>Lists all the messages in the given HL7v2 store with support for filtering. 483 484Args: 485 parent: string, Name of the HL7v2 store to retrieve messages from. (required) 486 orderBy: string, Orders messages returned by the specified order_by clause. 487Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order 488 489Fields available for ordering are: 490 491* `send_time` 492 pageSize: integer, Limit on the number of messages to return in a single response. 493If zero the default page size of 100 is used. 494 pageToken: string, The next_page_token value returned from the previous List request, if any. 495 x__xgafv: string, V1 error format. 496 Allowed values 497 1 - v1 error format 498 2 - v2 error format 499 filter: string, Restricts messages returned to those matching a filter. Syntax: 500https://cloud.google.com/appengine/docs/standard/python/search/query_strings 501 502Fields/functions available for filtering are: 503 504* `message_type`, from the MSH-9 segment; for example 505`NOT message_type = "ADT"` 506* `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in 507the dataset's time_zone, from the MSH-7 segment; for example 508`send_date < "2017-01-02"` 509* `send_time`, the timestamp of when the message was sent, using the 510RFC3339 time format for comparisons, from the MSH-7 segment; for example 511`send_time < "2017-01-02T00:00:00-05:00"` 512* `send_facility`, the care center that the message came from, from the 513MSH-4 segment; for example `send_facility = "ABC"` 514* `HL7RegExp(expr)`, which does regular expression matching of `expr` 515against the message payload using re2 (http://code.google.com/p/re2/) 516syntax; for example `HL7RegExp("^.*\|.*\|EMERG")` 517* `PatientId(value, type)`, which matches if the message lists a patient 518having an ID of the given value and type in the PID-2, PID-3, or PID-4 519segments; for example `PatientId("123456", "MRN")` 520* `labels.x`, a string value of the label with key `x` as set using the 521Message.labels 522map, for example `labels."priority"="high"`. The operator `:*` can be used 523to assert the existence of a label, for example `labels."priority":*`. 524 525Limitations on conjunctions: 526 527* Negation on the patient ID function or the labels field is not 528supported, for example these queries are invalid: 529`NOT PatientId("123456", "MRN")`, `NOT labels."tag1":*`, 530`NOT labels."tag2"="val2"`. 531* Conjunction of multiple patient ID functions is not supported, for 532example this query is invalid: 533`PatientId("123456", "MRN") AND PatientId("456789", "MRN")`. 534* Conjunction of multiple labels fields is also not supported, for 535example this query is invalid: `labels."tag1":* AND labels."tag2"="val2"`. 536* Conjunction of one patient ID function, one labels field and conditions 537on other fields is supported, for example this query is valid: 538`PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT"`. 539 540The HasLabel(x) and Label(x) syntax from previous API versions are 541deprecated; replaced by the `labels.x` syntax. 542 543Returns: 544 An object of the form: 545 546 { # Lists the messages in the specified HL7v2 store. 547 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more 548 # results in the list. 549 "messages": [ # The returned message names. Won't be more values than the value of 550 # page_size in the request. 551 "A String", 552 ], 553 }</pre> 554</div> 555 556<div class="method"> 557 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 558 <pre>Retrieves the next page of results. 559 560Args: 561 previous_request: The request for the previous page. (required) 562 previous_response: The response from the request for the previous page. (required) 563 564Returns: 565 A request object that you can call 'execute()' on to request the next 566 page. Returns None if there are no more items in the collection. 567 </pre> 568</div> 569 570<div class="method"> 571 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 572 <pre>Update the message. 573 574Args: 575 name: string, Resource name of the Message, of the form 576`projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 577Assigned by the server. (required) 578 body: object, The request body. (required) 579 The object takes the form of: 580 581{ # A complete HL7v2 message. 582 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 583 # on the standard. 584 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 585 "segments": [ 586 { # A segment in a structured format. 587 "fields": { # A mapping from the positional location to the value. 588 # The key string uses zero-based indexes separated by dots to identify 589 # Fields, components and sub-components. A bracket notation is also used to 590 # identify different instances of a repeated field. 591 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 592 # 593 # Examples of (key, value) pairs: 594 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 595 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 596 # "bar". 597 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 598 # has the value "baz". 599 "a_key": "A String", 600 }, 601 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 602 # missing or it is not applicable. 603 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 604 }, 605 ], 606 }, 607 "name": "A String", # Resource name of the Message, of the form 608 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 609 # Assigned by the server. 610 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 611 # 612 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 613 # of maximum 128 bytes, and must conform to the 614 # following PCRE regular expression: 615 # \p{Ll}\p{Lo}{0,62} 616 # 617 # Label values are optional, must be between 1 and 63 characters long, have 618 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 619 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 620 # 621 # No more than 64 labels can be associated with a given store. 622 "a_key": "A String", 623 }, 624 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 625 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 626 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 627 "data": "A String", # Raw message bytes. 628 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 629 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 630 # message. 631 { # A patient identifier and associated type. 632 "type": "A String", # ID type, e.g. MRN or NHS. 633 "value": "A String", # The patient's unique identifier. 634 }, 635 ], 636} 637 638 updateMask: string, The update mask applies to the resource. For the `FieldMask` definition, 639see 640https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask 641Only the `labels` field is allowed to be updated. 642The labels in the request will be merged with the existing set of labels. 643Existing labels with the same keys will be updated. 644 x__xgafv: string, V1 error format. 645 Allowed values 646 1 - v1 error format 647 2 - v2 error format 648 649Returns: 650 An object of the form: 651 652 { # A complete HL7v2 message. 653 # See http://www.hl7.org/implement/standards/index.cfm?ref=common for details 654 # on the standard. 655 "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 656 "segments": [ 657 { # A segment in a structured format. 658 "fields": { # A mapping from the positional location to the value. 659 # The key string uses zero-based indexes separated by dots to identify 660 # Fields, components and sub-components. A bracket notation is also used to 661 # identify different instances of a repeated field. 662 # Regex for key: (\d+)(\[\d+\])?(.\d+)?(.\d+)? 663 # 664 # Examples of (key, value) pairs: 665 # - (0.1, "foo"): Component 1 of Field 0 has the value "foo". 666 # - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value 667 # "bar". 668 # - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, 669 # has the value "baz". 670 "a_key": "A String", 671 }, 672 "setId": "A String", # Set ID for segments that can be in a set. This can be empty if it is 673 # missing or it is not applicable. 674 "segmentId": "A String", # A string that indicates the type of segment, e.g., EVN, PID. 675 }, 676 ], 677 }, 678 "name": "A String", # Resource name of the Message, of the form 679 # `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. 680 # Assigned by the server. 681 "labels": { # User-supplied key-value pairs used to organize HL7v2 stores. 682 # 683 # Label keys must be between 1 and 63 characters long, have a UTF-8 encoding 684 # of maximum 128 bytes, and must conform to the 685 # following PCRE regular expression: 686 # \p{Ll}\p{Lo}{0,62} 687 # 688 # Label values are optional, must be between 1 and 63 characters long, have 689 # a UTF-8 encoding of maximum 128 bytes, and must conform to the 690 # following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} 691 # 692 # No more than 64 labels can be associated with a given store. 693 "a_key": "A String", 694 }, 695 "messageType": "A String", # The message type and trigger event for this message. MSH-9. 696 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 697 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 698 "data": "A String", # Raw message bytes. 699 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 700 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this 701 # message. 702 { # A patient identifier and associated type. 703 "type": "A String", # ID type, e.g. MRN or NHS. 704 "value": "A String", # The patient's unique identifier. 705 }, 706 ], 707 }</pre> 708</div> 709 710</body></html>