Sandbox
Safely develop and validate healthcare integrations before connecting production systems.
Overview
The Sandbox provides an isolated environment for testing integrations without affecting production healthcare systems. It utilizes simulated data and mocks external downstream responses.
& Responses
Why Use the Sandbox
Safe Development
Experiment freely without risking production databases.
Test Integrations
Build and verify your system connections locally.
Validate Requests
Ensure your FHIR and HL7 payloads are formatted correctly.
Explore APIs
Discover available endpoints hands-on.
Debug Responses
Trigger complex edge cases and error states.
Practice Authentication
Test Bearer token generation and expiry loops.
What's Available
Sandbox API Keys
Dedicated testing credentials.
Mock Organizations
Simulated tenant structures.
Mock Projects
Isolated sandbox environments.
Mock FHIR Resources
Synthetic clinical data.
Sample Messages
Pre-loaded HL7 v2 payloads.
Monitoring
Basic request metrics.
Audit Events
Simulated HIPAA access logs.
Example Responses
Static successful outputs.
Sandbox Workflow
Test Data
The Sandbox contains representative sample data only. Do not ingest production healthcare information or real patient data.
Limitations
No Production Data
Never send PHI or real patient data to the Sandbox.
Rate Limits Apply
Sandbox requests are strictly rate-limited to 10 req/sec.
Environment Resets
Sandbox data is purged on a rotating 30-day schedule.
Testing Only
SLAs and uptime guarantees do not apply to the Sandbox.
No Production Integrations
Sandbox cannot trigger live webhooks or external systems.
Example Request
// Headers
Authorization: Bearer SANDBOX_API_KEY
Accept: application/fhir+json
Example Response
{
"resourceType": "Bundle",
"type": "searchset",
"total": 1,
"entry": [
{
"resource": {
"resourceType": "Patient",
"id": "sandbox-patient-1",
"name": [
{ "family": "Doe", "given": ["Jane"] }
]
}
}
]
}
Promotion to Production
Sandbox and Production are completely isolated environments. Production credentials are intentionally distinct from Sandbox keys.
Best Practices
Never expose API Keys
Keep sandbox keys out of source control just like production keys.
Test Before Production
Always verify logic in the Sandbox before promoting code.
Validate Responses
Ensure your app gracefully handles simulated error states.
Rotate Credentials
Practice your key rotation strategy using Sandbox keys.
Monitor Integrations
Check your Sandbox logs to ensure requests are routing correctly.
Review Audit Logs
Verify your platform generates the expected access trails.