On this page:

34.67 LDAP Authentication 34.69 Narrative Generator

34.68Lucene FullText Indexing

The Lucene FullText Indexing configuration category includes the following configurable options:

Lucene Index Directory
ElasticSearch Password
ElasticSearch URL protocol. Either http or https
ElasticSearch URL
ElasticSearch Username
Enable FullText Content Index
Enable Terminology Index
Lucene Indexing Provider
Lucene Indexing Enabled

34.68.1Property: Lucene Index Directory

Property Name	Lucene Index Directory
Property Key
Property Type	LOCAL_FILEDIR
Description	This is the local directory where Lucene will put its index files when operating in `LUCENE_DISK` mode. This can be an absolute path, or a relative path (treated as relative to the base of the Smile CDR installation).
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.db.hibernate_search.directory =`

34.68.2Property: ElasticSearch Password

Property Name	ElasticSearch Password
Property Key
Property Type	PASSWORD
Description	The password to use for connections to the ElasticSearch cluster.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.db.hibernate_search.elasticsearch.password =`

34.68.3Property: ElasticSearch URL protocol. Either http or https

Property Name	ElasticSearch URL protocol. Either http or https
Property Key
Property Type	STRING
Description	Whether the server to be connected to uses http or https.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`http`
Example Property	`module.[MODULE_ID].config.db.hibernate_search.elasticsearch.protocol = http`

34.68.4Property: ElasticSearch URL

Property Name	ElasticSearch URL
Property Key
Property Type	STRING
Description	The connection URL to use for connections to the ElasticSearch cluster.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`http://localhost:9090`
Example Property	`module.[MODULE_ID].config.db.hibernate_search.elasticsearch.url = http://localhost:9090`

34.68.5Property: ElasticSearch Username

Property Name	ElasticSearch Username
Property Key
Property Type	STRING
Description	The username to use for connections to the ElasticSearch cluster.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.db.hibernate_search.elasticsearch.username =`

34.68.6Property: Enable FullText Content Index

Property Name	Enable FullText Content Index
Property Key
Property Type	BOOLEAN
Description	Should the system index FullText Content on the resources stored in the repository. See Indexes for more information.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`false`
Example Property	`module.[MODULE_ID].config.db.hibernate_search.index.fulltext_content = false`

34.68.7Property: Enable Terminology Index

Property Name	Enable Terminology Index
Property Key
Property Type	BOOLEAN
Description	Should the system index terminology (i.e. CodeSystem) content in the Lucene Index. See Indexes for more information.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`true`
Example Property	`module.[MODULE_ID].config.db.hibernate_search.index.terminology = true`

34.68.8Property: Lucene Indexing Provider

Property Name	Lucene Indexing Provider
Property Key
Property Type	ENUM
Values	`LUCENE_DISK` `LUCENE_MEMORY` `ELASTICSEARCH`
Description	Specifies which provider will be used. See Lucene Providers for information on the available options.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`LUCENE_DISK`
Example Property	`module.[MODULE_ID].config.db.hibernate_search.mode = LUCENE_DISK`

34.68.9Property: Lucene Indexing Enabled

Property Name	Lucene Indexing Enabled
Property Key
Property Type	BOOLEAN
Description	If enabled, Lucene will be used for indexing (default is disabled). Lucene can be used to provide fulltext searching, and enhances the capabilities of the Smile CDR Terminology Services.
Applies to Modules	FHIR Storage (DSTU2 Relational) FHIR Storage (R3 Relational) FHIR Storage (R4 Relational)
Default Value	`false`
Example Property	`module.[MODULE_ID].config.lucene.enabled = false`

34.67 LDAP Authentication 34.69 Narrative Generator