1. Packages
  2. Google Cloud Native
  3. API Docs
  4. healthcare
  5. healthcare/v1
  6. Message

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.healthcare/v1.Message

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Message(name: string, args: MessageArgs, opts?: CustomResourceOptions);
    @overload
    def Message(resource_name: str,
                args: MessageArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Message(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                dataset_id: Optional[str] = None,
                hl7_v2_store_id: Optional[str] = None,
                data: 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)
    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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var messageResource = new GoogleNative.Healthcare.V1.Message("messageResource", new()
    {
        DatasetId = "string",
        Hl7V2StoreId = "string",
        Data = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        MessageType = "string",
        Name = "string",
        PatientIds = new[]
        {
            new GoogleNative.Healthcare.V1.Inputs.PatientIdArgs
            {
                Type = "string",
                Value = "string",
            },
        },
        Project = "string",
        SchematizedData = new GoogleNative.Healthcare.V1.Inputs.SchematizedDataArgs
        {
            Data = "string",
            Error = "string",
        },
        SendFacility = "string",
        SendTime = "string",
    });
    
    example, err := healthcare.NewMessage(ctx, "messageResource", &healthcare.MessageArgs{
    DatasetId: pulumi.String("string"),
    Hl7V2StoreId: pulumi.String("string"),
    Data: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    MessageType: pulumi.String("string"),
    Name: pulumi.String("string"),
    PatientIds: healthcare.PatientIdArray{
    &healthcare.PatientIdArgs{
    Type: pulumi.String("string"),
    Value: pulumi.String("string"),
    },
    },
    Project: pulumi.String("string"),
    SchematizedData: &healthcare.SchematizedDataArgs{
    Data: pulumi.String("string"),
    Error: pulumi.String("string"),
    },
    SendFacility: pulumi.String("string"),
    SendTime: pulumi.String("string"),
    })
    
    var messageResource = new Message("messageResource", MessageArgs.builder()
        .datasetId("string")
        .hl7V2StoreId("string")
        .data("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .messageType("string")
        .name("string")
        .patientIds(PatientIdArgs.builder()
            .type("string")
            .value("string")
            .build())
        .project("string")
        .schematizedData(SchematizedDataArgs.builder()
            .data("string")
            .error("string")
            .build())
        .sendFacility("string")
        .sendTime("string")
        .build());
    
    message_resource = google_native.healthcare.v1.Message("messageResource",
        dataset_id="string",
        hl7_v2_store_id="string",
        data="string",
        labels={
            "string": "string",
        },
        location="string",
        message_type="string",
        name="string",
        patient_ids=[google_native.healthcare.v1.PatientIdArgs(
            type="string",
            value="string",
        )],
        project="string",
        schematized_data=google_native.healthcare.v1.SchematizedDataArgs(
            data="string",
            error="string",
        ),
        send_facility="string",
        send_time="string")
    
    const messageResource = new google_native.healthcare.v1.Message("messageResource", {
        datasetId: "string",
        hl7V2StoreId: "string",
        data: "string",
        labels: {
            string: "string",
        },
        location: "string",
        messageType: "string",
        name: "string",
        patientIds: [{
            type: "string",
            value: "string",
        }],
        project: "string",
        schematizedData: {
            data: "string",
            error: "string",
        },
        sendFacility: "string",
        sendTime: "string",
    });
    
    type: google-native:healthcare/v1:Message
    properties:
        data: string
        datasetId: string
        hl7V2StoreId: string
        labels:
            string: string
        location: string
        messageType: string
        name: string
        patientIds:
            - type: string
              value: string
        project: string
        schematizedData:
            data: string
            error: string
        sendFacility: string
        sendTime: string
    

    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.PatientId>
    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.SchematizedData
    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<PatientId>
    All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
    project String
    schematizedData SchematizedData
    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 PatientId[]
    All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.
    project string
    schematizedData SchematizedData
    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, ParsedDataResponseArgs

    PatientId, PatientIdArgs

    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, PatientIdResponseArgs

    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, SchematizedDataArgs

    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, SchematizedDataResponseArgs

    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, SegmentResponseArgs

    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
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi