google-native.healthcare/v1.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:
- dataset_
id str - hl7_
v2_ strstore_ id - location str
- message_
id str - project str
- view str
getMessage Result
The following output properties are available:
- Create
Time 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.
- Message
Type 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.- Parsed
Data Pulumi.Google Native. Healthcare. V1. Outputs. Parsed Data Response The parsed version of the raw message data.
- Patient
Ids List<Pulumi.Google Native. Healthcare. V1. Outputs. Patient Id Response> All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- Schematized
Data Pulumi.Google Native. Healthcare. V1. Outputs. Schematized Data Response The parsed version of the raw message data schematized according to this store's schemas and type definitions.
- Send
Facility string The hospital that this message came from. MSH-4.
- Send
Time string The datetime the sending application sent this message. MSH-7.
- Create
Time 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.
- Message
Type 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.- Parsed
Data ParsedData Response The parsed version of the raw message data.
- Patient
Ids []PatientId Response All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- Schematized
Data SchematizedData Response The parsed version of the raw message data schematized according to this store's schemas and type definitions.
- Send
Facility string The hospital that this message came from. MSH-4.
- Send
Time string The datetime the sending application sent this message. MSH-7.
- create
Time 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.
- message
Type 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.- parsed
Data ParsedData Response The parsed version of the raw message data.
- patient
Ids List<PatientId Response> All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- schematized
Data SchematizedData Response The parsed version of the raw message data schematized according to this store's schemas and type definitions.
- send
Facility String The hospital that this message came from. MSH-4.
- send
Time String The datetime the sending application sent this message. MSH-7.
- create
Time 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.
- message
Type 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.- parsed
Data ParsedData Response The parsed version of the raw message data.
- patient
Ids PatientId Response[] All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- schematized
Data SchematizedData Response The parsed version of the raw message data schematized according to this store's schemas and type definitions.
- send
Facility string The hospital that this message came from. MSH-4.
- send
Time 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 ParsedData Response The parsed version of the raw message data.
- patient_
ids Sequence[PatientId Response] All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- schematized_
data SchematizedData Response 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.
- create
Time 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.
- message
Type 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.- parsed
Data Property Map The parsed version of the raw message data.
- patient
Ids List<Property Map> All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
- schematized
Data Property Map The parsed version of the raw message data schematized according to this store's schemas and type definitions.
- send
Facility String The hospital that this message came from. MSH-4.
- send
Time String The datetime the sending application sent this message. MSH-7.
Supporting Types
ParsedDataResponse
PatientIdResponse
SchematizedDataResponse
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".
- Segment
Id string A string that indicates the type of segment. For example, EVN or PID.
- Set
Id 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".
- Segment
Id string A string that indicates the type of segment. For example, EVN or PID.
- Set
Id 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".
- segment
Id String A string that indicates the type of segment. For example, EVN or PID.
- set
Id 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".
- segment
Id string A string that indicates the type of segment. For example, EVN or PID.
- set
Id 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".
- segment
Id String A string that indicates the type of segment. For example, EVN or PID.
- set
Id 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