57.141.1FHIR Search
The FHIR Search configuration category includes the following configurable options:
-
Always use Offset Searches
-
Allow :contains Searches
-
Maximum number of codes to expand
-
Fetch Size (Default Maximum)
-
Index Contained Resources
-
Index Contained Resources Recursively
-
Index Uplifted Refchains
-
Max Includes per Page
-
Use ordinal date values for day precision searches.
-
Filter Search Parameter Enabled
-
GraphQL Enabled
-
Index Identifier.type (:of-type modifier) Enabled
-
Language Search Parameter Enabled
-
Custom names file
-
Normalized Unit Searching
-
Page Size (Default)
-
Page Size (Maximum)
-
Nickname enabled
-
Phonetic Encoder
-
Infinispan Searches Cache Name
-
Infinispan Hot Rod Protocol Version
-
Infinispan Servers
-
Infinispan Servers Password
-
Infinispan Servers Username
-
Searches Cache Storage
-
Stale Search Cleanup Interval (seconds)
-
Suppress String Indexing In Tokens
57.141.2Property: Always use Offset Searches
|
|
Always use Offset Searches |
|
|
|
| BOOLEAN | |
| In this mode, the Query Cache is completely disabled, and all searches will be executed synchronously as offset searches. Despite the lack of a query cache, this mode may yield better performance under heavy load because it avoids any database writes being performed as a part of a search. Note: Setting this property to true will prevent pagination from working with the $everything operation | |
|
|
false
|
|
|
57.141.3Property: Allow :contains Searches
|
|
Allow :contains Searches |
|
|
|
| BOOLEAN | |
If set to true, clients will be permitted to use the :contains modifier on String searches. This is a potentially slow operation so enable with caution.
|
|
|
|
false
|
|
|
57.141.4Property: Maximum number of codes to expand
|
|
Maximum number of codes to expand |
|
|
|
| POSITIVE_INTEGER | |
| Maximum number of codes that will be added to an in-memory valueset expansion. Values beyond this limit will be silently ignored. | |
|
|
1000
|
|
|
57.141.5Property: Fetch Size (Default Maximum)
|
|
Fetch Size (Default Maximum) |
|
|
|
| POSITIVE_INTEGER | |
| If set, this value determines the maximum number of results that may be returned by any single database query. Do not set this value unless you wish to truncate search results. | |
|
|
| (no default) | |
|
57.141.6Property: Index Contained Resources
|
|
Index Contained Resources |
|
|
|
| ENUM | |
| Values |
|
| If enabled, the server will generate appropriate indexes to allow chained searches to descend automatically into contained resources. See Index Contained Resources for more information. | |
|
|
DISABLED
|
|
|
57.141.7Property: Index Contained Resources Recursively
|
|
Index Contained Resources Recursively |
|
|
|
| ENUM | |
| Values |
|
If enabled, the server will generate additional indexes to allow chained searches to traverse relations from contained resources to other contained resources within the same parent resource. This has no effect unless Index Contained Resources is also enabled. See Index Contained Resources for more information.
|
|
|
|
DISABLED
|
|
|
57.141.8Property: Index Uplifted Refchains
|
|
Index Uplifted Refchains |
|
|
|
| BOOLEAN | |
| If enabled, Search Parameters containined Uplifted Refchains will be indexed. | |
|
|
false
|
|
|
57.141.9Property: Max Includes per Page
|
|
Max Includes per Page |
|
|
|
| POSITIVE_INTEGER | |
If set, this setting controls the maximum number of _include and _revinclude results that will be added to any individual FHIR search result page.
|
|
|
|
| (no default) | |
|
57.141.10Property: Use ordinal date values for day precision searches.
|
|
Use ordinal date values for day precision searches. |
|
|
|
| BOOLEAN | |
| If enabled, causes date search params with DAY precision to rely on the ordinal versions of the dates. | |
|
|
true
|
|
|
57.141.11Property: Filter Search Parameter Enabled
|
|
Filter Search Parameter Enabled |
|
|
|
| BOOLEAN | |
This setting enables the _filter search parameter. Filter is a standard FHIR search parameter that can be used to narrow down the scope of a search.
|
|
|
|
false
|
|
|
57.141.12Property: GraphQL Enabled
|
|
GraphQL Enabled |
|
|
|
| BOOLEAN | |
| If enabled, endpoints configured against this storage module will support GraphQL Queries. | |
|
|
true
|
|
|
57.141.13Property: Index Identifier.type (:of-type modifier) Enabled
|
|
Index Identifier.type (:of-type modifier) Enabled |
|
|
|
| BOOLEAN | |
This setting enabled the token search parameter modifier :of-type. This is most commonly used to search for identifiers with a given type (as opposed to a given system). Enabling this will consume a small additional amount of index space, so it should only be enabled if it will be used.
|
|
|
|
false
|
|
|
57.141.14Property: Language Search Parameter Enabled
|
|
Language Search Parameter Enabled |
|
|
|
| BOOLEAN | |
This setting enables indexing and use of the _language special search parameter, which indexes the Resource.language element in all resources.
|
|
|
|
false
|
|
|
57.141.15Property: Custom names file
|
|
Custom names file |
|
|
|
| Resource Path | |
A path to a csv file that specifies, per row, comma separated names that are similar or alike for matching algorithms. Values should be prefaced with file: or classpath:
|
|
|
|
| (no default) | |
|
57.141.16Property: Normalized Unit Searching
|
|
Normalized Unit Searching |
|
|
|
| ENUM | |
| Values |
|
| Specifies how Quantity searches support value normalization when using valid UCUM coded values. | |
|
|
NORMALIZED_QUANTITY_SEARCH_NOT_SUPPORTED
|
|
|
57.141.17Property: Page Size (Default)
|
|
Page Size (Default) |
|
|
|
| POSITIVE_INTEGER | |
This value sets the default page size for Bundle results of search and history operations.
|
|
|
|
50
|
|
|
57.141.18Property: Page Size (Maximum)
|
|
Page Size (Maximum) |
|
|
|
| POSITIVE_INTEGER | |
This value sets the maximum page size for Bundle results of search and history operations. Client requests for values larger than this will be automatically overridden by the server to use this value.
|
|
|
|
250
|
|
|
57.141.19Property: Nickname enabled
|
|
Nickname enabled |
|
|
|
| BOOLEAN | |
Search for matching nicknames using name:nickname or given:nickname e.g. Patient?given:nickname=Robert will match a Patient with first name "Bob".
|
|
|
|
| (no default) | |
|
57.141.20Property: Phonetic Encoder
|
|
Phonetic Encoder |
|
|
|
| ENUM | |
| Values |
|
| The encoder used for predefined FHIR Search Parameters named "phonetic" (e.g. the one on Patient). See Phonetic Search Parameters for more information. | |
|
|
METAPHONE
|
|
|
57.141.21Property: Infinispan Searches Cache Name
|
|
Infinispan Searches Cache Name |
|
|
|
| STRING | |
| The name of the Infinispan Searches Cache | |
|
|
| (no default) | |
|
57.141.22Property: Infinispan Hot Rod Protocol Version
|
|
Infinispan Hot Rod Protocol Version |
|
|
|
| ENUM | |
| Values |
|
| The Hot Rod Protocol Version required by your Infinispan server. Note that you will need to include an appropriate driver client JAR in the customerlib directory of your installation. | |
|
|
PROTOCOL_VERSION_23
|
|
|
57.141.23Property: Infinispan Servers
|
|
Infinispan Servers |
|
|
|
| STRING | |
| A list of semicolon separated infinispan URLS. E.g. "localhost:11223;localhost:11224" | |
|
|
| (no default) | |
|
57.141.24Property: Infinispan Servers Password
|
|
Infinispan Servers Password |
|
|
|
| PASSWORD | |
| Password to access the Infinispan servers. (Optional) | |
|
|
| (no default) | |
|
57.141.25Property: Infinispan Servers Username
|
|
Infinispan Servers Username |
|
|
|
| STRING | |
| Username to access the Infinispan servers. (Optional) | |
|
|
| (no default) | |
|
57.141.26Property: Searches Cache Storage
|
|
Searches Cache Storage |
|
|
|
| ENUM | |
| Values |
|
| When the default value is set to DATABASE, FHIR search and search result are cached in the DATABASE. When set to INFINISPAN, the caching is performed in an Infinispan instance. | |
|
|
DATABASE
|
|
|
57.141.27Property: Stale Search Cleanup Interval (seconds)
|
|
Stale Search Cleanup Interval (seconds) |
|
|
|
| POSITIVE_INTEGER | |
| This setting specifies the frequency in seconds for the polling and deletion of stale searches in the query cache. | |
|
|
60
|
|
|
57.141.28Property: Suppress String Indexing In Tokens
|
|
Suppress String Indexing In Tokens |
|
|
|
| BOOLEAN | |
This setting globally disables the indexing of the :text modifier for token search parameters. Disabling this setting can free up a lot of index space on some systems. See Index Text on Tokens for more information.
|
|
|
|
false
|
|
|