Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

FHIR Connector

FHIR Connector

Connection details

Connection details

The following table describes the basic connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
FHIR
Runtime Environment
Name of the runtime environment where you want to run tasks. Select a Secure Agent group or the Hosted Agent.
Host
Host name or IP address of the FHIR server, including 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
HTTP method used to send requests.
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 doesn't 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
Indicates whether to keep the connection open for multiple HTTP requests or responses.
Default is true.
Follow Redirects
Indicates whether 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 doesn't occur. This setting applies to both the initial connection and any reconnect attempts due to lost connections.
Default is 0.
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
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
Media type of the request.
Select one of the following options:
  • application/fhir+xml
  • application/fhir+json
  • application/xml
  • application/json
Accept
Media type of the response.
Select one of the following options:
  • application/fhir+xml
  • application/fhir+json
  • 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+json"},{"Name":"accept","Value":"text/xml"}]
Authentication Type
Authentication method that the connector must use to connect to the REST endpoint.
You can use one of the following options:
Default is None.
Trust Store File Path
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
Password for the truststore file that contains the SSL certificate.
Key Store File Path
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
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 the proxy configured at the agent level.
  • Custom Proxy. Considers the proxy configured at the connection level.
Not applicable when you use a serverless runtime environment.
Proxy Config
Host name or IP address of the proxy server, including 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

0 COMMENTS

We’d like to hear from you!