gcp_healthcare_hl7_v2_store

ancestors

Type: UNORDERED_LIST_STRING

labels

Type: UNORDERED_LIST_STRING

name

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

notification_configs

Type: UNORDERED_LIST_STRUCT
Provider name: notificationConfigs
Description: Optional. 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.

• filter
  Type: STRING
  Provider name: filter
  Description: Optional. 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":*.
  
• pubsub_topic
  Type: STRING
  Provider name: pubsubTopic
  Description: 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, service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, 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).
  

organization_id

Type: STRING

parent

Type: STRING

parser_config

Type: STRUCT
Provider name: parserConfig
Description: Optional. The configuration for the parser. It determines how the server parses the messages.

• allow_null_header
  Type: BOOLEAN
  Provider name: allowNullHeader
  Description: Optional. Determines whether messages with no header are allowed.
  
• schema
  Type: STRUCT
  Provider name: schema
  Description: Optional. Schemas used to parse messages in this store, if schematized parsing is desired.
  
  • ignore_min_occurs
    Type: BOOLEAN
    Provider name: ignoreMinOccurs
    Description: Optional. Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.
    
  • schemas
    Type: UNORDERED_LIST_STRUCT
    Provider name: schemas
    Description: Optional. 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.
    
    • version
      Type: UNORDERED_LIST_STRUCT
      Provider name: version
      Description: Each VersionSource is tested and only if they all match is the schema used for the message.
      
      • msh_field
        Type: STRING
        Provider name: mshField
        Description: The field to extract from the MSH segment. For example, “3.1” or “18[1].1”.
        
      • value
        Type: STRING
        Provider name: value
        Description: The value to match with the field. For example, “My Application Name” or “2.3”.
        
  • schematized_parsing_type
    Type: STRING
    Provider name: schematizedParsingType
    Description: Optional. Determines how messages that fail to parse are handled.
    Possible values:
    
    • SCHEMATIZED_PARSING_TYPE_UNSPECIFIED - Unspecified schematized parsing type, equivalent to SOFT_FAIL.
      
    • SOFT_FAIL - Messages that fail to parse are still stored and ACKed but a parser error is stored in place of the schematized data.
      
    • HARD_FAIL - Messages that fail to parse are rejected from ingestion/insertion and return an error code.
      
  • types
    Type: UNORDERED_LIST_STRUCT
    Provider name: types
    Description: Optional. 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.
    
    • type
      Type: UNORDERED_LIST_STRUCT
      Provider name: type
      Description: The HL7v2 type definitions.
      
      • fields
        Type: UNORDERED_LIST_STRUCT
        Provider name: fields
        Description: The (sub) fields this type has (if not primitive).
        
        • max_occurs
          Type: INT32
          Provider name: maxOccurs
          Description: The maximum number of times this field can be repeated. 0 or -1 means unbounded.
          
        • min_occurs
          Type: INT32
          Provider name: minOccurs
          Description: The minimum number of times this field must be present/repeated.
          
        • name
          Type: STRING
          Provider name: name
          Description: The name of the field. For example, “PID-1” or just “1”.
          
        • table
          Type: STRING
          Provider name: table
          Description: The HL7v2 table this field refers to. For example, PID-15 (Patient’s Primary Language) usually refers to table “0296”.
          
        • type
          Type: STRING
          Provider name: type
          Description: The type of this field. A Type with this name must be defined in an Hl7TypesConfig.
          
      • name
        Type: STRING
        Provider name: name
        Description: The name of this type. This would be the segment or datatype name. For example, “PID” or “XPN”.
        
      • primitive
        Type: STRING
        Provider name: primitive
        Description: If this is a primitive type then this field is the type of the primitive For example, STRING. Leave unspecified for composite types.
        Possible values:
        
        • PRIMITIVE_UNSPECIFIED - Not a primitive.
          
        • STRING - String primitive.
          
        • VARIES - Element that can have unschematized children.
          
        • UNESCAPED_STRING - Like STRING, but all delimiters below this element are ignored.
          
    • version
      Type: UNORDERED_LIST_STRUCT
      Provider name: version
      Description: The version selectors that this config applies to. A message must match ALL version sources to apply.
      
      • msh_field
        Type: STRING
        Provider name: mshField
        Description: The field to extract from the MSH segment. For example, “3.1” or “18[1].1”.
        
      • value
        Type: STRING
        Provider name: value
        Description: The value to match with the field. For example, “My Application Name” or “2.3”.
        
  • unexpected_segment_handling
    Type: STRING
    Provider name: unexpectedSegmentHandling
    Description: Optional. Determines how unexpected segments (segments not matched to the schema) are handled.
    Possible values:
    
    • UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED - Unspecified handling mode, equivalent to FAIL.
      
    • FAIL - Unexpected segments fail to parse and return an error.
      
    • SKIP - Unexpected segments do not fail, but are omitted from the output.
      
    • PARSE - Unexpected segments do not fail, but are parsed in place and added to the current group. If a segment has a type definition, it is used, otherwise it is parsed as VARIES.
      
• version
  Type: STRING
  Provider name: version
  Description: 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.
  Possible values:
  
  • PARSER_VERSION_UNSPECIFIED - Unspecified parser version, equivalent to V1.
    
  • V1 - The parsed_data includes every given non-empty message field except the Field Separator (MSH-1) field. As a result, the parsed MSH segment starts with the MSH-2 field and the field numbers are off-by-one with respect to the HL7 standard.
    
  • V2 - The parsed_data includes every given non-empty message field.
    
  • V3 - This version is the same as V2, with the following change. The parsed_data contains unescaped escaped field separators, component separators, sub-component separators, repetition separators, escape characters, and truncation characters. If schema is specified, the schematized parser uses improved parsing heuristics compared to previous versions.
    

project_id

Type: STRING

project_number

Type: STRING

reject_duplicate_message

Type: BOOLEAN
Provider name: rejectDuplicateMessage
Description: Optional. 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.

resource_name

Type: STRING

tags

Type: UNORDERED_LIST_STRING