HMSA wants to work with you.
We’re inviting application developers to work with us on our Patient Access, Provider Directory, and Formulary Application Programming Interface (API).
Get started
To protect member data, the Patient Access API is using the OpenID Connect flow of the OAuth 2.0 specification.
To register, email CWS@hmsa.com. We’ll reply to start the process of issuing you a Client ID and Client Secret by environment.
SandboxRequest access to sandbox to get a user account with a specific data set to give you complete functionality.
Initial sandbox access includes a client ID, client secret, and URLs that can be accessed with the local host’s application.
ProductionRequest production access after validating that access to the Patient Access API is functioning. There’s no form to fill out. Just respond to the email we send to you when you request sandbox access.
We’ll issue you a new authorization flow URI, client ID, client secret, and URL for production. Once you enter them into the app, you’ll be able to query production data.
Patient Access API
Click Patient Access API Directory for:
- API syntax
- Function names
- Required and optional parameters supported and their data types
- Return variables and their types/structures
- Exceptions and exception handling methods and their returns
In the directory, click Get for parameter values and sample completed code.
Here are other documents to help you develop applications:
Provider API
Click Provider API Directory for:
- API syntax
- Function names
- Required and optional parameters supported and their data types
- Return variables and their types/structures
- Exceptions and exception handling methods and their returns
In the directory, click Get for parameter values and sample completed code.
Here are other documents to help you develop applications:
Formulary API
Click Formulary API Directory for:
- API syntax
- Function names
- Required and optional parameters supported and their data types
- Return variables and their types/structures
- Exceptions and exception handling methods and their returns
In the directory, click Get for parameter values and sample completed code.
Here are other documents to help you develop applications:
Navigating the API Directory
HMSADevPortal links you to pages detailing patient, formulary, and provider API protocols. For example, click Provider API Directory for Provider Directory API calls, their parameters, and return value types. For possible parameter values, click Get. Go to the /Organization entry, click Get, then Try it out. Fill in or select various values.
For example, set the _pretty and _summary drop-down to true.
Scroll down and click Execute.
You’ll see what the API call information should look like and a typical server response based on those values, such as:
