On this page:
   35.58    HL7 v2.x Listener Script 35.60    FHIR to HL7 v2.x Mapper Script   

35.59HL7 v2.x MLLP Listener

 

The HL7 v2.x MLLP Listener configuration category includes the following configurable options:

  • Charset: Forced

  • Charset: Respect MSH-18

  • HL7 v2.x Listener Port

  • Socket Timeout (Millis)

  • Storage Tenant Name

  • Transport Protocol

  • Unprocessable Message Handling

35.59.1Property: Charset: Forced

 
Property Name Charset: Forced
Property Key
Property Type STRING
Description If a charset is specified here (e.g. ISO-8859-1 or UTF-8), all message parsing will use the given charset. Only used for MLLP. Ignored for HL7 over HTTP.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.charset.forced = 

35.59.2Property: Charset: Respect MSH-18

 
Property Name Charset: Respect MSH-18
Property Key
Property Type BOOLEAN
Description If enabled, the Minimal Lower Level Protocol (MLLP) listener will use the charset specified in MSH-18 of a given message as the encoding to use when parsing the rest of the message. This is disabled by default as MSH-18 is often incorrect in real world applications; however, it should be enabled in systems that are known to use it correctly. Ignored for HL/7 over HTTP.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.charset.respect_msh18 = false

35.59.3Property: HL7 v2.x Listener Port

 
Property Name HL7 v2.x Listener Port
Property Key
Property Type POSITIVE_INTEGER
Description The TCP port on which this module listens.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.port = 

35.59.4Property: Socket Timeout (Millis)

 
Property Name Socket Timeout (Millis)
Property Key
Property Type POSITIVE_INTEGER
Description The number of milliseconds that this port should block on read/write operations before flagging an error and aborting.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value 30000
Example Property
module.[MODULE_ID].config.socket_timeout.millis = 30000

35.59.5Property: Storage Tenant Name

 
Property Name Storage Tenant Name
Property Key
Property Type STRING
Description When using an HL7 v2.x Listener with a multitenant server, this setting can be used to specify the tenant name that will be used to store data from this listener.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.storage_tenant_name = 

35.59.6Property: Transport Protocol

 
Property Name Transport Protocol
Property Key
Property Type ENUM
Values
  • MLLP_OVER_TCP
  • HL7_OVER_HTTP
Description Specifies the transport used to send HL7 v2.x messages to Smile CDR. Note that most existing systems will send the MLLP protocol unless specifically configured otherwise.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value MLLP_OVER_TCP
Example Property
module.[MODULE_ID].config.transport = MLLP_OVER_TCP

35.59.7Property: Unprocessable Message Handling

 
Property Name Unprocessable Message Handling
Property Key
Property Type ENUM
Values
  • REJECT_WITH_AE
  • ACCEPT_WITH_AA
Description This setting controls how the HL7 v2.x listening endpoint should respond when a message can not be processed (e.g. due to the message being invalid, business rule failures, conversion failures, etc.). This setting does not affect behavior when Smile CDR experiences internal errors such as database connectivity failures.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value REJECT_WITH_AE
Example Property
module.[MODULE_ID].config.unprocessable_message_handling = REJECT_WITH_AE
   35.58    HL7 v2.x Listener Script 35.60    FHIR to HL7 v2.x Mapper Script