Overview
Metriport offers a Sandbox environment so you can develop your medical applications more easily. This environment allows you to try out the Medical API with some example de-identified clinical data (see section below for more details). After you get access to the Medical API, you can go to the Developers page and toggle the switch under the Sandbox section to activate Sandbox mode.Example Clinical Data
The Sandbox environment will give you access to comprehensive example clinical data for several test patients - this data will be representative of what you can expect to see in production:- C-CDA documents in XML format.
- FHIR resources in JSON format.
- Various de-identified unstructured clinical documents in PDF format.
- Various de-identified images in formats like TIFF and JPEG.
In Sandbox mode, any Patient you create with a first
name that matches one of the pre-defined Patients below
will be populated with the corresponding test data.
When querying for consolidated data in sandbox mode using
a
conversionType
, if you pass a patient that is not one
of the pre-defined Patients below, we will always return a
pre-defined file.You can expect about 6 example documents per Patient,
roughly breaking down to: a C-CDA XML (and the resulting
FHIR resources), 3 PDFs, and 2 images.
Jane Smith
Jane Smith has a history of depression and other mental health conditions.Chris Smith
Chris Smith has chronic kidney disease (CKD).Ollie Brown
Ollie Brown has generalized anxiety disorder (GAD).Kyla Brown
Kyla Brown has chronic hypertension and diabetes.Andreas Brown
Andreas Brown has type 2 diabetes and kidney disease.Webhook Testing
In sandbox mode, you can test real-time patient notifications by sending sample payloads through the dashboard.Patient Notifications
Test your webhook integration with realistic patient notification events:- Patient Admit: When a patient is admitted to a healthcare facility.
- Patient Transfer: When a patient is moved between departments/units.
- Patient Discharge: When a patient is discharged from a facility.
How to Test
In your Metriport dashboard, go to the webhook settings and use the “Test events” section. Select from Patient Admit, Patient Transfer, or Patient Discharge, then click “Send Payload” to test your webhook integration.
- Select notification type from the dropdown (Patient Admit, Patient Transfer, or Patient Discharge)
- Preview the sample payload that will be sent to your webhook
- Send the test payload with one click to verify your webhook handles patient notifications correctly
SDK
To connect to the sandbox using the SDK just provide theoptions
parameter with sandbox = true
: