objectApplication field
The location, preparation, equipment, and people needed to deliver the simulation.
- Required when the containing object is present.
ReferenceScenario content
Scenario content
Environment and actors
The room, equipment, people, and preparation surrounding a scenario.
Format definition
Add reproducible setup, actor behavior, communication exchanges, and reset instructions.
Portable format · Suite implementation support
Parameters
environment.setting
string
Required
Location, encounter context, and relevant environmental constraints.
environment.teamRoles[]
{ id: ID, name: string, minCount: integer, maxCount: integer, brief: string }
Required; may be empty
Portable learner role requirements. Counts are nonnegative with maxCount ≥ minCount; actual assignments belong to delivery records.
environment.requirements[]
{ id: ID, description: string, resourceIds: Resource ID[], substitutions: string[], required: boolean }
Required; may be empty
Operational preparation needs with acceptable alternatives.
environment.actors[]
{ id: ID, name: string, role: string, opening: string, knowledge: string[], affect: string, cues: ActorCue[] }
Required; may be empty
Character brief defines what the actor knows, how they behave, and what they volunteer.
environment.actors[].cues[]
{ id: ID, conditionId: Condition ID, line: string, delivery: facilitator | display, maxUses: positive integer }
Required; may be empty
Explicit trigger and repeat bound. Display sends authored text; facilitator means a prompt for a human actor.
resources[].consultation
{ service: string, actorId: Actor ID, requestedInformation: string[], responseResultIds: Result ID[] }
Required for consultation resources
A structured exchange with authored requests and responses rather than a one-line result.
environment.resetSteps
string[]
Required; may be empty
Ordered steps to restore equipment, media, supplies, and actor starting conditions.
Behavior and validation
- Role descriptions are scenario content; named staff and room bookings remain Center records. Actor display cues are authored content, not autonomous dialogue generation.
- Before re-running, create a new runtime instance and perform reset steps; clearing an active phase alone does not restore consumed resources or observation history.
Shared format conventions · All format elements · Download specification
Field reference
23 records in this view
stringApplication field
Where the scenario takes place and the relevant features of the care environment.
- Required when the containing object is present.
arrayApplication field
Pre-session tasks for the simulation center, each with a concrete action and setup outcome. Equipment and supplies belong in equipment.
- Required when the containing object is present.
stringApplication field
One pre-session setup task with a concrete outcome, such as programming initial manikin observations or briefing an actor.
- Required when the containing object is present.
arrayApplication field
The equipment and supplies needed to run the scenario.
- Optional; omitted values remain unspecified.
stringApplication field
One item of equipment or supplies needed for the session, with configuration or an acceptable substitute when useful.
- Required when the containing object is present.
arrayApplication field
The people portraying scenario roles, with their names, roles, and briefing instructions.
- Optional; omitted values remain unspecified.
objectApplication field
One role-player's identity, role in the case, and instructions for responding to learners.
- Required when the containing object is present.
stringApplication field
A stable identifier used to reference this entry. Keep it unchanged when editing the entry's name or content.
- Required when the containing object is present.
stringApplication field
The character's name or role-player label used to identify this actor.
- Required when the containing object is present.
stringApplication field
The character's relationship to the patient or care team, such as parent, bedside nurse, or consultant.
- Required when the containing object is present.
stringApplication field
Tell the actor what they know, how to behave, what to disclose, and how to respond to likely learner actions.
- Required when the containing object is present.
objectApplication field
Optional authored age and gender for voice casting. Omit unknown details; voice uses a neutral adult default.
- Optional; omitted values remain unspecified.
numberApplication field
The character's age in years, used to guide natural voice delivery without exaggeration.
- Optional; omitted values remain unspecified.
stringApplication field
The character's authored gender, used for default voice selection. Never inferred from their name or occupation.
- Optional; omitted values remain unspecified.
objectApplication field
The patient model and scene configuration shown during the simulation.
- Optional; omitted values remain unspecified.
stringApplication field
The URL of the patient model to load in the 3D scene. Use a model accessible to the simulation viewer.
- Required when the containing object is present.
stringApplication field
Credit the model creator and record the source and license or permission to use it.
- Required when the containing object is present.
arrayApplication field
Clickable locations on the patient model, each linked to an existing learner interaction.
- Required when the containing object is present.
objectApplication field
One interaction hotspot with an action, a model-space position, and an outward-facing direction.
- Required when the containing object is present.
stringApplication field
The existing learner action to invoke when this hotspot is selected; scheduled transitions cannot be selected.
- Required when the containing object is present.
stringApplication field
Hotspot location as three space-separated model-space coordinates (x y z), for example 0m 1m 0m.
- Required when the containing object is present.
stringApplication field
Hotspot surface direction as three space-separated vector components (x y z), for example 0 0 1.
- Required when the containing object is present.