ODBC Driver for FHIR

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection settings for this provider.


PropertyDescription
APIFieldsNameSeparatorDefine the separator of compound filed names in your FHIR Server.
PaginationLimitNameThe PaginationLimitName is used for defining a different name for the limit property in the limit-offset pagination.
PaginationModeThe type of pagination implemented by the FHIR server. The default value is NextLink.
PaginationOffsetNameDefine a different name for offset property in the limit-offset pagination.
PaginationSnapshotNameDefine the name for the property that identifies the current request snapshot identifier.
ContentTypeThe format used for accessing your FHIR Server data. The available values are: XML or JSON.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ConnectOnOpenSpecifies whether the provider establishes a connection to FHIR immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
CustomHeadersSpecifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PageSizeThe maximum size of records returned per page.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
SupportsPostSearchRequestsIndicates whether or not the FHIR Server supports sending URL search params in a POST request body using the 'application/x-www-form-urlencoded' ContentType Header. Note: The InterSystems IRIS for Health does not support search with Post.
SupportsServerSideLastUpdatedFilterIndicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: https://build.fhir.org/search.html#_lastUpdated .
SupportsServerSideSortingIndicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: http://hl7.org/fhir/search.html#_sort .
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434