Connect and Authenticate

In order to access the Bulk Data API, you will need to obtain the following from CareEvolution:

  • A JDBC or ODBC endpoint. The endpoint provides a connection to one or more data marts hosted in Amazon Redshift. The endpoint will contain a url, a port number, and a database name.

This will commonly be in the form: your-site.amazonaws.com:5439/database

  • Credentials (username and password).

Most industry-standard analytics software and data science frameworks provide dedicated drivers or connectors to Amazon Redshift. Use this Redshift configuration in order to authenticate and create a connection. Alternatively, Redshift is a managed implementation of PostgreSQL and generic PostgreSQL drivers can be used to connect to Redshift.

Your Redshift endpoint will only be accessible when connected to our external VPN (using AWS Client VPN). Please contact CareEvolution for network access configuration for your specified endpoint.

Your credentials may be based on a process that generates a temporary password that is obtained after authorization by a third-party identity provider as described in the AWS credentials guide.

After creating a connection to the Bulk Data API, you will need to understand how data is organized in the data marts to which you have access.