Skip to main content
Manage simulated healthcare environments that define the system your agent interacts with.

​
Actions

ActionDescription
listList all environments in the organization
createCreate a new environment
getGet an environment by ID
updateUpdate an environment’s name or description
deleteDelete an environment
addSimulatorAttach a simulator to an environment
removeSimulatorDetach a simulator from an environment

​
Parameters

​
list

No parameters.

​
create

ParameterTypeRequiredDescription
namestringyesName of the environment
descriptionstringnoDescription of the environment

​
get

ParameterTypeRequiredDescription
idstringyesEnvironment ID

​
update

ParameterTypeRequiredDescription
idstringyesEnvironment ID
namestringnoUpdated name
descriptionstring | nullnoUpdated description, or null to clear

​
delete

ParameterTypeRequiredDescription
idstringyesEnvironment ID

​
addSimulator

ParameterTypeRequiredDescription
idstringyesEnvironment ID
simulatorIdstringyesSimulator ID to attach

​
removeSimulator

ParameterTypeRequiredDescription
idstringyesEnvironment ID
simulatorIdstringyesSimulator ID to detach

​
Examples

​
List all environments

{
  "action": "list"
}

​
Create a primary care clinic environment

{
  "action": "create",
  "name": "Primary Care Clinic",
  "description": "Simulated primary care setting with EHR and phone system"
}

​
Add a FHIR simulator to an environment

{
  "action": "addSimulator",
  "id": "env_abc123",
  "simulatorId": "sim_fhir456"
}