Smile CDR v2024.08.PRE

On this page:

46.87 HL7 v2.x Listener Script 46.89 HL7 v2.x MLLP Listener

46.88.1HL7 v2.x Listening Endpoint

The HL7 v2.x Listening Endpoint configuration category includes the following configurable options:

Intermediate Logging Enabled
Non-standard segment behaviour
Storage Tenant Name
Transport Protocol
Unprocessable Message Handling

46.88.2Property: 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`

46.88.3Property: 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`

46.88.4Property: 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 =`

46.88.5Property: 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. All HTTP configuration sections are ignored for MLLP over TCP. MLLP Listener configuration ignored for HL7 over HTTP.
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`

46.88.6Property: 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`

46.87 HL7 v2.x Listener Script 46.89 HL7 v2.x MLLP Listener