Configure Connection
Healthicity guide
Obtain API access from Healthicity, configure the connection in NIM, and verify the data needed for your audit.
Before you startDirect link to Before you start
Healthicity does not provide public API integration documentation. Consult the vendor for API integration access, your tenant's connection details, and the permissions needed to read the required data.
NIM requires Tenant URL, Client ID, and Client Secret.
Request connection details from HealthicityDirect link to Request connection details from Healthicity
- Contact Healthicity to arrange API integration for your tenant.
- Obtain the Tenant URL, Client ID, and Client Secret for that integration.
- Confirm access to departments, locations, position types, and roles, as well as the time zones endpoint used by the connection test.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Healthicity system, or select the existing system.
- Open its Connection screen.
- Enter the values supplied by Healthicity and save the connection.
| NIM setting | Value |
|---|---|
| Tenant URL | Your Healthicity tenant URL, in the format supplied by the vendor. |
| Client ID | The client identifier issued for your API integration. |
| Client Secret | The secret belonging to that client identifier. |
Test access and collect dataDirect link to Test access and collect data
- Select Test Connection. NIM calls
GET /api/v3/time_zoneson the configured tenant. - Confirm the test succeeds. If it fails, verify the Tenant URL and credentials, and ask Healthicity to confirm API access for the integration.
- Collect the system and inspect Departments, Locations, PositionTypes, and Roles.
- Confirm that the expected records are present before using the data in filters or audit reports.
The connection test checks access to time zone data. Validate collection of the other tables separately to confirm that the integration can read the information your audit requires.
Step 1 of 3