The FHIR Configuration configuration category includes the following configurable options:
Cascading Deletes Enabled
Allow External References Enabled
Allow Inline Match URL References Enabled
Allow Multiple Delete Enabled
Allow storing all bundle types
Auto-Create Placeholder Reference Targets
Client ID Mode
Delete Child Resource Count
Delete Expunge Enabled
Enforce Reference Target Types
Disable Deletion Ref Checks for Paths
Enforce Referential Integrity on Delete
Enforce Referential Integrity on Write
Expunge Operation Enabled
History Rewrite
Batch Job Fasttracking Enabled
Mark Resources for Reindexing after SearchParameter change
Preserve request ID in resource body.
Preserve Resource History
Reindex Enabled
Server ID Mode
Store Meta.source information
Tag Storage Mode
Read Only Mode Enabled
Seed Base Validation Resources
|
|
Cascading Deletes Enabled |
|
|
|
| BOOLEAN | |
| Enable this setting to permit cascading deletes across resource references. See Cascading Deletes for more information. | |
|
|
false
|
|
|
|
|
Allow External References Enabled |
|
|
|
| BOOLEAN | |
If enabled, the server will allow resources to have references to external servers. This means (for example) that with this setting enabled, a Patient could be uploaded containing a reference to Organization http://example.com/fhir/Organization/123. With this setting disabled, only relative references (e.g. Organization/123 or absolute references corresponding to the base URL of the server are allowed.
|
|
|
|
false
|
|
|
|
|
Allow Inline Match URL References Enabled |
|
|
|
| BOOLEAN | |
If enabled, references containing match URLs will be resolved and replaced in create and update operations. For example, if a Patient is created, and the Patient.managingOrganization is set to a value of Organization?identifier=123, the server will resolve this search and replace the search URL with a correct reference before the resource is saved. This search is subjected to the same security or access control checks as other searches.
|
|
|
|
true
|
|
|
|
|
Allow Multiple Delete Enabled |
|
|
|
| BOOLEAN | |
If enabled, the server will allow delete operations that match more than one resource. For example, if this is enabled and a delete is issued for Patient?name=smith then multiple Patient resources named "smith" can be deleted. If this setting is disabled, the delete will only be allowed when only one Patient named "smith" exists. Enabling this setting can be convenient but it increases the possibility of accidental bulk deletion.
|
|
|
|
false
|
|
|
|
|
Allow storing all bundle types |
|
|
|
| BOOLEAN | |
If enabled, all Bundle types may be stored. By default with this setting disabled, only Bundle types such as document, message and collection are permitted for storage.
|
|
|
|
false
|
|
|
|
|
Auto-Create Placeholder Reference Targets |
|
|
|
| BOOLEAN | |
If this setting is enabled and a resource is created with a reference to a non-existing resource (e.g. Patient/FOO if that patient does not exist on the server), the server will automatically create an empty placeholder resource to satisfy this reference. See Auto-Create Placeholder Reference Targets for more information.
|
|
|
|
false
|
|
|
|
|
Client ID Mode |
|
|
|
| ENUM | |
| Values |
|
| This setting controls whether clients may create resources with IDs assigned by the client, and what types of IDs are acceptable. By default, clients may only supply IDs containing at least one letter. See Client Assigned IDs for more information. | |
|
|
ALPHANUMERIC
|
|
|
|
|
Delete Child Resource Count |
|
|
|
| NON_NEGATIVE_INTEGER | |
| This setting determines the maximum number of child resources that should be processed during each pass of a cascading delete. May need to be increased if deleting resources with large numbers of child resources. | |
|
|
60
|
|
|
|
|
Delete Expunge Enabled |
|
|
|
| BOOLEAN | |
If set to true (default is false), both the $delete-expunge operation and the _expunge parameter on the DELETE operation will be enabled on this server. Both of these operations remove all data associated with a resource in a highly performant way, skipping checks that are enforced with usual DELETE operations. The only check that is performed before deleting the resources and their indexes is that no other resources reference the resources about to be deleted. This operation is potentially dangerous since it allows a client to physically delete data in a way that can not be recovered (without resorting to backups). See Delete Expunge for more information.
|
|
|
|
false
|
|
|
|
|
Enforce Reference Target Types |
|
|
|
| BOOLEAN | |
| If this setting is disabled, references in resources being persisted will not be validated to ensure that the target of the reference is a valid resource type for the field containing the reference. This should generally be left enabled, but can be useful in cases where a nonstandard reference is needed. | |
|
|
true
|
|
|
|
|
Disable Deletion Ref Checks for Paths |
|
|
|
| STRING_MULTILINE | |
| If referential integrity checking is enabled for deletes, this setting may be used to selectively disable this checking only for specific paths. This setting takes one or more FHIRPath expressions, each one on a new line. See Referential Integrity for more information. | |
|
|
| (no default) | |
|
|
|
Enforce Referential Integrity on Delete |
|
|
|
| BOOLEAN | |
| If disabled, resources may be deleted even if they are referenced by other resources. See Validating References And Referential Integrity for more information. Disable with Caution | |
|
|
true
|
|
|
|
|
Enforce Referential Integrity on Write |
|
|
|
| BOOLEAN | |
| If disabled, resources may be created or updated even if they contain references to local resources that do not exist. See Validating References And Referential Integrity for more information. Disable with Caution | |
|
|
true
|
|
|
|
|
Expunge Operation Enabled |
|
|
|
| BOOLEAN | |
Enabling this setting allows the Expunge Operation ($expunge) to be performed by users with appropriate permission. Expunge is a dangerous operation so it is disabled by default.
|
|
|
|
false
|
|
|
|
|
History Rewrite |
|
|
|
| BOOLEAN | |
| Enables editing of historical versions of the resource without creating new versions. | |
|
|
false
|
|
|
|
|
Batch Job Fasttracking Enabled |
|
|
|
| BOOLEAN | |
| If enabled, the server will attempt to fast-track small batch jobs that are submitted to the server. This means that if the batch job is small, and the batch job queue is empty, the server will attempt to execute each job step immediately, rather than waiting for the next scheduled execution time (default 1 minute) before advancing the job to the next step. This setting should be disabled in production as it can lead to the batch processor geting overloaded and can lead to jobs getting stuck. It may be useful for testing small batch runs on an idle test server. | |
|
|
false
|
|
|
|
|
Mark Resources for Reindexing after SearchParameter change |
|
|
|
| BOOLEAN | |
| If enabled, the repository will automatically mark any resources which are potentially affected by a SearchParameter for reindexing when any SearchParameter is modified. This is generally desirable on new servers, but can be problematic on servers with a large amount of existing data. | |
|
|
false
|
|
|
|
|
Preserve request ID in resource body. |
|
|
|
| BOOLEAN | |
This setting indicate whether a provided Resource.meta.source request ID should be preserved or overwritten. If disabled (which is the default), any request ID supplied in this field will automatically be replaced with a new request ID. If enabled, request IDs in this field will be preserved when the resource is stored. See Storing Source Information for more information.
|
|
|
|
false
|
|
|
|
|
Preserve Resource History |
|
|
|
| BOOLEAN | |
| If disabled, when updating an existing resource the server will delete the previous version. Use this option with caution! See Disabling Resource History for more information. | |
|
|
true
|
|
|
|
|
Reindex Enabled |
|
|
|
| BOOLEAN | |
| If set to true (default is true), the $reindex operation will be permitted on this server. | |
|
|
true
|
|
|
|
|
Server ID Mode |
|
|
|
| ENUM | |
| Values |
|
| This setting controls how IDs are generated by the server for newly created resources. By default, each newly created resource will receive a sequential numeric ID but this behaviour can be changed. See Server Assigned IDs for more information. | |
|
|
SEQUENTIAL_NUMERIC
|
|
|
|
|
Store Meta.source information |
|
|
|
| ENUM | |
| Values |
|
| If enabled, values from Resource.meta.source will be stored and indexed. This may be disabled in order to save space and improve write efficiency. | |
|
|
SOURCE_URI_AND_REQUEST_ID
|
|
|
|
|
Tag Storage Mode |
|
|
|
| ENUM | |
| Values |
|
| This setting controls how tags/profiles/security labels are stored and indexed. See Tags, Profiles and Security Labels for more information. | |
|
|
NON_VERSIONED
|
|
|
|
|
Read Only Mode Enabled |
|
|
|
| BOOLEAN | |
| In this mode, the server will disable the job scheduler entirely, allowing the module to start even if it is connected to a read-only database. See Read-Only Nodes for more information. | |
|
|
false
|
|
|
|
|
Seed Base Validation Resources |
|
|
|
| BOOLEAN | |
| If enabled, validation resources such as StructureDefinitions, ValueSets, and CodeSystems will be automatically seeded into the repository on startup. This can help to speed up validation and allows clients to browse these resources. | |
|
|
false
|
|
|