Skip to main content

Team access and simulation time

Create or reconnect a team​

  1. Open the neighbourhood map and choose a workplace.
  2. Enter your team name to create or join its world. You can also expand the existing-key option and connect with an API key.
  3. For a new team, choose Copy API key before continuing. The confirmation stays open until you continue.
  4. Launch an app. The first-use tour points out the key, simulation controls, and patient selector.

Team names are join codes: anyone who enters the same name can join that simulation world. Names are converted to lowercase with all whitespace removed, so Team Rocket, teamrocket, and TEAM ROCKET join the same world and return the same reusable key. Choose a distinct name for your team.

The browser saves the connection in localStorage, so it survives refreshes and reopening the browser. Teammates on another device can enter the same name or use the shared API key.

Older worlds keep their existing keys. The first name-based join may issue a new reusable key for that same world because older keys were stored only as hashes. If a name matches several older worlds, use the existing key to select the right world.

Open Team & API key in the fixed bottom bar to copy or reveal the connected key. Disconnect this browser removes the browser connection without deleting the world.

Choose the person and workplace​

Use the patient directory in each workplace. Home Health and patient Messages have resident selectors. Changing the person changes the records on screen. Use the same SIM identifier when comparing a patient's GP, hospital, pharmacy, community, and home records.

Return through Neighbourhood map to change workplaces. A service sees the records shared with it; absence in one workplace does not mean the record is absent everywhere.

Advance time and inspect activity​

Open Simulation controls in the fixed bottom bar. Pause stops automatic time progression, and Run resumes it. The advance buttons pause the clock, move it forward, and process due activity.

A saved request can remain pending until its scheduled time. A hospital laboratory order is due after 120 minutes for collection now or 240 minutes for the next round. A home visit is due after 90 minutes. A newly connected watch schedules its first reading after 10 minutes. Supplier orders show their own due times.

Read Activity trail to see recent actions, their acting team or simulator actor, and simulation time. Open individual record details for that record's authorship and version history. The trail shows the most recent 20 events.

Connect an agent​

Use the same key as Authorization: Bearer YOUR_TEAM_KEY. The API explorer lets you authorize requests and try them against this instance. Download the OpenAPI JSON for tools that import API definitions.

Use Make your first API call for a complete request sequence. Team keys, organiser tokens, and Staff Identity staff tokens have separate purposes.