Smile CDR v2023.11.PRE
On this page:
   43.99    Lucene FullText Indexing
  • 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 Payer to Payer
  • 43.105 Prior Authorization Coverage Requirement Discovery
  • 43.106 Privacy Security Notice
  • 43.107 Provenance Injection
  • 43.108 Realtime Export
  • 43.109 Endpoint Validation: Request Validating
  • 43.110 Scheduler Configuration
  • 43.111 Search Parameter Seeding
  • 43.112 SAML Provider
  • 43.113 Security Inbound Script
  • 43.114 Inbound SMART on FHIR Authentication
  • 43.115 Inbound SMART on FHIR Endpoints
  • 43.116 OAuth2/OIDC Federation
  • 43.117 SMART Callback Script
  • 43.118 Cross-Organizational Data Access Profile
  • 43.119 SMART Login Skin
  • 43.120 SMART Login Terms of Service
  • 43.121 SMART Authorization
  • 43.122 SMART Definitions Seeding
  • 43.123 Sessions
  • 43.124 Two Factor Authentication
  • 43.125 TLS / SSL (Encryption)
  • 43.126 Transaction Log
  • 43.127 Trusted Client
  • 43.128 User Self Registration
    • 43.101    Narrative Generator   
       Table of Contents

    MDM

    43.100.1MDM

     

    The MDM configuration category includes the following configurable options:

    • Auto Delete Golden Resources

    • Block List Rules File

    • Block List Rules

    • MDM Consumer Thread Count

    • Golden Resource Partition

    • Interceptor Bean Types

    • MDM Partition Key Generator Script (File)

    • MDM Partition Key Generator Script (Text)

    • MDM Identifier Code

    • MDM Identifier CodeSystem URL

    • MDM Partition Key generator type

    • Prevent modification of External EIDs

    • Prevent multiple EIDs from existing simultaneously on a target resource

    • MDM Rule Definition Script (File)

    • MDM Rule Definition Script (Text)

    • Search All Partitions For Matches

    • MDM Survivorship Script (File)

    • MDM Survivorship Script (Text)

    43.100.2Property: Auto Delete Golden Resources

     
    Property Name Auto Delete Golden Resources
    Property Key
    Property Type BOOLEAN
    Description When set to true, golden resources will automatically be permanently deleted if its final MATCH link is deleted.
    Applies to Modules
    • MDM
    Default Value true
    Example Property 
    module.[MODULE_ID].config.auto_delete_golden_resources = true

    43.100.3Property: Block List Rules File

     
    Property Name Block List Rules File
    Property Key
    Property Type Resource Path
    Description Provides a file with rules that determine which resources will be omitted from MDM matching. If provided, this file will be used instead of the raw json. Values should be prefaced with file: or classpath:.
    Applies to Modules
    • MDM
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.block_list.file =

    43.100.4Property: Block List Rules

     
    Property Name Block List Rules
    Property Key
    Property Type JSON
    Description Provides a list of rules that determine which resources will be omitted from MDM matching. If a file is provided, the file will take precedence over these values.
    Applies to Modules
    • MDM
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.block_list.text =

    43.100.5Property: MDM Consumer Thread Count

     
    Property Name MDM Consumer Thread Count
    Property Key
    Property Type POSITIVE_INTEGER
    Description Number of concurrent threads dedicated to matching incoming target resource and Golden resource. Experimental new feature under development.
    Applies to Modules
    • EMPI (deprecated)
    • MDM
    Default Value 1
    Example Property 
    module.[MODULE_ID].config.consumer_count = 1

    43.100.6Property: Golden Resource Partition

     
    Property Name Golden Resource Partition
    Property Key
    Property Type STRING
    Description If set, golden resources will be stored in the specified partition regardless of the partition of the original resource.
    Applies to Modules
    • MDM
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.golden_resource_partition =

    43.100.7Property: Interceptor Bean Types

     
    Property Name Interceptor Bean Types
    Property Key
    Property Type STRING
    Description A comma-separated list of bean classes (fully qualified names) to register as HAPI FHIR/Smile CDR Interceptors.
    Applies to Modules
    • CDA Exchange V2
    • Channel Import
    • Cluster Manager
    • 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)
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • HL7 v2.x Listening Endpoint
    • Hybrid Providers REST Endpoint
    • MDM
    • Subscription Matcher (All FHIR Versions)
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.interceptor_bean_types =

    43.100.8Property: MDM Partition Key Generator Script (File)

     
    Property Name MDM Partition Key Generator Script (File)
    Property Key
    Property Type Resource Path
    Description If set, supplies the absolute filepath of a file containing a javascript function providing kafka partition keys used by the MDM service. Values should be prefixed with file: or classpath:.
    Applies to Modules
    • MDM
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.key_interceptor_script.file =

    43.100.9Property: MDM Partition Key Generator Script (Text)

     
    Property Name MDM Partition Key Generator Script (Text)
    Property Key
    Property Type JAVASCRIPT
    Description If set, supplies a javascript function providing kafka partition keys used by the MDM service.
    Applies to Modules
    • MDM
    Default Value function mdmGenerateMessageKey(targetRec, goldenRec, txContext) { // }
    Example Property 
    module.[MODULE_ID].config.key_interceptor_script.text = function mdmGenerateMessageKey(targetRec, goldenRec, txContext) {
  //
}

    43.100.10Property: MDM Identifier Code

     
    Property Name MDM Identifier Code
    Property Key
    Property Type STRING
    Description MDM Identifier Code in use for Unique Member ID. For example: um
    Applies to Modules
    • Payer to Payer
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.mdm.identifier.code =

    43.100.11Property: MDM Identifier CodeSystem URL

     
    Property Name MDM Identifier CodeSystem URL
    Property Key
    Property Type STRING
    Description MDM Identifier CodeSystem URL in use for Unique Member ID. For example: http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType
    Applies to Modules
    • Payer to Payer
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.mdm.identifier.codesystemurl =

    43.100.12Property: MDM Partition Key generator type

     
    Property Name MDM Partition Key generator type
    Property Key
    Property Type ENUM
    Values
    • EID
    • JAVASCRIPT
    Description Indicates the way to generate kafka partition keys. Valid options are EID (default) and Javascript. Javascript option requires providing a MDM Partition Key Generator Script using MDM Partition Key Script Text or MDM Partition Key Script File properties.
    Applies to Modules
    • MDM
    Default Value EID
    Example Property 
    module.[MODULE_ID].config.mdm_key_interceptor_type = EID

    43.100.13Property: Prevent modification of External EIDs

     
    Property Name Prevent modification of External EIDs
    Property Key
    Property Type BOOLEAN
    Description If enabled, MDM Enterprise Identifiers (EIDs) may not be modified once set on a target resource.
    Applies to Modules
    • EMPI (deprecated)
    • MDM
    Default Value true
    Example Property 
    module.[MODULE_ID].config.prevent_eid_updates = true

    43.100.14Property: Prevent multiple EIDs from existing simultaneously on a target resource

     
    Property Name Prevent multiple EIDs from existing simultaneously on a target resource
    Property Key
    Property Type BOOLEAN
    Description If enabled, target resource creates and updates will be rejected if they contain multiple Enterprise Identifiers (EIDs).
    Applies to Modules
    • EMPI (deprecated)
    • MDM
    Default Value true
    Example Property 
    module.[MODULE_ID].config.prevent_multiple_eids = true

    43.100.15Property: MDM Rule Definition Script (File)

     
    Property Name MDM Rule Definition Script (File)
    Property Key
    Property Type Resource Path
    Description If set, supplies the absolute filepath of a file containing a set of MDM rules used by the MDM service. Values should be prefixed with file: or classpath:.
    Applies to Modules
    • EMPI (deprecated)
    • MDM
    • Realtime Export
    • Scripted Inbound Security
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.script.file =

    43.100.16Property: MDM Rule Definition Script (Text)

     
    Property Name MDM Rule Definition Script (Text)
    Property Key
    Property Type JAVASCRIPT
    Description If set, supplies a set of MDM rules used by the MDM service.
    Applies to Modules
    • EMPI (deprecated)
    • MDM
    • Realtime Export
    • Scripted Inbound Security
    Default Value { "version": 1, "mdmTypes": [], "candidateSearchParams": [], "candidateFilterSearchParams": [], "matchFields": [], "matchResultMap": {}, "eidSystem": "http://hl7.org/fhir/sid/us-ssn" }
    Example Property 
    module.[MODULE_ID].config.script.text = {
"version": 1,
"mdmTypes": [],
"candidateSearchParams": [],
"candidateFilterSearchParams": [],
"matchFields": [],
"matchResultMap": {},
"eidSystem": "http://hl7.org/fhir/sid/us-ssn"
}

    43.100.17Property: Search All Partitions For Matches

     
    Property Name Search All Partitions For Matches
    Property Key
    Property Type BOOLEAN
    Description If set, resources will search for matches in all partitions.
    Applies to Modules
    • MDM
    Default Value false
    Example Property 
    module.[MODULE_ID].config.search_all_partition = false

    43.100.18Property: MDM Survivorship Script (File)

     
    Property Name MDM Survivorship Script (File)
    Property Key
    Property Type Resource Path
    Description If set, supplies the absolute filepath of a file containing a set of MDM survivorship rules used by the MDM service. Values should be prefixed with file: or classpath:.
    Applies to Modules
    • MDM
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.survivorship_script.file =

    43.100.19Property: MDM Survivorship Script (Text)

     
    Property Name MDM Survivorship Script (Text)
    Property Key
    Property Type JAVASCRIPT
    Description If set, supplies a set of MDM survivorship rules used by the MDM service.
    Applies to Modules
    • MDM
    Default Value function mdmApplySurvivorshipRules(targetRec, goldenRec, txContext) { // }
    Example Property 
    module.[MODULE_ID].config.survivorship_script.text = function mdmApplySurvivorshipRules(targetRec, goldenRec, txContext) {
  //
}
       43.99    Lucene FullText Indexing
  • 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 Payer to Payer
  • 43.105 Prior Authorization Coverage Requirement Discovery
  • 43.106 Privacy Security Notice
  • 43.107 Provenance Injection
  • 43.108 Realtime Export
  • 43.109 Endpoint Validation: Request Validating
  • 43.110 Scheduler Configuration
  • 43.111 Search Parameter Seeding
  • 43.112 SAML Provider
  • 43.113 Security Inbound Script
  • 43.114 Inbound SMART on FHIR Authentication
  • 43.115 Inbound SMART on FHIR Endpoints
  • 43.116 OAuth2/OIDC Federation
  • 43.117 SMART Callback Script
  • 43.118 Cross-Organizational Data Access Profile
  • 43.119 SMART Login Skin
  • 43.120 SMART Login Terms of Service
  • 43.121 SMART Authorization
  • 43.122 SMART Definitions Seeding
  • 43.123 Sessions
  • 43.124 Two Factor Authentication
  • 43.125 TLS / SSL (Encryption)
  • 43.126 Transaction Log
  • 43.127 Trusted Client
  • 43.128 User Self Registration
    • 43.101    Narrative Generator