Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

getMessage

Gets an HL7v2 message.

Using getMessage

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMessage(args: GetMessageArgs, opts?: InvokeOptions): Promise<GetMessageResult>
function getMessageOutput(args: GetMessageOutputArgs, opts?: InvokeOptions): Output<GetMessageResult>
def get_message(dataset_id: Optional[str] = None,
                hl7_v2_store_id: Optional[str] = None,
                location: Optional[str] = None,
                message_id: Optional[str] = None,
                project: Optional[str] = None,
                view: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetMessageResult
def get_message_output(dataset_id: Optional[pulumi.Input[str]] = None,
                hl7_v2_store_id: Optional[pulumi.Input[str]] = None,
                location: Optional[pulumi.Input[str]] = None,
                message_id: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                view: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetMessageResult]
func LookupMessage(ctx *Context, args *LookupMessageArgs, opts ...InvokeOption) (*LookupMessageResult, error)
func LookupMessageOutput(ctx *Context, args *LookupMessageOutputArgs, opts ...InvokeOption) LookupMessageResultOutput

> Note: This function is named LookupMessage in the Go SDK.

public static class GetMessage 
{
    public static Task<GetMessageResult> InvokeAsync(GetMessageArgs args, InvokeOptions? opts = null)
    public static Output<GetMessageResult> Invoke(GetMessageInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMessageResult> getMessage(GetMessageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:healthcare/v1:getMessage
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DatasetId string
Hl7V2StoreId string
Location string
MessageId string
Project string
View string
DatasetId string
Hl7V2StoreId string
Location string
MessageId string
Project string
View string
datasetId String
hl7V2StoreId String
location String
messageId String
project String
view String
datasetId string
hl7V2StoreId string
location string
messageId string
project string
view string
datasetId String
hl7V2StoreId String
location String
messageId String
project String
view String

getMessage Result

The following output properties are available:

CreateTime string

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

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.

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.

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

The parsed version of the raw message data.

PatientIds List<Pulumi.GoogleNative.Healthcare.V1.Outputs.PatientIdResponse>

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

SchematizedData Pulumi.GoogleNative.Healthcare.V1.Outputs.SchematizedDataResponse

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.

CreateTime string

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

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.

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.

ParsedData ParsedDataResponse

The parsed version of the raw message data.

PatientIds []PatientIdResponse

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

SchematizedData SchematizedDataResponse

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.

createTime String

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

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.

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.

parsedData ParsedDataResponse

The parsed version of the raw message data.

patientIds List<PatientIdResponse>

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

schematizedData SchematizedDataResponse

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.

createTime string

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

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.

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.

parsedData ParsedDataResponse

The parsed version of the raw message data.

patientIds PatientIdResponse[]

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

schematizedData SchematizedDataResponse

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.

create_time str

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

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.

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.

parsed_data ParsedDataResponse

The parsed version of the raw message data.

patient_ids Sequence[PatientIdResponse]

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

schematized_data SchematizedDataResponse

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.

createTime String

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

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.

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.

parsedData Property Map

The parsed version of the raw message data.

patientIds List<Property Map>

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

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.

Supporting Types

ParsedDataResponse

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.

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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0