Connections > FHIR connection properties
  

FHIR connection properties

When you configure a Fast Healthcare Interoperability Resources (FHIR) connection, you must configure the connection properties.
The following table describes the FHIR connection properties:
Property
Description
Connection Name
A name for the FHIR connection. This name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -
Spaces at the beginning or end of the name are trimmed and are not saved as part of the name.
Maximum length is 100 characters. Connection names are not case sensitive.
Description
Description of the FHIR connection. Maximum length is 4000 characters.
Type
Type of connection. For FHIR connection, the type must be FHIR.
Runtime Environment
Name of the runtime environment that contains the Secure Agent that you want to use to run mapping tasks.
Host
Host name or IP address of the FHIR server. It also includes the port number.
Enter the value in the following format, where host_name can be a host name or IP address:
host_name:port_number
HTTP Method
Select one of the following HTTP methods:
  • - HTTP
  • - HTTPS
Default is HTTP.
Connection Timeout
Maximum number of seconds to wait when attempting to connect to the server. A timeout occurs if a successful connection does not occur in the specified amount of time.
If the value is 0 or blank, the wait time is infinite.
Default is 30 seconds.
Keep Alive
Specify whether or not to keep the connection open for multiple HTTP requests or responses.
Default is true.
Follow Redirects
Whether or not to follow redirect links when creating a connection.
Default is true.
Connection Retry Attempts
Number of times to retry connecting to the FHIR server if a successful connection does not occur. This setting applies to both the initial connection and any reconnect attempts due to lost connections.
Default is 0. Specify 0 to disable the retry attempts.
Connection Retry Interval
Number of seconds to wait between each connection retry attempt.
For example, to retry to connect up to 10 times with a five second delay between retries, set Connection Retry Attempts to 10 and Connection Retry Interval to 5.
Default is 0.
Base Path
The base path for the FHIR server. The initial URL segment of the api.
Test Connection Resource Path
Resource path to append to the base path to test the connection.
Content Type
The media type of the request. Select one of the following options:
  • - application/fhir+xml
  • - application/fhir+josn
  • - application/xml
  • - application/json
Accept
The media type of the response. Select one of the following options:
  • - application/fhir+xml
  • - application/fhir+josn
  • - application/xml
  • - application/json
Additional Headers
Additional headers that the connection requires.
Define headers in JSON format. For example:
[{"Name":"Content-Type","Value":"application/fhir+turtle"},{"Name":"accept","Value":"text/xml"}]
Authentication Type
The authentication method that the connector must use to connect to the REST endpoint. You can use one of the following options:
Default is None.
Auth User ID
The user name to log in to the web service application when you select the Basic authentication type.
Auth Password
The password associated with the user name when you select Basic authentication.
Trust Store File Path
The absolute path of the truststore file that contains the TLS certificate to establish a one-way or two-way secure connection with the REST API.
Ensure that the truststore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
Trust Store Password
The password for the truststore file that contains the SSL certificate.
Key Store File Path
The absolute path of the keystore file that contains the keys and certificates required to establish a two-way secure communication with the REST API.
Ensure that the keystore file is in .jks format. Specify a directory path that is available on each Secure Agent machine in the runtime environment.
Key Store Password
The password for the keystore file required for secure communication.
Proxy Type
Type of proxy.
You can select one of the following options:
  • - No Proxy. Bypasses the proxy server configured at the agent or the connection level.
  • - Platform Proxy. Considers proxy configured at the agent level.
  • - Custom Proxy. Considers proxy configured at the connection level.
Proxy is not applicable when you a serverless runtime environment.
Proxy Config
Host name or IP address of the proxy server. It also includes the port number.
Enter the value in the following format, where host_name can be a host name or IP address:
host_name:port_number