Documentation Index
Fetch the complete documentation index at: https://docs.verial.ai/llms.txt
Use this file to discover all available pages before exploring further.
Manage simulators that represent individual healthcare interfaces like EHR systems, phone lines, and fax machines.
Actions
| Action | Description |
|---|
list | List simulators, optionally filtered by environment |
create | Create a new simulator |
get | Get a simulator by ID |
update | Update a simulator’s name or config |
delete | Delete a simulator |
Parameters
list
| Parameter | Type | Required | Description |
|---|
environmentId | string | no | Filter by environment ID |
create
| Parameter | Type | Required | Description |
|---|
type | string | yes | Simulator type: FHIR, HL7, Voice, Fax, Payer, Clearinghouse, CDSHooks, or Message |
name | string | yes | Name of the simulator |
config | object | no | Type-specific configuration |
get
| Parameter | Type | Required | Description |
|---|
id | string | yes | Simulator ID |
update
| Parameter | Type | Required | Description |
|---|
id | string | yes | Simulator ID |
name | string | no | Updated name |
config | object | null | no | Updated config, or null to clear |
delete
| Parameter | Type | Required | Description |
|---|
id | string | yes | Simulator ID |
Examples
Create a FHIR simulator with auth config
{
"action": "create",
"type": "FHIR",
"name": "Athena EHR",
"config": {
"authType": "bearer",
"fhirVersion": "R4"
}
}
List simulators for an environment
{
"action": "list",
"environmentId": "env_abc123"
}
Update simulator config
{
"action": "update",
"id": "sim_fhir456",
"name": "Athena EHR (Sandbox)",
"config": {
"authType": "smart-on-fhir",
"fhirVersion": "R4"
}
}
