arrayApplication field
Patient phases in the scenario. Include exactly one baseline and at least one conclusion; connect phases with interactions.
- Required when the containing object is present.
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.
Portable format · Suite implementation support
Parameters
events.states[].id
ID
Required
Stable phase identity.
events.states[].title
string
Required
Human-facing phase name, independent of identity.
events.states[].kind
baseline | phase | conclusion
Required
Actions and schedules define how a phase is entered.
events.states[].entryConditionId
Condition ID
Optional; omitted means unspecified
Guard checked immediately before entry. Failed manual transitions are rejected; scheduled failures are recorded and skipped.
events.states[].onEnterEffectIds
Effect ID[]
Required; may be empty
Ordered operations applied after entry. Baseline effects run once when the scenario starts.
events.states[].onExitEffectIds
Effect ID[]
Required; may be empty
Ordered operations applied when leaving this phase.
events.states[].learnerBrief
string
Required
Information shown upon entering the phase; keep hidden rationale out of this field.
events.states[].facilitatorBrief
string
Required
Expected observations, acceptable responses, cues, and operational guidance.
events.states[].objectiveIds
Objective ID[]
Required; may be empty
Links the phase to an educational objective.
events.states[].exitConditionId
Condition ID
Optional; omitted means unspecified
Must hold to leave the phase; does not cause a transition by itself.
events.states[].endingId
Ending ID
Required only for conclusion
References the stopping outcome and debrief context.
events.flags[]
{ id: ID, initialValue: boolean }
Required; may be empty
Concurrent facts such as ownership-agreed; flags coexist independently of the single active phase.
Behavior and validation
- Exactly one baseline starts the scenario. 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
34 records in this view
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
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
- triggered
- scheduled
- conclusion
- 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.
objectApplication field
Absolute resulting measurements, never signed deltas. Omitted values are unspecified or inherited in an event context. Bounds are storage limits, not clinical reference intervals.
- Optional; omitted values remain unspecified.
numberApplication field
Heart rate in beats per minute. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Noninvasive systolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Noninvasive diastolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Respiratory rate in breaths per minute. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Peripheral oxygen saturation as a percentage from 0 to 100. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Body temperature in degrees Celsius. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
End-tidal carbon dioxide pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Invasive arterial systolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Invasive arterial diastolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.
- Optional; omitted values remain unspecified.
numberApplication field
Seconds over which the current vital values move to this state’s authored targets. Zero or omitted applies the targets immediately. The trend follows simulation time and pauses with the run.
- Optional; omitted values remain unspecified.
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
Blood pressure cuff: 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
Capnography: connected exposes the available measurement; disconnected hides it without changing physiology.
- Optional; omitted values remain unspecified.
booleanApplication field
Arterial pressure: 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.
stringApplication field
The identifier of a learner-requestable resource required by this event result trigger.
- Required when the containing object is present.