On this page:
   24.17    FHIR Binary Storage 24.19    FHIR Consent Service   

24.18FHIR Configuration

 

The FHIR Configuration configuration category includes the following configurable options:

  • Allow Multiple Delete Enabled

  • Cascading Deletes Enabled

  • Allow Inline Match URL References Enabled

  • Allow External References Enabled

  • Enforce Referential Integrity on Write

  • Enforce Referential Integrity on Delete

  • Auto-Create Placeholder Reference Targets

  • Mark Resources for Reindexing after SearchParameter change

  • Server ID Mode

  • Client ID Mode

  • Enforce Reference Target Types

  • Expunge Operation Enabled

  • Allow storing all bundle types

  • Store Meta.source information

24.18.1Property: 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.
Default Value false
Is Optional? No

24.18.2Property: 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.
Default Value false
Is Optional? No

24.18.3Property: 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. Note that this search is not subjected to any security or access control checks, so this feature has potential security implications. Enable with caution.
Default Value false
Is Optional? No

24.18.4Property: 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.
Default Value false
Is Optional? No

24.18.5Property: 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. For example, if a patient contains a reference to managing organization Organization/FOO but FOO is not a valid ID for an organization on the server then the operation will be blocked unless this property has been disabled. This property can cause confusing results for clients of the server since searches, includes, and other FHIR features may not behave as expected when referential integrity is not preserved.

Disable with caution.

Default Value true
Is Optional? No

24.18.6Property: 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. This property can cause confusing results for clients of the server since searches, includes, and other FHIR features may not behave as expected when referential integrity is not preserved.

Disable with caution.

Default Value true
Is Optional? No

24.18.7Property: 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. Use this setting with caution, as it it generally only required in very specific scenarios.

Note that placeholder resources cannot be created if they have purely numeric IDs (e.g. Patient/123) because Smile CDR reserves these for its own internal use. Any scenarios requiring automatic creation of placeholder resources should ensure to use identifiers which have a non-numeric component.
Default Value false
Is Optional? No

24.18.8Property: Mark Resources for Reindexing after SearchParameter change

 
Property Key
Property Type BOOLEAN
Description If enabled (default), 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 can be problematic on servers with a large amount of existing data.
Default Value false
Is Optional? No

24.18.9Property: 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.
Default Value SEQUENTIAL_NUMERIC
Is Optional? No

24.18.10Property: 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.
Default Value ALPHANUMERIC
Is Optional? No

24.18.11Property: 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.
Default Value true
Is Optional? No

24.18.12Property: 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.
Default Value false
Is Optional? No

24.18.13Property: 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.
Default Value false
Is Optional? Yes

24.18.14Property: 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.
Default Value SOURCE_URI_AND_REQUEST_ID
Is Optional? No
   24.17    FHIR Binary Storage 24.19    FHIR Consent Service