Skip to main content
Environments represent simulated health systems. Each environment is composed of one or more Simulators that work together to model a realistic healthcare setting (EHR, phone systems, fax, payers, etc.).

​
Endpoints

MethodEndpointDescription
GET/environmentsList environments
POST/environmentsCreate an environment
GET/environments/{id}Get environment details
PATCH/environments/{id}Update an environment
DELETE/environments/{id}Delete an environment
POST/environments/{id}/simulators/{simulatorId}Add a simulator to the environment
DELETE/environments/{id}/simulators/{simulatorId}Remove a simulator from the environment

​
Environment Object

FieldTypeDescription
idstringUnique identifier
namestringEnvironment name
descriptionstring | nullOptional description
organization_idstringParent organization
created_atdatetimeCreation timestamp
updated_atdatetimeLast modification timestamp

​
SDK Example

// Create an environment
const env = await verial.environments.create({
  name: 'Regional Medical Center',
})

// List all environments
const environments = await verial.environments.list()

// Get a specific environment
const details = await verial.environments.get({ id: env.id })

// Update
await verial.environments.update({
  id: env.id,
  description: 'Primary care clinic with voice and FHIR',
})

// Link a simulator
await verial.environments.addSimulator({
  environmentId: env.id,
  simulatorId: 'sim_abc123',
})

// Unlink a simulator
await verial.environments.removeSimulator({
  environmentId: env.id,
  simulatorId: 'sim_abc123',
})

// Delete
await verial.environments.delete({ id: env.id })