| <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="#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 Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud 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 Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (`ACK`) message when successful or a negative acknowledgement (`NACK`) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements.</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(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=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="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 Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. |
| |
| Args: |
| parent: string, The name of the dataset 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. # HL7v2 message. |
| "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. |
| "data": "A String", # 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", # 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. |
| "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", # 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", # 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. |
| "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, The resource name of the HL7v2 message to delete. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| <pre>Gets an HL7v2 message. |
| |
| Args: |
| name: string, 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", # 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", # 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. |
| "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 Cloud Pub/Sub topic configured in projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, the adapter transmits the message when a notification is received. This method also generates a response containing an HL7v2 acknowledgement (`ACK`) message when successful or a negative acknowledgement (`NACK`) message in case of error, suitable for replying to HL7v2 interface systems that expect these acknowledgements. |
| |
| Args: |
| parent: string, 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. # HL7v2 message to ingest. |
| "createTime": "A String", # Output only. The datetime when the message was created. Set by the server. |
| "data": "A String", # 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", # 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. |
| "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", # 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", # 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. |
| "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, Name of the HL7v2 store to retrieve messages from. (required) |
| filter: string, Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings The following fields and functions are available for filtering: * `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"`. * `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 zero the default page size of 100 is used. |
| 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", # 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", # 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. |
| "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(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=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, Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. (required) |
| body: object, The request body. |
| 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", # 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", # 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. |
| "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, 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", # 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", # 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. |
| "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> |