Powered by Smile CDR v2024.11.PRE-32 (build 0f55813e32)

On this page:

49.87 HL7 v2.x Listening Endpoint 49.89 HL7 v2.x MLLP Sender

49.88.1HL7 v2.x MLLP Listener

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

Charset: Forced
Charset: Respect MSH-18
Intermediate Logging Enabled
HL7 v2.x MLLP Listener Port
Non-standard segment behaviour
HL7 v2.x Listener Port
Socket Timeout (Millis)
Storage Tenant Name
Transport Protocol
Unprocessable Message Handling

49.88.2Property: 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 HL7 v2.x Listening Endpoint (Deprecated)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.charset.forced =`

49.88.3Property: 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 HL7 over HTTP.
Applies to Modules	HL7 v2.x Listening Endpoint HL7 v2.x Listening Endpoint (Deprecated)
Default Value	`false`
Example Property	`module.[MODULE_ID].config.charset.respect_msh18 = false`

49.88.4Property: Intermediate Logging Enabled

Property Name	Intermediate Logging Enabled
Property Key
Property Type	BOOLEAN
Description	If enabled, additional steps in the HL7 v2.x to FHIR conversion process will appear in the transaction log. This provides insight into both the v2.x messages after any transformations have been applied, as well as the resultant FHIR transaction bundle before any transformations have been applied.
Applies to Modules	HL7 v2.x Listening Endpoint HL7 v2.x Listening Endpoint (Deprecated)
Default Value	`false`
Example Property	`module.[MODULE_ID].config.intermediate_logging_enabled = false`

49.88.5Property: HL7 v2.x MLLP Listener Port

Property Name	HL7 v2.x MLLP 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.mllp_port =`

49.88.6Property: Non-standard segment behaviour

Property Name	Non-standard segment behaviour
Property Key
Property Type	ENUM
Values	`ADD_INLINE` `DROP_TO_ROOT` `THROW_HL7_EXCEPTION`
Description	Specifies behaviour for non-standard HL7 v2.x segments (Z-Segments): determines whether they are in the root of the message or in the current segment.
Applies to Modules	HL7 v2.x Listening Endpoint HL7 v2.x Listening Endpoint (Deprecated)
Default Value	`ADD_INLINE`
Example Property	`module.[MODULE_ID].config.non_standard_segment_behaviour = ADD_INLINE`

49.88.7Property: 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	CDS Hooks REST Endpoint EasyShare SHL Endpoint (Admin) EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint HL7 v2.x Listening Endpoint (Deprecated) HL7 v2.x Sending Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer Product Portal SMART Outbound Security Subscription Websocket Endpoint appSphere
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.port =`

49.88.8Property: 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 HL7 v2.x Listening Endpoint (Deprecated)
Default Value	`30000`
Example Property	`module.[MODULE_ID].config.socket_timeout.millis = 30000`

49.88.9Property: 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 HL7 v2.x Listening Endpoint (Deprecated)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.storage_tenant_name =`

49.88.10Property: 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 HL7 v2.x Listening Endpoint (Deprecated) HL7 v2.x Sending Endpoint
Default Value	`MLLP_OVER_TCP`
Example Property	`module.[MODULE_ID].config.transport = MLLP_OVER_TCP`

49.88.11Property: 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 HL7 v2.x Listening Endpoint (Deprecated)
Default Value	`REJECT_WITH_AE`
Example Property	`module.[MODULE_ID].config.unprocessable_message_handling = REJECT_WITH_AE`

49.87 HL7 v2.x Listening Endpoint 49.89 HL7 v2.x MLLP Sender