The Health Chain Development Sandbox allows you to test your application developed with the Health Chain APIs in a simulated environment. You can then simulate authentication flows and production calls using synthetic users and FHIR data.
To use the Sandbox environment, follow these steps:
- Register as a developer on the Health Chain Developer Portal by pressing the Sign Up button, and filling in the registration fields.
- Once your developer account is registered go to the Applications tab and select the Register Application button.
- Complete the steps to register your application and Sandbox access will be granted. You will be provided a Client ID and Client Secret (when applicable) during Registration. Note, please make a copy of your Client Secret during your registration.
- Use the Sandbox authentication endpoint URLs, listed in the Authentication URLs (https://devportal-demo.health-chain.io/api-explorer/patient-access-api/sandbox/authorization-url) section below, to make the authorization calls. Refer to the Standard Authorization Flow (https://devportal-demo.health-chain.io/api-explorer/patient-access-api/introduction/authorization#Getting-Started-Standard-Authorization-Code-Flow) and Proof Key for Code Exchange (PKCE) Application Code Flow (https://devportal-demo.health-chain.io/api-explorer/patient-access-api/introduction/authorization#Getting-Started-Proof-Key-for-Code-Exchange-(PKCE)-Application-Code-Flow) sections for more information on the authorization calls.
- After sending the authorization request, your application will be directed to a Health Chain sign in page through browser re-directs. When you arrive at this sign in page, use one of the synthetic users, listed in the Sandbox Test Users section below. Upon completing sign-in, you will be presented with an authorization page. Check the authorization checkbox to continue.
- After successfully completing the authentication/authorization calls and receiving your JWT, you can exchange the JWT for access to the synthetic data contained in the Sandbox.
- Use the base URLs listed in the Sandbox Base URLs(https://devportal-demo.health-chain.io/api-explorer/patient-access-api/sandbox/base-url) section below to make calls to the Health Chain FHIR server that contains the synthetic data. Refer to the Patient Access API (https://devportal-demo.health-chain.io/api-explorer/patient-access-api/implementation-guide/overview) Implementation Guide for information about the available resources. You can also reference the View APIs page for Swagger definitions of the available endpoints.
Note: If you encounter any issues with your authentication access to the Sandbox, or any issues with the Sandbox API, please use the Get Help link. After clicking the link, from the Issue Category drop-down menu, select, API Authentication, and in the Questions and Comments field, provide details of the issue that you’re encountering. A Health Chain representative will respond and help you resolve your issue.