The open scenario foundation
The .usim reference
A shared language for the whole simulation.
A scenario holds the patient, the teaching intent, the room, and the events that connect them. The .usim foundation makes that content independent of any one authoring tool, institution, or delivery device.
This reference defines the portable scenario format, with parameter types, behavior rules, and examples in each chapter. The Suite implementation profile separately documents what the current tools accept.
Format elements
Scenario elements, grouped by documentation chapters. Each page defines parameters, behavior rules, and an expandable example.
A scenario document identifies patients, observations, resources, and behavior.
Metadata and authors7 parameter definitionsSeparate content identity, contributor credit, revision history, and clinical review.
Patient demographics8 parameter definitionsRepresent multiple fictional patients without ambiguous age units or demographic assumptions.
History7 parameter definitionsMake patient information discoverable, with an explicit timeline and disclosure rules.
Physical examination11 parameter definitionsUse observations for findings, with collection, availability, interpretation, and disclosure separated.
Review of systems3 parameter definitionsRepresent present, absent, unknown, and unasked symptoms explicitly.
Vital signs5 parameter definitionsDefine physiologic variables separately from measured observations and support authored trends.
States12 parameter definitionsGive states explicit entry, exit, effects, and role-specific content; separate phases from concurrent conditions.
Actions12 parameter definitionsAllow actions to reveal information, perform work, or change a phase, with conditional outcomes and repeat-use rules.
Timing and state progression9 parameter definitionsSpecify deterministic scheduled events, repetition, cancellation, and clock semantics.
Objects and results4 parameter definitionsResources define reusable content and explicit result delivery.
Active medications4 parameter definitionsSeparate a medication definition, order, administration, infusion, and authored response.
Laboratory data5 parameter definitionsModel orders, specimens, panels, analytes, and serial results separately.
Images and studies9 parameter definitionsPackage portable media with acquisition context and separate interpretations.
ECG5 parameter definitionsDistinguish rhythm, ECG findings, acquisition settings, and a recording.
Mechanical ventilation3 parameter definitionsSeparate airway state, ventilator settings, measured values, and alarms.
Lines and hemodynamics3 parameter definitionsGive devices identity, placement, function, and associated measurements.
Procedures3 parameter definitionsSpecify preparation, observed performance, outcomes, and complications for procedures.
Environment and actors7 parameter definitionsAdd reproducible setup, actor behavior, communication exchanges, and reset instructions.
Education and objectives20 parameter definitionsDefine the learning audience, preparation, observable objectives, assessment evidence, facilitation, and transfer to practice.
Inheritance and functions9 parameter definitionsDefine bounded conditions/effects and reproducible library composition instead of executable script text.
Packages and role outputs2 parameter definitionsDefine a portable package and enforce role-specific information release in generated outputs.
Choose the reference for your task.
Fields accepted by Builder, imports, and simulator validation.
Defined in the portable format. Suite implementation support is documented separately.