Smile CDR v2023.02.PRE
On this page:
   39.68    HL7 v2.x MLLP Listener 39.70    FHIR to HL7 v2.x Mapper Script   

39.69HL7 v2.x MLLP Sender

 

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

  • Delay Between Failed Deliveries (millis)

  • Forward Persisted Messages

  • HL7 v2.x Destination Host

  • Request Path

  • HL7 v2.x Destination Port

  • Retry message on NAK

  • Send Timeout (millis)

  • Transport Protocol

39.69.1Property: Delay Between Failed Deliveries (millis)

 
Property Name Delay Between Failed Deliveries (millis)
Property Key
Property Type NON_NEGATIVE_INTEGER
Description If set to a number above 0, sets the minimum number of milliseconds to wait after a failed delivery attempt before trying again.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value 10000
Example Property
module.[MODULE_ID].config.delay_between_failed_deliveries.millis = 10000

39.69.2Property: Forward Persisted Messages

 
Property Name Forward Persisted Messages
Property Key
Property Type BOOLEAN
Description If enabled, sends persisted HL7 v2.x messages back out verbatim. See (Storing HL7 v2.x Messages As-Is)[/docs/hl7_v2x_support/inbound_hl7v2.html#storing-messages] for details.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.forward_persisted_messages = false

39.69.3Property: HL7 v2.x Destination Host

 
Property Name HL7 v2.x Destination Host
Property Key
Property Type STRING
Description The TCP hostname to which this module will transmit.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.host = 

39.69.4Property: Request Path

 
Property Name Request Path
Property Key
Property Type STRING
Description The path to transmit messages to. Note that this applies only to HTTP transports and will be ignored for MLLP transports.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value /
Example Property
module.[MODULE_ID].config.path = /

39.69.5Property: HL7 v2.x Destination Port

 
Property Name HL7 v2.x Destination Port
Property Key
Property Type POSITIVE_INTEGER
Description The TCP port to which this module will transmit.
Applies to Modules
  • CDS Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • FHIRWeb Console
  • HL7 v2.x Listening Endpoint
  • HL7 v2.x Sending Endpoint
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • Payer to Payer
  • SMART App Host (Deprecated)
  • SMART Outbound Security
  • Subscription Websocket Endpoint
  • appSphere
Default Value (no default)
Example Property
module.[MODULE_ID].config.port = 

39.69.6Property: Retry message on NAK

 
Property Name Retry message on NAK
Property Key
Property Type BOOLEAN
Description If the receiving system responds with a non-positive acknowledgement message (e.g an ACK message with an AE response code), should we attempt to redeliver the message until we are successful?
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value true
Example Property
module.[MODULE_ID].config.retry_message_on_nak = true

39.69.7Property: Send Timeout (millis)

 
Property Name Send Timeout (millis)
Property Key
Property Type POSITIVE_INTEGER
Description The number of milliseconds to wait for a response before timing out.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value 10000
Example Property
module.[MODULE_ID].config.send_timeout.millis = 10000

39.69.8Property: Transport Protocol

 
Property Name Transport Protocol
Property Key
Property Type ENUM
Values
  • MLLP_OVER_TCP
  • HL7_OVER_HTTP
Description Specifies the transport to use when sending HL7 v2.x messages. Note that most existing systems expect the MLLP protocol unless specifically configured otherwise.
Applies to Modules
  • HL7 v2.x Listening Endpoint
  • HL7 v2.x Sending Endpoint
Default Value MLLP_OVER_TCP
Example Property
module.[MODULE_ID].config.transport = MLLP_OVER_TCP
   39.68    HL7 v2.x MLLP Listener 39.70    FHIR to HL7 v2.x Mapper Script