Smile CDR v2023.11.PRE
On this page:
   43.83    HL7 v2.x Listener Script
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.85    HL7 v2.x MLLP Sender   
       Table of Contents

    HL7 v2.x MLLP Listener

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

    • Non-standard segment behaviour

    • HL7 v2.x Listener Port

    • Socket Timeout (Millis)

    • Storage Tenant Name

    • Transport Protocol

    • Unprocessable Message Handling

    43.84.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
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.charset.forced =

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

    43.84.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
    Default Value false
    Example Property 
    module.[MODULE_ID].config.intermediate_logging_enabled = false

    43.84.5Property: 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
    Default Value ADD_INLINE
    Example Property 
    module.[MODULE_ID].config.non_standard_segment_behaviour = ADD_INLINE

    43.84.6Property: 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
    • 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 Sending Endpoint
    • Hybrid Providers REST Endpoint
    • JSON Admin API
    • MDM UI
    • Package Registry Endpoint
    • Payer to Payer
    • SMART Outbound Security
    • Subscription Websocket Endpoint
    • appSphere
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.port =

    43.84.7Property: 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

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

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

    43.84.10Property: 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
       43.83    HL7 v2.x Listener Script
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.85    HL7 v2.x MLLP Sender