Package google.cloud.healthcare.v1alpha2.hl7v2

Index

Hl7V2Service

A service for handling HL7v2 messages (v2.x).

CreateHl7V2Store

rpc CreateHl7V2Store(CreateHl7V2StoreRequest) returns (Hl7V2Store)

Creates a new HL7v2 store within the parent dataset.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

Creates a message and sends a notification to the Cloud Pub/Sub topic. If configured, the MLLP adapter listens to messages created by this method and sends those back to the hospital. A successful response indicates the message has been persisted to storage and a Cloud Pub/Sub notification has been sent. Sending to the hospital by the MLLP adapter happens asynchronously.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteHl7V2Store

rpc DeleteHl7V2Store(DeleteHl7V2StoreRequest) returns (Empty)

Deletes the specified HL7v2 store and removes all messages that are contained within it.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

Deletes an HL7v2 message.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetHl7V2Store

rpc GetHl7V2Store(GetHl7V2StoreRequest) returns (Hl7V2Store)

Gets the specified HL7v2 store.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

Gets an HL7v2 message.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IngestMessage

rpc IngestMessage(IngestMessageRequest) returns (IngestMessageResponse)

Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message if the message was successfully stored. Otherwise an error is returned. If an identical HL7v2 message is created twice only one resource is created on the server and no error is reported.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListHl7V2Stores

rpc ListHl7V2Stores(ListHl7V2StoresRequest) returns (ListHl7V2StoresResponse)

Lists the HL7v2 stores in the given dataset.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

Lists all the messages in the given HL7v2 store with support for filtering.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateHl7V2Store

rpc UpdateHl7V2Store(UpdateHl7V2StoreRequest) returns (Hl7V2Store)

Updates the HL7v2 store.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

Update the message.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

CreateHl7V2StoreRequest

Creates a new HL7v2 store.

Fields
parent

string

The name of the dataset this HL7v2 store belongs to.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Stores.create

hl7_v2_store_id

string

The ID of the HL7v2 store that is being created. The string must match the following regex: [\p{L}\p{N}_\-\.]{1,256}.

hl7_v2_store

Hl7V2Store

Configuration info for this HL7v2 store.

CreateMessageRequest

Creates a new message.

Fields
parent

string

The name of the dataset this message belongs to.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Messages.create

message

Message

HL7v2 message.

DeleteHl7V2StoreRequest

Deletes the specified HL7v2 store.

Fields
name

string

The resource name of the HL7v2 store to delete.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.hl7V2Stores.delete

DeleteMessageRequest

Deletes a message from the specified HL7v2 store.

Fields
name

string

The resource name of the HL7v2 message to delete.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.hl7V2Messages.delete

GetHl7V2StoreRequest

Gets an HL7v2 store.

Fields
name

string

The resource name of the HL7v2 store to get.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.hl7V2Stores.get

GetMessageRequest

Gets a message from the specified HL7v2 store.

Fields
name

string

The resource name of the HL7v2 message to retrieve.

Authorization requires the following Google IAM permission on the specified resource name:

  • healthcare.hl7V2Messages.get

view

MessageView

Specifies which parts of the Message resource should be returned in the response.

Hl7V2Store

Represents an HL7v2 store.

Fields
name

string

Output only. Resource name of the HL7v2 store, of the form projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

notification_config

NotificationConfig

The notification destination all messages (both Ingest & Create) are published on. Only the message name is sent as part of the notification. If this is unset, no notifications will be sent. Supplied by the client.

parser_config

ParserConfig

The configuration for the parser. It determines how the server parses the messages.

labels

