Skip to documentation
.usim
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.

Scenario standard · Execution capabilities

Parameters

environment.setting

string

Required

Where the scenario takes place and the relevant features of the care environment.

environment.teamRoles[]

object

Optional; omitted means unspecified

Portable learner role requirements. Counts are nonnegative with maxCount ≥ minCount; actual assignments belong to delivery records.

environment.requirements[]

object

Optional; omitted means unspecified

One pre-session setup task with a concrete outcome, such as programming initial manikin observations or briefing an actor.

environment.actors[]

object

Optional; omitted means unspecified

One role-player's identity, role in the case, and instructions for responding to learners.

environment.actors[].cues[]

object

Optional; omitted means unspecified

Explicit trigger and repeat bound. Display sends authored text; facilitator means a prompt for a human actor.

resources[].consultation

object

Optional; omitted means unspecified

A structured exchange with authored requests and responses rather than a one-line result.

environment.resetSteps

string[]

Optional; omitted means unspecified

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

52 records in this view
environment
objectApplication field

The location, preparation, equipment, and people needed to deliver the simulation.

  • Required when the containing object is present.
environment.setting
stringApplication field

Where the scenario takes place and the relevant features of the care environment.

  • Required when the containing object is present.
environment.teamRoles
arrayApplication field

Entries for Team roles. An empty list means no entries have been authored.

  • Optional; omitted values remain unspecified.
environment.teamRoles.*
objectApplication field

Portable learner role requirements. Counts are nonnegative with maxCount ≥ minCount; actual assignments belong to delivery records.

  • Required when the containing object is present.
environment.teamRoles.*.id
stringApplication field

Stable identifier for this entry. Keep it unchanged when editing its content.

  • Required when the containing object is present.
environment.teamRoles.*.name
stringApplication field

The Name for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
environment.teamRoles.*.minCount
integerApplication field

Numeric Min count, at least 0. Do not infer an omitted value.

  • Required when the containing object is present.
environment.teamRoles.*.maxCount
integerApplication field

Numeric Max count, at least 0. Do not infer an omitted value.

  • Required when the containing object is present.
environment.teamRoles.*.brief
stringApplication field

The Brief for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
environment.requirements
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.
environment.requirements.*
objectApplication 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.
environment.requirements.*.id
stringApplication field

Stable identifier for this entry. Keep it unchanged when editing its content.

  • Required when the containing object is present.
environment.requirements.*.description
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.
environment.requirements.*.resourceIds.*
stringApplication field

Identifier of an existing resources entry. Preserve the referenced entry when editing this field.

  • Required when the containing object is present.
environment.requirements.*.required
booleanApplication field

Whether Required applies. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
environment.actors
arrayApplication field

The people portraying scenario roles, with their names, roles, and briefing instructions.

  • Optional; omitted values remain unspecified.
environment.actors.*
objectApplication field

One role-player's identity, role in the case, and instructions for responding to learners.

  • Required when the containing object is present.
environment.actors.*.id
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.
environment.actors.*.name
stringApplication field

The character's name or role-player label used to identify this actor.

  • Required when the containing object is present.
environment.actors.*.role
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.
environment.actors.*.opening
stringApplication field

The Opening line for this entry. Omit optional information that has not been specified.

  • Optional; omitted values remain unspecified.
environment.actors.*.knowledge
arrayApplication field

Entries for Known information. An empty list means no entries have been authored.

  • Optional; omitted values remain unspecified.
environment.actors.*.knowledge.*
stringApplication field

The knowledge for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
environment.actors.*.affect
stringApplication field

The Affect for this entry. Omit optional information that has not been specified.

  • Optional; omitted values remain unspecified.
environment.actors.*.cues
arrayApplication field

Entries for Authored cues. An empty list means no entries have been authored.

  • Optional; omitted values remain unspecified.
environment.actors.*.cues.*
objectApplication field

Explicit trigger and repeat bound. Display sends authored text; facilitator means a prompt for a human actor.

  • Required when the containing object is present.
environment.actors.*.cues.*.id
stringApplication field

Stable identifier for this entry. Keep it unchanged when editing its content.

  • Required when the containing object is present.
environment.actors.*.cues.*.conditionId
stringApplication field

Identifier of an existing events.conditions entry. Preserve the referenced entry when editing this field.

  • Required when the containing object is present.
environment.actors.*.cues.*.line
stringApplication field

The Line for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
environment.actors.*.cues.*.delivery
valueApplication field

Select one of the declared Delivery alternatives; use the fields belonging to that alternative.

Allowed values

  • facilitator
  • display
  • Required when the containing object is present.
environment.actors.*.brief
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.
environment.actors.*.demographics
objectApplication field

Optional authored age and gender for voice casting. Omit unknown details; voice uses a neutral adult default.

  • Optional; omitted values remain unspecified.
environment.actors.*.demographics.age
objectApplication field

The character's authored age quantity, used to guide natural voice delivery without exaggeration.

  • Optional; omitted values remain unspecified.
environment.actors.*.demographics.gender
stringApplication field

The character's authored gender, used for default voice selection. Never inferred from their name or occupation.

  • Optional; omitted values remain unspecified.
environment.resetSteps
arrayApplication field

Ordered steps to restore equipment, media, supplies, and actor starting conditions.

  • Optional; omitted values remain unspecified.
environment.resetSteps.*
stringApplication field

The reset steps for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
environment.equipment
arrayApplication field

The equipment and supplies needed to run the scenario.

  • Optional; omitted values remain unspecified.
environment.equipment.*
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.
environment.patientScene
objectApplication field

The patient model and scene configuration shown during the simulation.

  • Optional; omitted values remain unspecified.
environment.patientScene.modelUrl
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.
environment.patientScene.attribution
stringApplication field

Credit the model creator and record the source and license or permission to use it.

  • Required when the containing object is present.
environment.patientScene.markers
arrayApplication field

Clickable locations on the patient model, each linked to an existing learner interaction.

  • Required when the containing object is present.
environment.patientScene.markers.*
objectApplication field

One interaction hotspot with an action, a model-space position, and an outward-facing direction.

  • Required when the containing object is present.
environment.patientScene.markers.*.actionId
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.
environment.patientScene.markers.*.position
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.
environment.patientScene.markers.*.normal
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.
Compatibility and current support