Package google.cloud.healthcare.v1.hl7v2

string

Required. The name of the dataset this HL7v2 store belongs to.

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

• healthcare.hl7V2Stores.create

string

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

Hl7V2Store

Configuration info for this HL7v2 store.

string

Required. The name of the HL7v2 store this message belongs to.

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

• healthcare.hl7V2Messages.create

Message

Required. HL7v2 message.

string

Required. The resource name of the HL7v2 store to delete.

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

• healthcare.hl7V2Stores.delete

string

Required. The resource name of the HL7v2 message to delete.

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

• healthcare.hl7V2Messages.delete

string

Required. The name of the source HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}

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

• healthcare.hl7v2Stores.export

Timestamp

The start of the range in send_time (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z) is used.

This value has to come before the end_time defined below. Only messages whose send_time lies in the range start_time (inclusive) to end_time (exclusive) are exported.

Timestamp

The end of the range in send_time (MSH.7, https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm) to process. If not specified, the time when the export is scheduled is used.

This value has to come after the start_time defined below. Only messages whose send_time lies in the range start_time (inclusive) to end_time (exclusive) are exported.

string

Restricts messages exported to those matching a filter, only applicable to PubsubDestination and GcsDestination. 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 the yyyy-mm-dd format. 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, and is just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it.

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".
• 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".

Note: The filter will be applied to every message in the HL7v2 store whose send_time lies in the range defined by the start_time and the end_time. Even if the filter only matches a small set of messages, the export operation can still take a long time to finish when a lot of messages are between the specified start_time and end_time range.

GcsDestination

Export to a Cloud Storage destination.

PubsubDestination

Export messages to a Pub/Sub topic.

string

URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path.

MessageView

Specifies the parts of the Message resource to include in the export. If not specified, FULL is used.

ContentStructure

The format of the exported HL7v2 message files.

string

Points to a Cloud Storage URI containing file(s) to import.

The URI must be in the following format: gs://{bucket_id}/{object_id}. The URI can include wildcards in object_id and thus identify multiple files. Supported wildcards:

• * to match 0 or more non-separator characters
• ** to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .ndjson), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.ndjson imports all files with .ndjson extensions in my-directory/ and its sub-directories.
• ? to match 1 character

Files matching the wildcard are expected to contain content only, no metadata.

string

Required. The resource name of the HL7v2 store to get metrics for, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

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

• healthcare.hl7V2Stores.get

string

Required. The resource name of the HL7v2 store to get.

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

• healthcare.hl7V2Stores.get

string

Required. The resource name of the HL7v2 message to retrieve.

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

• healthcare.hl7V2Messages.get

MessageView

Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

SchemaSegment

SchemaGroup

VersionSource

Each VersionSource is tested and only if they all match is the schema used for the message.

map<string, SchemaGroup>

Map from each HL7v2 message type and trigger event pair, such as ADT_A04, to its schema configuration root group.

VersionSource

The version selectors that this config applies to. A message must match ALL version sources to apply.

Type

The HL7v2 type definitions.

string

Identifier. Resource name of the HL7v2 store, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

ParserConfig

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

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.

Hl7V2NotificationConfig

A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client.

bool

Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.

string

The Pub/Sub topic that notifications of changes are published on. Supplied by the client.

The notification is a PubsubMessage with the following fields:

• PubsubMessage.Data contains the resource name.
• PubsubMessage.MessageId is the ID of this notification. It's guaranteed to be unique within the topic.
• PubsubMessage.PublishTime is the time when the message was published.

Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project.

The Cloud Healthcare API service account, [email protected], must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.

If a notification cannot be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging).

string

Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. 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.

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".
• 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":*.

string

The resource name of the HL7v2 store to get metrics for, in the format projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}.

Hl7V2StoreMetric

List of HL7v2 store metrics by message type.

string

The Hl7v2 message type this metric applies to, such as ADT or ORU.

int64

The total count of HL7v2 messages in the store for the given message type.

int64

The total amount of structured storage used by HL7v2 messages of this message type in the store.

string

Required. The name of the target HL7v2 store, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7v2Stores/{hl7v2_store_id}

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

• healthcare.hl7v2Stores.import