map<string, string>

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}][\p{Ll}\p{Lo}\p{N}_-]{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.

IngestMessageErrorDetail

Contains the HL7v2 NACK message for ingest message failure.

Fields
hl7_nack

bytes

HL7v2 NACK message.

IngestMessageRequest

Ingests a message into the specified HL7v2 store.

Fields
parent

string

The name of the HL7v2 store this message belongs to.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Messages.ingest

message

Message

HL7v2 message to ingest.

IngestMessageResponse

Acknowledges that a message has been ingested into the specified HL7v2 store.

Fields
hl7_ack

bytes

HL7v2 ACK message.

message

Message

Created message resource.

ListHl7V2StoresRequest

Lists the HL7v2 stores in the given dataset.

Fields
parent

string

Name of the dataset.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Stores.list

page_size

int32

Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example labels.key=value.

ListHl7V2StoresResponse

Lists the HL7v2 stores in the given dataset.

Fields
hl7_v2_stores[]

Hl7V2Store

The returned HL7v2 stores. Won't be more HL7v2 stores than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

ListMessagesRequest

Lists the messages in the specified HL7v2 store.

Fields
parent

string

Name of the HL7v2 store to retrieve messages from.

Authorization requires the following Google IAM permission on the specified resource parent:

  • healthcare.hl7V2Messages.list

page_size

int32

Limit on the number of messages to return in a single response. If zero the default page size of 100 is used.

page_token

string

The next_page_token value returned from the previous List request, if any.

filter

string

Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings

Fields/functions available for filtering are:

  • message_type, from the MSH-9 segment; for example NOT message_type = "ADT"
  • send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; for example send_date < "2017-01-02"
  • send_time, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; for example send_time < "2017-01-02T00:00:00-05:00"
  • send_facility, the care center that the message came from, from the MSH-4 segment; for example send_facility = "ABC"
  • HL7RegExp(expr), which does regular expression matching of expr against the message payload using re2 (http://code.google.com/p/re2/) syntax; for example HL7RegExp("^.*\|.*\|EMERG")
  • PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; for example PatientId("123456", "MRN")
  • labels.x, a string value of the label with key x as set using the Message.labels map, for example labels."priority"="high". The operator :* can be used to assert the existence of a label, for example labels."priority":*.

Limitations on conjunctions:

  • Negation on the patient ID function or the labels field is not supported, for example these queries are invalid: NOT PatientId("123456", "MRN"), NOT labels."tag1":*, NOT labels."tag2"="val2".
  • Conjunction of multiple patient ID functions is not supported, for example this query is invalid: PatientId("123456", "MRN") AND PatientId("456789", "MRN").
  • Conjunction of multiple labels fields is also not supported, for example this query is invalid: labels."tag1":* AND labels."tag2"="val2".
  • Conjunction of one patient ID function, one labels field and conditions on other fields is supported, for example this query is valid: PatientId("123456", "MRN") AND labels."tag1":* AND message_type = "ADT".

The HasLabel(x) and Label(x) syntax from previous API versions are deprecated; replaced by the labels.x syntax.

order_by

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

ListMessagesResponse

Lists the messages in the specified HL7v2 store.

Fields
messages[]

string

The returned message names. Won't be more values than the value of page_size in the request.

next_page_token

string

Token to retrieve the next page of results or empty if there are no more results in the list.

Message

A complete HL7v2 message. See http://www.hl7.org/implement/standards/index.cfm?ref=common for details on the standard.

Fields
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.

data

bytes

Raw message bytes.

create_time

Timestamp

Output only. The datetime when the message was created. Set by the server.

send_facility

string

The hospital that this message came from. MSH-4.

send_time

Timestamp

The datetime the sending application sent this message. MSH-7.

message_type

string

The message type and trigger event for this message. MSH-9.

patient_ids[]

PatientId

All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.

labels

map<string, string>

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}][\p{Ll}\p{Lo}\p{N}_-]{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.

parsed_data

ParsedData

Output only. The parsed version of the raw message data.

MessageView

Enums
MESSAGE_VIEW_UNSPECIFIED Not specified, equivalent to FULL.
RAW_ONLY Server responses includes all the message fields except parsed_data field.
PARSED_ONLY Server responses includes all the message fields except data field.
FULL Server responses includes all the message fields.

ParsedData

The content of a HL7v2 message in a structured format.

Fields
segments[]

Segment

ParserConfig

The configuration for the parser. It determines how the server parses the messages.

Fields
allow_null_header

bool

Determines whether messages with no header are allowed.

segment_terminator

bytes

Byte(s) to be used as the segment terminator. If this is unset, '\r' will be used as the segment terminator, matching the HL7 version 2 specification.

Segment

A segment in a structured format.

Fields
segment_id

string

A string that indicates the type of segment, e.g., EVN, PID.

set_id

string

Set ID for segments that can be in a set. This can be empty if it is missing or it is not applicable.

fields

map<string, string>

A mapping from the positional location to the value. The key string uses zero-based indexes separated by dots to identify Fields, components and sub-components. A bracket notation is also used to identify different instances of a repeated field. Regex for key: (\d+)([\d+])?(.\d+)?(.\d+)?

Examples of (key, value) pairs: - (0.1, "foo"): Component 1 of Field 0 has the value "foo". - (1.1.2, "bar"): Sub-component 2 of Component 1 of field 1 has the value "bar". - (1[2].1, "baz"): Component 1 of Instance 2 of Field 1, which is repeated, has the value "baz".

UpdateHl7V2StoreRequest

Request to update the given HL7v2 store, e.g. to change the Cloud Pub/Sub topic.

Fields
hl7_v2_store

Hl7V2Store

The HL7v2 store to be updated. Only fields listed in update_mask will be applied.

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

UpdateMessageRequest

Request to update the given message, e.g. to update labels.

Fields
message

Message

The message resource which updates the resource on the server. Only fields listed in update_mask will be applied.

Authorization requires the following Google IAM permission on the specified resource message:

  • healthcare.hl7V2Messages.update

update_mask

FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the labels field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated.

Var denne siden nyttig? Si fra hva du synes:

Send tilbakemelding om ...

Cloud Healthcare API