1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
|
<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="#batchGet">batchGet(parent, ids=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets multiple messages in the given HL7v2 store.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.</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, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an HL7v2 message.</p>
<p class="toc_element">
<code><a href="#ingest">ingest(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGet">batchGet(parent, ids=None, view=None, x__xgafv=None)</code>
<pre>Gets multiple messages in the given HL7v2 store.
Args:
parent: string, Required. Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}`. (required)
ids: string, The resource id of the HL7v2 messages to retrieve in the format: `{message_id}`, where the full resource name is `{parent}/messages/{message_id}` A maximum of 100 messages can be retrieved in a batch. All 'ids' have to be under parent. (repeated)
view: string, Specifies the parts of the Messages resource to return in the response. When unspecified, equivalent to BASIC.
Allowed values
MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages.
RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields.
PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields.
FULL - Server responses include all the message fields.
SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields.
BASIC - Server responses include only the name field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Gets multiple messages in a specified HL7v2 store.
"messages": [ # The returned Messages. See `MessageView` for populated fields.
{ # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.
Args:
parent: string, Required. The name of the HL7v2 store this message belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # Creates a new message.
"message": { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. # Required. HL7v2 message.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
},
}
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 [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an HL7v2 message.
Args:
name: string, Required. 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets an HL7v2 message.
Args:
name: string, Required. The resource name of the HL7v2 message to retrieve. (required)
view: string, Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.
Allowed values
MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages.
RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields.
PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields.
FULL - Server responses include all the message fields.
SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields.
BASIC - Server responses include only the name field.
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 [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="ingest">ingest(parent, body=None, x__xgafv=None)</code>
<pre>Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.
Args:
parent: string, Required. The name of the HL7v2 store this message belongs to. (required)
body: object, The request body.
The object takes the form of:
{ # Ingests a message into the specified HL7v2 store.
"message": { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. # Required. HL7v2 message to ingest.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
},
}
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.
"hl7Ack": "A String", # HL7v2 ACK message.
"message": { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. # Created message resource.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>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.
Args:
parent: string, Required. Name of the HL7v2 store to retrieve messages from. (required)
filter: string, 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":*`.
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 not specified, 100 is used. May not be larger than 1000.
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.
Allowed values
MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages.
RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields.
PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields.
FULL - Server responses include all the message fields.
SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields.
BASIC - Server responses include only the name field.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Lists the messages in the specified HL7v2 store.
"hl7V2Messages": [ # The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields.
{ # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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=None, updateMask=None, x__xgafv=None)</code>
<pre>Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.
Args:
name: string, Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. (required)
body: object, The request body.
The object takes the form of:
{ # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
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 [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
"createTime": "A String", # Output only. The datetime when the message was created. Set by the server.
"data": "A String", # Required. Raw message bytes.
"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 for this message. MSH-9.1.
"name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
"parsedData": { # The content of an 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, "hemoglobin") denotes that the first component of Field 0 has the value "hemoglobin". * (1.1.2, "CBC") denotes that the second sub-component of the first component of Field 1 has the value "CBC". * (1[0].1, "HbA1c") denotes that the first component of the first Instance of Field 1, which is repeated, has the value "HbA1c".
"a_key": "A String",
},
"segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID.
"setId": "A String", # Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.
},
],
},
"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. For example, MRN or NHS.
"value": "A String", # The patient's unique identifier.
},
],
"schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions.
"data": "A String", # JSON output of the parser.
"error": "A String", # The error output of the parser.
},
"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.
}</pre>
</div>
</body></html>
|
