Skip to content

Run a simulator scenario

Runs a simulator scenario (for example `chest_pain_admit`, `lwbs`) through the chosen transport.

POST
/v1/sandbox/scenarios/{scenarioKey}/run

Runs a simulator scenario (for example chest_pain_admit, lwbs) through the chosen transport.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: sandbox:write

Path Parameters

scenarioKey*string
Match^[a-z0-9_]{1,60}$

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Idempotency-Key?string

1–255 characters of [A-Za-z0-9._:-] (a UUID v4 is recommended); never PHI. Stored 24 hours per app.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/sandbox/scenarios/string/run" \  -H "Content-Type: application/json" \  -d '{    "transport": "direct"  }'
{  "object": "scenario_run",  "runId": "string"}

Was this page helpful?