49.42    Capability Statement 49.44    Consent Service   

49.43.1FHIR Configuration

 

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

  • Load Meta.source information from Legacy Table

  • 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

49.43.2Property: Cascading Deletes Enabled

 
Property Name Cascading Deletes Enabled
Property Key
Property Type BOOLEAN
Description Enable this setting to permit cascading deletes across resource references. See Cascading Deletes for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.cascading_delete.enabled = false

49.43.3Property: Allow External References Enabled

 
Property Name Allow External References Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.allow_external_references.enabled = false

49.43.4Property: Allow Inline Match URL References Enabled

 
Property Name Allow Inline Match URL References Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.allow_inline_match_url_references.enabled = true

49.43.5Property: Allow Multiple Delete Enabled

 
Property Name Allow Multiple Delete Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.allow_multiple_delete.enabled = false

49.43.6Property: Allow storing all bundle types

 
Property Name Allow storing all bundle types
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.allow_storing_all_bundle_types = false

49.43.7Property: Auto-Create Placeholder Reference Targets

 
Property Name Auto-Create Placeholder Reference Targets
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.auto_create_placeholder_reference_targets.enabled = false

49.43.8Property: Client ID Mode

 
Property Name Client ID Mode
Property Key
Property Type ENUM
Values
  • NOT_ALLOWED
  • ALPHANUMERIC
  • ANY
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value ALPHANUMERIC
Example Property
module.[MODULE_ID].config.dao_config.client_id_mode = ALPHANUMERIC

49.43.9Property: Delete Child Resource Count

 
Property Name Delete Child Resource Count
Property Key
Property Type NON_NEGATIVE_INTEGER
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value 60
Example Property
module.[MODULE_ID].config.dao_config.delete_child_resource.count = 60

49.43.10Property: Delete Expunge Enabled

 
Property Name Delete Expunge Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.delete_expunge_enabled = false

49.43.11Property: Enforce Reference Target Types

 
Property Name Enforce Reference Target Types
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.enforce_reference_target_types = true

49.43.12Property: Disable Deletion Ref Checks for Paths

 
Property Name Disable Deletion Ref Checks for Paths
Property Key
Property Type STRING_MULTILINE
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value (no default)
Example Property
module.[MODULE_ID].config.dao_config.enforce_referential_integrity_on_delete.disable_for_paths = 

49.43.13Property: Enforce Referential Integrity on Delete

 
Property Name Enforce Referential Integrity on Delete
Property Key
Property Type BOOLEAN
Description 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
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.enforce_referential_integrity_on_delete.enabled = true

49.43.14Property: Enforce Referential Integrity on Write

 
Property Name Enforce Referential Integrity on Write
Property Key
Property Type BOOLEAN
Description 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
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.enforce_referential_integrity_on_write.enabled = true

49.43.15Property: Expunge Operation Enabled

 
Property Name Expunge Operation Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.expunge_operation_enabled = false

49.43.16Property: History Rewrite

 
Property Name History Rewrite
Property Key
Property Type BOOLEAN
Description Enables editing of historical versions of the resource without creating new versions.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.history_rewrite.enabled = false

49.43.17Property: Batch Job Fasttracking Enabled

 
Property Name Batch Job Fasttracking Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.job_fasttracking_enabled = false

49.43.18Property: Load Meta.source information from Legacy Table

 
Property Name Load Meta.source information from Legacy Table
Property Key
Property Type BOOLEAN
Description This setting causes Smile CDR to load values for the Resource.neta.source value from a legacy table, where it was stored prior to Smile CDR 2023.08.R01. See Resource Meta Source Migration for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.load_store_source_information_from_legacy_table = false

49.43.19Property: Mark Resources for Reindexing after SearchParameter change

 
Property Name Mark Resources for Reindexing after SearchParameter change
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.mark_resources_for_reindexing_after_sp_change = false

49.43.20Property: Preserve request ID in resource body.

 
Property Name Preserve request ID in resource body.
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.dao_config.preserve_request_id_in_resource_body = false

49.43.21Property: Preserve Resource History

 
Property Name Preserve Resource History
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.preserve_resource_history.enabled = true

49.43.22Property: Reindex Enabled

 
Property Name Reindex Enabled
Property Key
Property Type BOOLEAN
Description If set to true (default is true), the $reindex operation will be permitted on this server.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value true
Example Property
module.[MODULE_ID].config.dao_config.reindex_enabled = true

49.43.23Property: Server ID Mode

 
Property Name Server ID Mode
Property Key
Property Type ENUM
Values
  • SEQUENTIAL_NUMERIC
  • UUID
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value SEQUENTIAL_NUMERIC
Example Property
module.[MODULE_ID].config.dao_config.server_id_mode = SEQUENTIAL_NUMERIC

49.43.24Property: Store Meta.source information

 
Property Name Store Meta.source information
Property Key
Property Type ENUM
Values
  • NONE
  • SOURCE_URI
  • REQUEST_ID
  • SOURCE_URI_AND_REQUEST_ID
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value SOURCE_URI_AND_REQUEST_ID
Example Property
module.[MODULE_ID].config.dao_config.store_source_information = SOURCE_URI_AND_REQUEST_ID

49.43.25Property: Tag Storage Mode

 
Property Name Tag Storage Mode
Property Key
Property Type ENUM
Values
  • VERSIONED
  • NON_VERSIONED
  • INLINE
Description This setting controls how tags/profiles/security labels are stored and indexed. See Tags, Profiles and Security Labels for more information.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value NON_VERSIONED
Example Property
module.[MODULE_ID].config.dao_config.tag_storage_mode = NON_VERSIONED

49.43.26Property: Read Only Mode Enabled

 
Property Name Read Only Mode Enabled
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.read_only_mode.enabled = false

49.43.27Property: Seed Base Validation Resources

 
Property Name Seed Base Validation Resources
Property Key
Property Type BOOLEAN
Description 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.
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value false
Example Property
module.[MODULE_ID].config.seed.base_validation_resources = false
   49.42    Capability Statement 49.44    Consent Service