FHIR Endpoint Security
The FHIR Endpoint Security configuration category includes the following configurable options:
Allow Searches With Compartment Access
Automatically Narrow Search Scope
Narrow Conditional URL Search Scope
Reject Insufficient Permissions with HTTP 401
Watermark Responses Enabled
Scopes Supported
|
|
Allow Searches With Compartment Access |
|
|
|
| BOOLEAN | |
| When disabled, the server will proactively reject searches on resource types, even though a resource in the compartment could possibly be in the results. When enabled, the searches will be accepted, but the server will filter the results to only include resources that are in the compartment. Enabling this flag is less secure, as the interceptor may leak the existence of resources that are not in the compartment. | |
|
|
false
|
|
|
|
|
Automatically Narrow Search Scope |
|
|
|
| BOOLEAN | |
When enabled, the server will automatically try to narrow the scope of searches when the user only has permission to access specific instances or compartments. For example, when a user only has the FHIR_READ_ALL_IN_COMPARTMENT/Patient/123 permission and tries to perform a search for Observation?code=foo, this search will be performed automatically as Observation?subject=Patient/123&code=foo. See Block Unless Code in ValueSet for more information. Note that in order to avoid accidental disclosure of non-narrowed resource counts, search total counts will be unavailable if this feature is enabled.
|
|
|
|
false
|
|
|
|
|
Narrow Conditional URL Search Scope |
|
|
|
| BOOLEAN | |
| When narrowing search scope, if this setting is enabled the URLs of conditional operations will also be narrowed. For example, the request URL in a Conditional Update operation or the If-None-Exist header in a Conditional Create operation will be narrowed. This setting only applies if Automatically Narrow Search Scope is also enabled. | |
|
|
false
|
|
|
|
|
Reject Insufficient Permissions with HTTP 401 |
|
|
|
| BOOLEAN | |
| If enabled, an HTTP 401 will be used instead of an HTTP 403 response for unauthorized operations. See Rejecting Unauthorized FHIR Calls for more information. | |
|
|
false
|
|
|
|
|
Watermark Responses Enabled |
|
|
|
| BOOLEAN | |
| This setting enables Response Watermarking, which injects an extension into returned resources containing several details about the access path used to retrieve the resource including the Transaction GUID, a timestamp, and the full resource fetch URL. See Response Watermarking for more information. | |
|
|
false
|
|
|
|
|
Scopes Supported |
|
|
|
| STRING | |
| A space separated list of scopes to advertise as supported in the .well-known/smart-configuration | |
|
|
openid fhirUser
|
|
|