Building on the Platform
Getting Started
Sandbox Testing
6min
in your exploration of our platform, we've streamlined the process using postman as your go to api platform on this page you will find an overview of all postman environments and collections that will help you test all the interactions on either the founda sandbox or the epic sandbox postman environment contains all the variables you need to interact with an api postman collection contains all the api calls including the required parameters and body the postman collections are grouped per solution, within each solution collection you will find all api calls required to perform the interactions that are described within that solution in order to use the collections with one of the sandboxes, you need the following variables variable description identity server the founda identity api url depending on the environment auth \<region> founda com/oauth2/token client id the client id is part of the client credentials that you received when creating the test client that you're going to use client secret the client secret is part of the client credentials that you received when creating the test client that you're going to use sandbox org id when you create a test client on the platform, automatically the test client has access to a sandbox for testing with the example json collection you need the organization id of the sandbox to exchange data with it server instance the founda health api url depending on the environment api \<region> founda com for a live integration with a hospital, the sandbox org id will be replaced with a hospital org id the sandbox integration is only used for testing purposes regions the founda health platform is hosted in different aws regions and utilizes localized servers based on your location and preferences, the urls for the apis should be adjusted depending on the region you are in, the base url to access the founda healthapi should be eu https //api eu founda com/1/health/organizations/\<org x>/fhir/4/ us https //api us founda com/1/health/organizations/\<org x>/fhir/4/ access tokens and refresh tokens are generated through the identity api, using the following urls depending on the region your organization is hosted in eu https //auth eu founda com/oauth2/token us https //auth us founda com/oauth2/token if you want to use a pre filled postman environment, containing all the pre filled variables described above, we offer a downloadable environment for the eu region that you can use with any of the postman collections for the founda sandbox and the epic sandbox that are listed below https //archbee doc uploads s3 amazonaws com/qsnsu06vco6yg7tb9kmld/xfefgovl4igaxg6flbard founda eu server postman environment json let us know if you need an example environment for a different region, either for testing or for a production use case founda would utilize localized aws servers that match your needs founda sandbox in order to use the interactions of each solution with the founda sandbox, you will need an authorized test client this will automatically be authorized by the founda sandbox for each solution you can import the following postman collections with each solution's listed interactions that are working with the sandbox don't forget that each sandbox has unique data with unique identifiers, so you will need to change some of the parameters that are used in the requests https //archbee doc uploads s3 amazonaws com/qsnsu06vco6yg7tb9kmld/o5eh677a5a2zftynkg9eg patient demographicspostmancollection json https //archbee doc uploads s3 amazonaws com/qsnsu06vco6yg7tb9kmld/bdimsjcqwj7uzjbwidtt clinical datapostmancollection json https //archbee doc uploads s3 amazonaws com/qsnsu06vco6yg7tb9kmld/zz2uogdwjmafzb0yq0jux document exchangepostmancollection json the appointment scheduling postman collection is currently in development for our sandbox and will be added soon! for each of the collections you will need to add the client id , client secret and the sandbox org id of your sandbox in the founda eu server environment authenticate your client in the "authorization" tab and you are ready to go! for each fhir (r4) resource, test data objects are automatically generated in the founda sandbox you can create your own test data by posting fhir resources to the various resource endpoints never send real patient information to any of the sandboxes you can purge data stored in your founda sandbox using a $purge operation this operation can be used at the instance, resource, and organization level using the following requests instance level this will permanently remove the resource data identified by its (fhir) resource id https //api \<region> founda com/organization/\<your sandbox>/1/health/fhir/4/patient/\<resourcid>/$purge resource level this will permanently remove all resources of the specified resource type (e g patient, encounter, servicerequest, etc ) https //api \<region> founda com/organization/\<your sandbox>/1/health/fhir/4/patient/$purge organization level this will permanently remove all data in your sandbox https //api \<region> founda com/organization/\<your sandbox>/1/health/fhir/4/$purge epic sandbox in order to use the epic sandbox collection, you will need a client that is authorized by the epic sandbox in order to do this, create a client in the console for your organization of type production with sufficient scopes after creating your client, create an authorization request for your client for the "epic sandbox" organization once you have requested authorization, send an email to notify us of your request founda will make sure to grant you access and notify you when you can start using the epic client's credentials to interact with the sandbox for the epic sandbox you can import the following postman collection with examples of fhir requests that are working with the sandbox https //archbee doc uploads s3 amazonaws com/qsnsu06vco6yg7tb9kmld/8wag9zhrusebr0d608ydx epic sandbox postman collection json the following collection appears add the client id and client secret in your founda eu server environment, authenticate your client in the "authorization" tab and you are ready to go!