Skip to documentation
ReferenceEvent model

Event model

States

Named conditions and phases of a simulation.

Format definition

Give states explicit entry, exit, effects, and role-specific content; separate phases from concurrent conditions.

Scenario standard · Execution capabilities

Parameters

events.states[].id

string

Required

A stable identifier used to reference this entry. Keep it unchanged when editing the entry's name or content.

events.states[].title

string

Required

A short name for this phase, such as Initial assessment or Worsening respiratory distress.

events.states[].kind

"baseline" | "phase" | "conclusion"

Required

Baseline starts the case; triggered and scheduled describe intermediate phases; conclusion ends the run. A scheduled phase still needs an incoming timed interaction.

events.states[].entryConditionId

string

Optional; omitted means unspecified

Guard checked immediately before entry. Failed manual transitions are rejected; scheduled failures are recorded and skipped.

events.states[].onEnterEffectIds

string[]

Optional; omitted means unspecified

Ordered effect identifiers applied when this state is entered.

events.states[].onExitEffectIds

string[]

Optional; omitted means unspecified

Ordered effect identifiers applied when this state is exited; execution requires support for exit effects.

events.states[].learnerBrief

string

Required

Information presented to the learner at this phase: the patient's condition, new findings, or an immediate task. Keep tutor instructions and unrevealed answers in the tutor prompt.

events.states[].facilitatorBrief

string

Required

Guide the tutor through this phase: expected learner actions, cues to offer if learners struggle, and when and why to advance. Include relevant reasoning and facilitation instructions.

events.states[].objectiveIds

string[]

Optional; omitted means unspecified

Links the phase to an educational objective.

events.states[].exitConditionId

string

Optional; omitted means unspecified

Must hold to leave the phase; does not cause a transition by itself.

events.flags[]

object

Optional; omitted means unspecified

Concurrent facts such as ownership-agreed; flags coexist independently of the single active phase.

Behavior and validation

  • Exactly one baseline contains only the starting conditions. In newly authored flows, meaningful milestones advance to distinct non-baseline phases, even when physiology is unchanged; do not author self-loops or return transitions to baseline. Routine resource requests do not require their own phase. Existing explicit source flows remain supported and must not be silently rewritten. At least one conclusion must be reachable. One phase is active at a time; concurrent clinical or team conditions are flags or variables, not competing active phases.
  • Validate exit and destination entry guards against the pre-transition snapshot. Then apply exit effects, action completion effects, and entry effects in that order. A failed guard causes no partial effects.
  • Conclusion freezes simulated progression and cancels pending schedules and unfinished actions; it is not a pass/fail score. Facilitator stop produces an interrupted run outside the scenario's normal ending logic.

Shared format conventions · All format elements · Download specification

Field reference

31 records in this view
arrayApplication field

Patient phases in the scenario. Baseline contains starting conditions only. Newly authored milestones advance to distinct non-baseline phases even with unchanged vitals; do not return to baseline. Include exactly one baseline and at least one conclusion; connect phases with interactions.

  • Required when the containing object is present.
objectApplication field

One phase of the case, with learner information, tutor guidance, and any changed patient observations.

  • 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

A short name for this phase, such as Initial assessment or Worsening respiratory distress.

  • Required when the containing object is present.
stringApplication field

Guard checked immediately before entry. Failed manual transitions are rejected; scheduled failures are recorded and skipped.

  • Optional; omitted values remain unspecified.
stringApplication field

Must hold to leave the phase; does not cause a transition by itself.

  • Optional; omitted values remain unspecified.
arrayApplication field

Ordered effect identifiers applied when this state is entered.

  • Optional; omitted values remain unspecified.
stringApplication field

An effect applied at this position in the state’s entry sequence.

  • Required when the containing object is present.
arrayApplication field

Ordered effect identifiers applied when this state is exited; execution requires support for exit effects.

  • Optional; omitted values remain unspecified.
stringApplication field

An effect applied at this position in the state’s exit sequence.

  • Required when the containing object is present.
stringApplication field

Information presented to the learner at this phase: the patient's condition, new findings, or an immediate task. Keep tutor instructions and unrevealed answers in the tutor prompt.

  • Required when the containing object is present.
stringApplication field

Guide the tutor through this phase: expected learner actions, cues to offer if learners struggle, and when and why to advance. Include relevant reasoning and facilitation instructions.

  • Required when the containing object is present.
arrayApplication field

Links the phase to an educational objective.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

Baseline starts the case; triggered and scheduled describe intermediate phases; conclusion ends the run. A scheduled phase still needs an incoming timed interaction.

Allowed values

  • baseline
  • phase
  • conclusion
  • Required when the containing object is present.
objectApplication field

Monitor rhythm, pulse status, and channel connection overrides for this phase. Connection-only overrides preserve the preceding rhythm; omitted channels keep their preceding connection.

  • Optional; omitted values remain unspecified.
stringApplication field

The ECG rhythm displayed on the monitor. Select the rhythm separately from whether the patient has a palpable pulse.

Allowed values

  • sinus
  • sinus_tachycardia
  • sinus_bradycardia
  • atrial_fibrillation
  • atrial_flutter
  • svt
  • ventricular_tachycardia
  • torsades
  • ventricular_fibrillation
  • asystole
  • av_block_1
  • av_block_2_mobitz_1
  • av_block_2_mobitz_2
  • av_block_3
  • junctional
  • ventricular_paced
  • Optional; omitted values remain unspecified.
booleanApplication field

Whether a palpable pulse is present. Use this to distinguish perfusing and pulseless presentations of the displayed rhythm.

  • Optional; omitted values remain unspecified.
objectApplication field

Connected channels expose available measurements without changing physiology. An explicit empty patient connection map starts disconnected. Omitted event channels inherit their preceding connection. Omitting the patient connection map makes available channels connected.

  • Optional; omitted values remain unspecified.
booleanApplication field

ECG: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Pulse oximetry: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Respiratory monitoring: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Temperature probe: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Mark an educationally important phase. This does not award points or require every path to pass through the phase.

  • Optional; omitted values remain unspecified.
objectApplication field

Enter this event once when selected learner-requested resource results become available. Incoming transitions remain alternative paths into the event.

  • Optional; omitted values remain unspecified.
stringApplication field

All waits for every selected resource result; any enters on the first selected result. Requests alone do not satisfy the rule until their response delays elapse.

Allowed values

  • any
  • all
  • Required when the containing object is present.
arrayApplication field

Scenario resources whose completed results trigger this event. Select learner-requestable resources without a separate resource destination event.

  • Required when the containing object is present.