google-native logo
Google Cloud Native v0.27.0, Oct 21 22

google-native.healthcare/v1.Message

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.

Create Message Resource

new Message(name: string, args: MessageArgs, opts?: CustomResourceOptions);
@overload
def Message(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            data: Optional[str] = None,
            dataset_id: Optional[str] = None,
            hl7_v2_store_id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            message_type: Optional[str] = None,
            name: Optional[str] = None,
            patient_ids: Optional[Sequence[PatientIdArgs]] = None,
            project: Optional[str] = None,
            schematized_data: Optional[SchematizedDataArgs] = None,
            send_facility: Optional[str] = None,
            send_time: Optional[str] = None)
@overload
def Message(resource_name: str,
            args: MessageArgs,
            opts: Optional[ResourceOptions] = None)
func NewMessage(ctx *Context, name string, args MessageArgs, opts ...ResourceOption) (*Message, error)
public Message(string name, MessageArgs args, CustomResourceOptions? opts = null)
public Message(String name, MessageArgs args)
public Message(String name, MessageArgs args, CustomResourceOptions options)
type: google-native:healthcare/v1:Message
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args MessageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args MessageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MessageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MessageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args MessageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Message Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Message resource accepts the following input properties:

DatasetId string
Hl7V2StoreId string
Data string

Raw message bytes.

Labels Dictionary<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}{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.

Location string
MessageType string

The message type for this message. MSH-9.1.

Name string

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.

PatientIds List<Pulumi.GoogleNative.Healthcare.V1.Inputs.PatientIdArgs>

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

Project string
SchematizedData Pulumi.GoogleNative.Healthcare.V1.Inputs.SchematizedDataArgs

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

SendFacility string

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

SendTime string

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

DatasetId string
Hl7V2StoreId string
Data string

Raw message bytes.

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}{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.

Location string
MessageType string

The message type for this message. MSH-9.1.

Name string

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.

PatientIds []PatientIdArgs

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

Project string
SchematizedData SchematizedDataArgs

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

SendFacility string

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

SendTime string

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

datasetId String
hl7V2StoreId String
data String

Raw message bytes.

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}{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.

location String
messageType String

The message type for this message. MSH-9.1.

name String

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.

patientIds List<PatientIdArgs>

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

project String
schematizedData SchematizedDataArgs

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

sendFacility String

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

sendTime String

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

datasetId string
hl7V2StoreId string
data string

Raw message bytes.

labels {[key: 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}{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.

location string
messageType string

The message type for this message. MSH-9.1.

name string

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.

patientIds PatientIdArgs[]

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

project string
schematizedData SchematizedDataArgs

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

sendFacility string

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

sendTime string

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

dataset_id str
hl7_v2_store_id str
data str

Raw message bytes.

labels Mapping[str, str]

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.

location str
message_type str

The message type for this message. MSH-9.1.

name str

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.

patient_ids Sequence[PatientIdArgs]

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

project str
schematized_data SchematizedDataArgs

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

send_facility str

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

send_time str

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

datasetId String
hl7V2StoreId String
data String

Raw message bytes.

labels Map<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}{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.

location String
messageType String

The message type for this message. MSH-9.1.

name String

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.

patientIds List<Property Map>

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

project String
schematizedData Property Map

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

sendFacility String

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

sendTime String

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

Outputs

All input properties are implicitly available as output properties. Additionally, the Message resource produces the following output properties:

CreateTime string

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

Id string

The provider-assigned unique ID for this managed resource.

ParsedData Pulumi.GoogleNative.Healthcare.V1.Outputs.ParsedDataResponse

The parsed version of the raw message data.

CreateTime string

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

Id string

The provider-assigned unique ID for this managed resource.

ParsedData ParsedDataResponse

The parsed version of the raw message data.

createTime String

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

id String

The provider-assigned unique ID for this managed resource.

parsedData ParsedDataResponse

The parsed version of the raw message data.

createTime string

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

id string

The provider-assigned unique ID for this managed resource.

parsedData ParsedDataResponse

The parsed version of the raw message data.

create_time str

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

id str

The provider-assigned unique ID for this managed resource.

parsed_data ParsedDataResponse

The parsed version of the raw message data.

createTime String

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

id String

The provider-assigned unique ID for this managed resource.

parsedData Property Map

The parsed version of the raw message data.

Supporting Types

ParsedDataResponse

PatientId

Type string

ID type. For example, MRN or NHS.

Value string

The patient's unique identifier.

Type string

ID type. For example, MRN or NHS.

Value string

The patient's unique identifier.

type String

ID type. For example, MRN or NHS.

value String

The patient's unique identifier.

type string

ID type. For example, MRN or NHS.

value string

The patient's unique identifier.

type str

ID type. For example, MRN or NHS.

value str

The patient's unique identifier.

type String

ID type. For example, MRN or NHS.

value String

The patient's unique identifier.

PatientIdResponse

Type string

ID type. For example, MRN or NHS.

Value string

The patient's unique identifier.

Type string

ID type. For example, MRN or NHS.

Value string

The patient's unique identifier.

type String

ID type. For example, MRN or NHS.

value String

The patient's unique identifier.

type string

ID type. For example, MRN or NHS.

value string

The patient's unique identifier.

type str

ID type. For example, MRN or NHS.

value str

The patient's unique identifier.

type String

ID type. For example, MRN or NHS.

value String

The patient's unique identifier.

SchematizedData

Data string

JSON output of the parser.

Error string

The error output of the parser.

Data string

JSON output of the parser.

Error string

The error output of the parser.

data String

JSON output of the parser.

error String

The error output of the parser.

data string

JSON output of the parser.

error string

The error output of the parser.

data str

JSON output of the parser.

error str

The error output of the parser.

data String

JSON output of the parser.

error String

The error output of the parser.

SchematizedDataResponse

Data string

JSON output of the parser.

Error string

The error output of the parser.

Data string

JSON output of the parser.

Error string

The error output of the parser.

data String

JSON output of the parser.

error String

The error output of the parser.

data string

JSON output of the parser.

error string

The error output of the parser.

data str

JSON output of the parser.

error str

The error output of the parser.

data String

JSON output of the parser.

error String

The error output of the parser.

SegmentResponse

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

SegmentId string

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

SetId string

Set ID for segments that can be in a set. This can be empty if it's missing or isn't 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, "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".

SegmentId string

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

SetId string

Set ID for segments that can be in a set. This can be empty if it's missing or isn't 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, "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".

segmentId String

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

setId String

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

fields {[key: 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".

segmentId string

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

setId string

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

fields Mapping[str, str]

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

segment_id str

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

set_id str

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

fields Map<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".

segmentId String

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

setId String

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

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0