Skip to main content
Manage simulators that represent individual healthcare interfaces like EHR systems, phone lines, and fax machines.

​
Actions

ActionDescription
listList simulators, optionally filtered by environment
createCreate a new simulator
getGet a simulator by ID
updateUpdate a simulator’s name or config
deleteDelete a simulator

​
Parameters

​
list

ParameterTypeRequiredDescription
environmentIdstringnoFilter by environment ID

​
create

ParameterTypeRequiredDescription
typestringyesSimulator type: FHIR, HL7, Voice, Fax, Payer, Clearinghouse, CDSHooks, or Message
namestringyesName of the simulator
configobjectnoType-specific configuration

​
get

ParameterTypeRequiredDescription
idstringyesSimulator ID

​
update

ParameterTypeRequiredDescription
idstringyesSimulator ID
namestringnoUpdated name
configobject | nullnoUpdated config, or null to clear

​
delete

ParameterTypeRequiredDescription
idstringyesSimulator 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"
  }
}