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_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> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#batchGet">batchGet(parent, ids=None, view=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Gets multiple messages in the given HL7v2 store.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 85<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> 86<p class="toc_element"> 87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes an HL7v2 message.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets an HL7v2 message.</p> 92<p class="toc_element"> 93 <code><a href="#ingest">ingest(parent, body=None, x__xgafv=None)</a></code></p> 94<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> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> 97<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> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 103<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> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="batchGet">batchGet(parent, ids=None, view=None, x__xgafv=None)</code> 107 <pre>Gets multiple messages in the given HL7v2 store. 108 109Args: 110 parent: string, 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) 111 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) 112 view: string, Specifies the parts of the Messages resource to return in the response. When unspecified, equivalent to BASIC. 113 Allowed values 114 MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages. 115 RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields. 116 PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields. 117 FULL - Server responses include all the message fields. 118 SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields. 119 BASIC - Server responses include only the name field. 120 x__xgafv: string, V1 error format. 121 Allowed values 122 1 - v1 error format 123 2 - v2 error format 124 125Returns: 126 An object of the form: 127 128 { # Gets multiple messages in a specified HL7v2 store. 129 "messages": [ # The returned Messages. See `MessageView` for populated fields. 130 { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 131 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 132 "data": "A String", # Raw message bytes. 133 "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. 134 "a_key": "A String", 135 }, 136 "messageType": "A String", # The message type for this message. MSH-9.1. 137 "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. 138 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 139 "segments": [ 140 { # A segment in a structured format. 141 "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". 142 "a_key": "A String", 143 }, 144 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 145 "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. 146 }, 147 ], 148 }, 149 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 150 { # A patient identifier and associated type. 151 "type": "A String", # ID type. For example, MRN or NHS. 152 "value": "A String", # The patient's unique identifier. 153 }, 154 ], 155 "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. 156 "data": "A String", # JSON output of the parser. 157 "error": "A String", # The error output of the parser. 158 }, 159 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 160 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 161 }, 162 ], 163}</pre> 164</div> 165 166<div class="method"> 167 <code class="details" id="close">close()</code> 168 <pre>Close httplib2 connections.</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 173 <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. 174 175Args: 176 parent: string, The name of the dataset this message belongs to. (required) 177 body: object, The request body. 178 The object takes the form of: 179 180{ # Creates a new message. 181 "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. # HL7v2 message. 182 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 183 "data": "A String", # Raw message bytes. 184 "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. 185 "a_key": "A String", 186 }, 187 "messageType": "A String", # The message type for this message. MSH-9.1. 188 "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. 189 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 190 "segments": [ 191 { # A segment in a structured format. 192 "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". 193 "a_key": "A String", 194 }, 195 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 196 "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. 197 }, 198 ], 199 }, 200 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 201 { # A patient identifier and associated type. 202 "type": "A String", # ID type. For example, MRN or NHS. 203 "value": "A String", # The patient's unique identifier. 204 }, 205 ], 206 "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. 207 "data": "A String", # JSON output of the parser. 208 "error": "A String", # The error output of the parser. 209 }, 210 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 211 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 212 }, 213} 214 215 x__xgafv: string, V1 error format. 216 Allowed values 217 1 - v1 error format 218 2 - v2 error format 219 220Returns: 221 An object of the form: 222 223 { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 224 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 225 "data": "A String", # Raw message bytes. 226 "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. 227 "a_key": "A String", 228 }, 229 "messageType": "A String", # The message type for this message. MSH-9.1. 230 "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. 231 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 232 "segments": [ 233 { # A segment in a structured format. 234 "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". 235 "a_key": "A String", 236 }, 237 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 238 "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. 239 }, 240 ], 241 }, 242 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 243 { # A patient identifier and associated type. 244 "type": "A String", # ID type. For example, MRN or NHS. 245 "value": "A String", # The patient's unique identifier. 246 }, 247 ], 248 "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. 249 "data": "A String", # JSON output of the parser. 250 "error": "A String", # The error output of the parser. 251 }, 252 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 253 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 259 <pre>Deletes an HL7v2 message. 260 261Args: 262 name: string, The resource name of the HL7v2 message to delete. (required) 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # 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 `{}`. 272}</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> 277 <pre>Gets an HL7v2 message. 278 279Args: 280 name: string, The resource name of the HL7v2 message to retrieve. (required) 281 view: string, Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL. 282 Allowed values 283 MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages. 284 RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields. 285 PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields. 286 FULL - Server responses include all the message fields. 287 SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields. 288 BASIC - Server responses include only the name field. 289 x__xgafv: string, V1 error format. 290 Allowed values 291 1 - v1 error format 292 2 - v2 error format 293 294Returns: 295 An object of the form: 296 297 { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 298 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 299 "data": "A String", # Raw message bytes. 300 "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. 301 "a_key": "A String", 302 }, 303 "messageType": "A String", # The message type for this message. MSH-9.1. 304 "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. 305 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 306 "segments": [ 307 { # A segment in a structured format. 308 "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". 309 "a_key": "A String", 310 }, 311 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 312 "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. 313 }, 314 ], 315 }, 316 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 317 { # A patient identifier and associated type. 318 "type": "A String", # ID type. For example, MRN or NHS. 319 "value": "A String", # The patient's unique identifier. 320 }, 321 ], 322 "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. 323 "data": "A String", # JSON output of the parser. 324 "error": "A String", # The error output of the parser. 325 }, 326 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 327 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 328}</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="ingest">ingest(parent, body=None, x__xgafv=None)</code> 333 <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. 334 335Args: 336 parent: string, The name of the HL7v2 store this message belongs to. (required) 337 body: object, The request body. 338 The object takes the form of: 339 340{ # Ingests a message into the specified HL7v2 store. 341 "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. # HL7v2 message to ingest. 342 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 343 "data": "A String", # Raw message bytes. 344 "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. 345 "a_key": "A String", 346 }, 347 "messageType": "A String", # The message type for this message. MSH-9.1. 348 "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. 349 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 350 "segments": [ 351 { # A segment in a structured format. 352 "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". 353 "a_key": "A String", 354 }, 355 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 356 "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. 357 }, 358 ], 359 }, 360 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 361 { # A patient identifier and associated type. 362 "type": "A String", # ID type. For example, MRN or NHS. 363 "value": "A String", # The patient's unique identifier. 364 }, 365 ], 366 "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. 367 "data": "A String", # JSON output of the parser. 368 "error": "A String", # The error output of the parser. 369 }, 370 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 371 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 372 }, 373} 374 375 x__xgafv: string, V1 error format. 376 Allowed values 377 1 - v1 error format 378 2 - v2 error format 379 380Returns: 381 An object of the form: 382 383 { # Acknowledges that a message has been ingested into the specified HL7v2 store. 384 "hl7Ack": "A String", # HL7v2 ACK message. 385 "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. 386 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 387 "data": "A String", # Raw message bytes. 388 "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. 389 "a_key": "A String", 390 }, 391 "messageType": "A String", # The message type for this message. MSH-9.1. 392 "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. 393 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 394 "segments": [ 395 { # A segment in a structured format. 396 "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". 397 "a_key": "A String", 398 }, 399 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 400 "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. 401 }, 402 ], 403 }, 404 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 405 { # A patient identifier and associated type. 406 "type": "A String", # ID type. For example, MRN or NHS. 407 "value": "A String", # The patient's unique identifier. 408 }, 409 ], 410 "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. 411 "data": "A String", # JSON output of the parser. 412 "error": "A String", # The error output of the parser. 413 }, 414 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 415 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 416 }, 417}</pre> 418</div> 419 420<div class="method"> 421 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> 422 <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. 423 424Args: 425 parent: string, Name of the HL7v2 store to retrieve messages from. (required) 426 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":*`. 427 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` 428 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. 429 pageToken: string, The next_page_token value returned from the previous List request, if any. 430 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. 431 Allowed values 432 MESSAGE_VIEW_UNSPECIFIED - Not specified, equivalent to FULL for getMessage, equivalent to BASIC for listMessages. 433 RAW_ONLY - Server responses include all the message fields except parsed_data, and schematized_data fields. 434 PARSED_ONLY - Server responses include all the message fields except data and schematized_data fields. 435 FULL - Server responses include all the message fields. 436 SCHEMATIZED_ONLY - Server responses include all the message fields except data and parsed_data fields. 437 BASIC - Server responses include only the name field. 438 x__xgafv: string, V1 error format. 439 Allowed values 440 1 - v1 error format 441 2 - v2 error format 442 443Returns: 444 An object of the form: 445 446 { # Lists the messages in the specified HL7v2 store. 447 "hl7V2Messages": [ # The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields. 448 { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 449 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 450 "data": "A String", # Raw message bytes. 451 "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. 452 "a_key": "A String", 453 }, 454 "messageType": "A String", # The message type for this message. MSH-9.1. 455 "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. 456 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 457 "segments": [ 458 { # A segment in a structured format. 459 "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". 460 "a_key": "A String", 461 }, 462 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 463 "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. 464 }, 465 ], 466 }, 467 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 468 { # A patient identifier and associated type. 469 "type": "A String", # ID type. For example, MRN or NHS. 470 "value": "A String", # The patient's unique identifier. 471 }, 472 ], 473 "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. 474 "data": "A String", # JSON output of the parser. 475 "error": "A String", # The error output of the parser. 476 }, 477 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 478 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 479 }, 480 ], 481 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. 482}</pre> 483</div> 484 485<div class="method"> 486 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 487 <pre>Retrieves the next page of results. 488 489Args: 490 previous_request: The request for the previous page. (required) 491 previous_response: The response from the request for the previous page. (required) 492 493Returns: 494 A request object that you can call 'execute()' on to request the next 495 page. Returns None if there are no more items in the collection. 496 </pre> 497</div> 498 499<div class="method"> 500 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 501 <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. 502 503Args: 504 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) 505 body: object, The request body. 506 The object takes the form of: 507 508{ # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 509 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 510 "data": "A String", # Raw message bytes. 511 "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. 512 "a_key": "A String", 513 }, 514 "messageType": "A String", # The message type for this message. MSH-9.1. 515 "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. 516 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 517 "segments": [ 518 { # A segment in a structured format. 519 "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". 520 "a_key": "A String", 521 }, 522 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 523 "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. 524 }, 525 ], 526 }, 527 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 528 { # A patient identifier and associated type. 529 "type": "A String", # ID type. For example, MRN or NHS. 530 "value": "A String", # The patient's unique identifier. 531 }, 532 ], 533 "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. 534 "data": "A String", # JSON output of the parser. 535 "error": "A String", # The error output of the parser. 536 }, 537 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 538 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 539} 540 541 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 542 x__xgafv: string, V1 error format. 543 Allowed values 544 1 - v1 error format 545 2 - v2 error format 546 547Returns: 548 An object of the form: 549 550 { # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard. 551 "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. 552 "data": "A String", # Raw message bytes. 553 "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. 554 "a_key": "A String", 555 }, 556 "messageType": "A String", # The message type for this message. MSH-9.1. 557 "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. 558 "parsedData": { # The content of an HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. 559 "segments": [ 560 { # A segment in a structured format. 561 "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". 562 "a_key": "A String", 563 }, 564 "segmentId": "A String", # A string that indicates the type of segment. For example, EVN or PID. 565 "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. 566 }, 567 ], 568 }, 569 "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. 570 { # A patient identifier and associated type. 571 "type": "A String", # ID type. For example, MRN or NHS. 572 "value": "A String", # The patient's unique identifier. 573 }, 574 ], 575 "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. 576 "data": "A String", # JSON output of the parser. 577 "error": "A String", # The error output of the parser. 578 }, 579 "sendFacility": "A String", # The hospital that this message came from. MSH-4. 580 "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. 581}</pre> 582</div> 583 584</body></html>