Skip to main content

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.

Simulators are reusable definitions for healthcare interface endpoints. Each simulator has a type (FHIR, HL7, Voice, Fax, Payer, Clearinghouse, CDSHooks, Message, Portal, SFTP, X12) and optional configuration. Link simulators to Environments to compose a simulated health system that tasks run rollouts against.

​
Endpoints

MethodEndpointDescription
GET/simulatorsList simulators
POST/simulatorsCreate a simulator
GET/simulators/{id}Get simulator details
PATCH/simulators/{id}Update a simulator
DELETE/simulators/{id}Delete a simulator

​
Simulator Object

FieldTypeDescription
idstringUnique identifier
typeSimulatorTypeSimulator type (Fhir, Hl7, Voice, Fax, Payer, Clearinghouse, CdsHooks, Message)
namestringSimulator name
descriptionstring | nullOptional description
configobject | nullType-specific configuration
slugstringURL-friendly identifier
organization_idstringParent organization
created_atdatetimeCreation timestamp
updated_atdatetimeLast modification timestamp

​
SDK Example

// Create a FHIR simulator
const sim = await verial.simulators.create({
  type: 'Fhir',
  name: 'Epic EHR',
})

// List simulators (optionally filter by environment)
const simulators = await verial.simulators.list({ environmentId: 'env_abc123' })

// Get a specific simulator
const details = await verial.simulators.get({ id: sim.id })

// Update configuration
await verial.simulators.update({
  id: sim.id,
  config: { ehrVendor: 'epic' },
})

// Generate config from a prompt
await verial.simulators.generateConfig({
  id: sim.id,
  prompt: 'A primary care clinic in San Francisco',
})

// Generate synthetic data
await verial.simulators.generateData({ id: sim.id })

// Delete
await verial.simulators.delete({ id: sim.id })