Welcome

These are the APIs to be utilized when initiating patient processing. These APIs are largely asynchronous, as patient data is not immediately returned to the client. Please contact Connective Health if you have any questions.

OpenAPI Specification

Our full OpenAPI specification can be found on GitHub.

Security

Overview

All interactions with Connective Health must satisfy all HIPAA and other regulatory requirements. In particular, patient information must always be encrypted while in transit to and from Connective Health.

TLS

All communication is required to utilize modern TLS version 1.2 or newer with a modern cipher. If utilizing a Connective Health API, your system must be configured to work with these requirements. See this information for more guidance.

Authentication

All API endpoints are authenticated using an API Key which will be provided to you upon initiation of a pilot. This key should be provided as an HTTP header with every request.
apiKey: <your key here>

Other Requirements

Rate Limits

In general, Connective Health will impose rate limits on all API endpoints. This is for both your protection (avoiding unexpected costs) and ours (system instability). These limits are not intended to impose undo restrictions on your system and we will work with you on appropriate values. If you reach