axiUm Communication API

Key Info  
Purpose:

Configure axiUm to use the axiUm Communication API.
Related Module(s):

axiUm Communication API
Accessed From:

Maintenance > System > axiUm Communication API
Window(s):

axiUm Communication API Setup
Dependencies:

None.

axiUm Communication API Window

The axiUm Communication API window allows you to configure axiUm to use the axiUm Communication API.

For more information, refer to the axiUm Hub Install/Upgrade Guide.

Field Description
Is axiUm Communication API available?

A checkbox that, when selected, indicates that CAPI is enabled.

When deselected, calls cannot be made to CAPI and all CAPI-related functionality is disabled.
URL

A text field that indicates the public URL for CAPI.
Test Connection

A button that tests the Redox connection.

Note: If not successful, confirm the axiUm Communication API configuration is correct and, if necessary, contact axiUm Professional Services.

API Key

A text field that indicates the API key supplied by axiUm Professional Services.

Note: This is only required if using Carequality or Consistency of Care.
Source Secret

A text field that indicates the source secret supplied by axiUm Professional Services.

Note: This is only required if using Carequality or Consistency of Care.
Verification Token

A text field that indicates the verification token supplied by axiUm Professional Services.
Time Zone

A text field that indicates your country and time zone.
Task Procedure
Configure axiUm Communication API
  1. Complete/modify the fields as necessary.
  2. (Optional) Click the Test Connection button to confirm the connection is successful.
  3. Click OK to save your changes.