GcsSource

Cloud Storage source data location and import configuration.

The Cloud Healthcare Service Agent requires the roles/storage.objectViewer Cloud IAM roles on the Cloud Storage location.

bytes

HL7v2 NACK message.

string

Required. The name of the HL7v2 store this message belongs to.

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

• healthcare.hl7V2Messages.ingest

Message

Required. HL7v2 message to ingest.

bytes

HL7v2 ACK message.

Message

Created message resource.

string

Required. Name of the dataset.

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

• healthcare.hl7V2Stores.list

int32

Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

string

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

string

Restricts stores 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.

Only filtering on labels is supported. For example, labels.key=value.

Hl7V2Store

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

string

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

string

Required. Name of the HL7v2 store to retrieve messages from.

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

• healthcare.hl7V2Messages.list

int32

Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.

string

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

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":*.

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

MessageView

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.

Message

The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields.

string

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

string

Output only. Resource name of the Message, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}. Assigned by the server.

bytes

Required. Raw message bytes.

Timestamp

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

string

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

Timestamp

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

string

The message type for this message. MSH-9.1.

PatientId

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

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.

ParsedData

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

SchematizedData

The parsed version of the raw message data schematized according to this store's schemas and type definitions.

Segment

bool

Determines whether messages with no header are allowed.

bytes

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

SchemaPackage

Schemas used to parse messages in this store, if schematized parsing is desired.

ParserVersion

Immutable. Determines the version of both the default parser to be used when schema is not given, as well as the schematized parser used when schema is specified. This field is immutable after HL7v2 store creation.

string

The Pub/Sub topic that Pub/Sub messages are published on. Supplied by the client.

The PubsubMessage contains the following fields:

• PubsubMessage.Data contains the resource name.
• PubsubMessage.MessageId is the ID of this notification. It is guaranteed to be unique within the topic.
• PubsubMessage.PublishTime is the time when the message was published.

Topic names must be scoped to a project.

The Cloud Healthcare API service account, [email protected], must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail.

string

The name of this group. For example, "ORDER_DETAIL".

bool

True indicates that this is a choice group, meaning that only one of its segments can exist in a given message.

int32

The minimum number of times this group must be present/repeated.

int32

The maximum number of times this group can be repeated. 0 or -1 means unbounded.

GroupOrSegment

Nested groups and/or segments.

SchematizedParsingType

Determines how messages that fail to parse are handled.

Hl7SchemaConfig

Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message.

Hl7TypesConfig

Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message.

bool

Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.

UnexpectedSegmentHandlingMode

Determines how unexpected segments (segments not matched to the schema) are handled.

string

The Segment type. For example, "PID".

int32

The minimum number of times this segment can be present in this group.

int32

The maximum number of times this segment can be present in this group. 0 or -1 means unbounded.

string

JSON output of the parser.

string

The error output of the parser.

string

A string that indicates the type of segment. For example, EVN or PID.

string

Set ID for segments that can be in a set. This can be empty if it's missing or isn't applicable.

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, "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".

string

The name of this type. This would be the segment or datatype name. For example, "PID" or "XPN".

Primitive

If this is a primitive type then this field is the type of the primitive For example, STRING. Leave unspecified for composite types.

Field

The (sub) fields this type has (if not primitive).

string

The name of the field. For example, "PID-1" or just "1".

string

The type of this field. A Type with this name must be defined in an Hl7TypesConfig.

string

The HL7v2 table this field refers to. For example, PID-15 (Patient's Primary Language) usually refers to table "0296".

int32

The minimum number of times this field must be present/repeated.

int32

The maximum number of times this field can be repeated. 0 or -1 means unbounded.

Hl7V2Store

Required. The HL7v2 store to update. Only fields listed in update_mask are applied.

Authorization requires the following IAM permission on the specified resource hl7V2Store:

• healthcare.hl7V2Stores.update

FieldMask

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

Message

Required. The message resource which updates the resource on the server. Only fields listed in update_mask are applied.

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

• healthcare.hl7V2Messages.update

FieldMask

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

string

The field to extract from the MSH segment. For example, "3.1" or "18[1].1".

string

The value to match with the field. For example, "My Application Name" or "2.3".