Configure Connection

HealthStream guide

Request API access through the hStream Developer Portal, configure the connection in NIM, and verify access to organization roles.

Before you startDirect link to Before you start

API access requires an account requested through the hStream Developer Portal. HealthStream provides a Request Access option and access to API documentation through the portal.

NIM requires Tenant URL, Client Key, Client Secret, Org ID, and Institution ID. Obtain the values for the HealthStream organization and institution your student provisioning process will manage.

Obtain the integration account and settingsDirect link to Obtain the integration account and settings

Open the hStream Developer Portal access page and select Request Access to request an account.
After access is granted, sign in to the developer portal with your hStream ID and review the API documentation for your integration.
Obtain the Tenant URL, Client Key, Client Secret, Org ID, and Institution ID. Consult HealthStream if you need help locating these values or enabling the required API access.
Confirm that the integration has access to organization roles and the student operations you intend to use.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a HealthStream system, or select the existing system.
Open its Connection screen.
Enter the following values and save the connection.

NIM setting	Value
Tenant URL	The HealthStream tenant URL supplied for your integration.
Client Key	The client key issued for your API integration.
Client Secret	The secret belonging to that client key.
Org ID	The identifier of the HealthStream organization NIM will access.
Institution ID	The identifier of the HealthStream institution NIM will manage.

Test organization role accessDirect link to Test organization role access

Select Test Connection. NIM requests organization roles through this endpoint on the configured tenant:
```
GET /learning/v1/rolemanagement/organization/{org_id}/Roles?pageNumber=1&pageSize=1
```
NIM replaces {org_id} with the configured Org ID. The request retrieves the first page with a page size of one role.
Confirm that the test succeeds. If it fails, verify the Tenant URL, Client Key, Client Secret, and Org ID, and confirm organization role access with HealthStream.
Collect the system and inspect the Roles and Students data needed for your provisioning process. Confirm that the Institution ID matches the intended institution.
Validate student creation or updates with a safe test record before enabling scheduled provisioning.

The connection test reads organization roles. Validate the intended student operations separately to confirm the institution settings, permissions, and target results.

Step 1 of 3