Sandbox domains

When you subscribe to the TELUS Collaborative Health Record (CHR) Enterprise API, TELUS Health provides you with a sandbox CHR domain that contains fake patient data. Use this domain to explore and test the capabilities of the API, develop your solution against the API, and test your integration in a domain. Once you’ve created your API key(s) for the API, you can start testing and exploring the API. Several tools are available to create and send requests to the API to support testing and exploration in a non-production environment. TELUS Health recommends the following two tools for testing our API—they are not meant to be used with domains that contain real patient data:

In your selected tool, you must configure the API endpoint for your CHR domain and add your API key.

Steps

  1. Log in to the CHR sandbox domain as an Account Owner.

  2. From the main menu, click Settings > Public API.

  3. Under API Endpoint, click the clipboard icon to copy your endpoint.

  4. In the tool that you are using, paste the endpoint.

  5. Create your API requests.
    Each request requires an authorization header set to “Bearer {api-key}”. The body of the request is the GraphQL query as a POST payload.
    For a high-level overview, see API reference documentation.

Production (live) domains

Your CHR production domain contains your live patient data. Once your solution is fully built and tested in your CHR sandbox domain, connect to your production domain to deploy it in your clinic. Within that solution you must configure the API endpoint for your CHR domain and add your API key.

Steps

  1. Log in to the production CHR domain as an Account Owner.

  2. From the main menu, click Settings > Public API.

  3. Under API Endpoint, click the clipboard icon to copy your endpoint.

  4. In your solution, wherever the API endpoint is defined, paste the endpoint.

  5. In your solution, wherever the authorization header is configured, set it to “Bearer {api-key}”.

Updated February 1, 2022

Did this answer your question?