On this page:
   34.56    FHIR to HL7 v2.x Mapper Script 34.58    HTTP Access Log   

34.57HL7 v2.x MLLP Sender

 

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

  • Delay Between Failed Deliveries (millis)

  • HL7 v2.x Destination Host

  • Map Identifiers using NamingSystem

  • Request Path

  • HL7 v2.x Destination Port

  • Retry message on NAK

  • Send Timeout (millis)

  • Transport Protocol

  • Use Persisted Message Headers

34.57.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

34.57.2Property: 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 = 

34.57.3Property: Map Identifiers using NamingSystem

 
Property Name Map Identifiers using NamingSystem
Property Key
Property Type BOOLEAN
Description If enabled, the FHIR -> HL7 v2.x mapper will attempt to use NamingSystem resources stored in the repository when mapping identifiers. See NamingSystem Mapping for information on this process.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.map_identifiers_using_namingsystem = false

34.57.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 = /

34.57.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
  • HL7 v2.x Sending Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.port = 

34.57.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

34.57.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

34.57.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 Sending Endpoint
Default Value MLLP_OVER_TCP
Example Property
module.[MODULE_ID].config.transport = MLLP_OVER_TCP

34.57.9Property: Use Persisted Message Headers

 
Property Name Use Persisted Message Headers
Property Key
Property Type BOOLEAN
Description If enabled, this setting causes the FHIR HL7 v2.x mapper to attempt to load a MessageHeader resource from FHIR Storage for use in populating the MSH segment on the generated HL7 v2.x message.
Applies to Modules
  • HL7 v2.x Sending Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.use_persisted_message_headers = false
   34.56    FHIR to HL7 v2.x Mapper Script 34.58    HTTP Access Log