Vendor Reference
What each supported source system needs to connect, and what it can supply.
Optimal Workforce connects to three scheduling and health information systems. This page is the reference for what each needs.
If your system is not listed, use CSV Upload.
At a glance
| Vendor | Credentials | Also needs |
|---|---|---|
| AlayaCare | Public Key, Private Key | Your AlayaCare base URL |
| GoldCare | Client ID, Client Secret | Your FHIR server base URL; scope is optional |
| AxisCare | API Key, Site Number | API version is optional |
AlayaCare
Credentials: a Public Key and a Private Key, issued from your AlayaCare account.
Base URL: your AlayaCare instance, in the form https://<your-company>.alayacare.com/api.
Regions: AlayaCare's groups map cleanly onto distinct geographic areas, so the platform uses them as-is. The region structure you see in the wizard is the group structure from AlayaCare.
GoldCare
GoldCare is connected through its FHIR interface rather than a proprietary API.
Credentials: a Client ID and Client Secret, using the OAuth client credentials flow. An optional scope can be supplied if your GoldCare administrator has issued one.
Base URL: the FHIR server base URL, for example https://your-goldcare-fhir-server/fhir. This is not the same as your GoldCare web address — ask your GoldCare administrator for the FHIR endpoint specifically.
Regions: GoldCare does not expose a geographic region concept, so regions are derived from client postal codes. Areas that would otherwise appear more than once are consolidated into a single row per area.
AxisCare
Credentials: an API Key and your Site Number. An API version can optionally be specified.
Base URL: you do not enter one. The host is derived from your site number. The site number is validated to a strict format, so if it is rejected, check you have entered the site number itself and not a full URL.
Regions: like GoldCare, regions are derived from postal codes and consolidated to one row per area.
Metric limitations. AxisCare exposes some electronic visit verification and care-quality signals that the other vendors do not:
| Metric | Status |
|---|---|
| EVV Clock-In Compliance | Available |
| Visit Verification Rate | Available |
| Signature Capture Rate | Not available in the current API version |
| ADL Completion Rate | Not available in the current API version |
The unavailable metrics are shown in the wizard, greyed out, so you can see they exist. They will become selectable if and when AxisCare exposes them.
Where credentials come from
Credentials can be entered per team, or set once for your whole organization and inherited by every team. Organization-level credentials mean a team member can connect without ever seeing the secret.
Rotating a key
Update the credential first, confirm the next sync succeeds, then revoke the old key at the vendor. Doing it in the other order leaves a window where syncs fail and your data quietly goes stale.
If a connection test fails
| Message or symptom | Usual cause |
|---|---|
| Authentication rejected | Key mistyped, or rotated at the vendor |
| Host not found | Wrong base URL, or the wrong company subdomain |
| AxisCare site number rejected | A full URL was entered instead of the site number |
| GoldCare returns nothing | The base URL points at the web application rather than the FHIR endpoint |
| Connects, but the regions are unfamiliar | The credentials are for a different instance or account |
More in Troubleshooting.