Scenario structure

Identifies the .usim scenario document used by all consumers.

• Required when the containing object is present.

Identifies the document format used for validation.

• Required when the containing object is present.

Stable content identity. Publication revisions and delivery instances remain separate records.

• Required when the containing object is present.

Declares required and optional execution capabilities. Consumers also inspect populated behavioral fields before running a document.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Entries for required capabilities. An empty list means no entries have been authored.

• Required when the containing object is present.

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

• Required when the containing object is present.

Entries for optional capabilities. An empty list means no entries have been authored.

• Required when the containing object is present.

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

• Required when the containing object is present.

Namespaced vendor or profile additions. The namespace is the lookup key; version and required status determine whether a consumer can safely ignore, preserve, or reject the extension.

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

Pins the concept, value-type, unit, or dimensional definitions used by the document. Definitions must be bundled or resolved by a trusted profile; execution never fetches an untrusted URL.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

Pinned library content; digest is 64 lowercase hex characters. Floating latest dependencies are prohibited.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Numeric revision, at least 1. Do not infer an omitted value.

• Required when the containing object is present.

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

• Required when the containing object is present.

Structured composition details. Omitted optional values remain unspecified.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Explicit overrides against a resolved dependency. Paths must exist; object/array values replace in full. No inferred deep merge.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Structured outputs details. Omitted optional values remain unspecified.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Explicit content selection filtered by audience. Learner views exclude facilitator-only content even when named in includeIds.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Entries for include ids. An empty list means no entries have been authored.

• Required when the containing object is present.

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

• Required when the containing object is present.

The fictional patient's presentation, history, examination, and starting observations.

• Required when the containing object is present.

One fictional patient and their authored presentation, history, examination, and observations.

• Required when the containing object is present.

Stable patient identifier used by observations, actions, and other scenario references.

• Required when the containing object is present.

The fictional patient's display name.

• Required when the containing object is present.

Entries for Structured system references. An empty list means no entries have been authored.

• Optional; omitted values remain unspecified.

Groups symptom observations by authored system heading without duplicating their values.

• Required when the containing object is present.

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

• Required when the containing object is present.

Entries for Observation ids. An empty list means no entries have been authored.

• Required when the containing object is present.

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

• Required when the containing object is present.

Non-natural airway requires a device reference; presence does not imply correct placement or function.

• Optional; omitted values remain unspecified.

The required literal value "natural".

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

The patient's opening situation and the context available at the start of the scenario.

• Required when the containing object is present.

An optional embedded patient photo that travels with the scenario. Upload a PNG, JPEG, or WebP image.

• Optional; omitted values remain unspecified.

The patient photo encoded as a data URL. Use the photo upload control to populate it.

• Required when the containing object is present.

Describe the patient's appearance for readers who cannot see the photo.

• Required when the containing object is present.

Portable media manifest referenced by diagnostics and role outputs.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Stable asset reference used by results and outputs.

• Required when the containing object is present.

Declared content type must match decoded asset type; unsupported active content is rejected.

• Required when the containing object is present.

Accessible description of the learner-visible content without hidden diagnostic explanation.

• Required when the containing object is present.

Reuse terms for this asset, with attribution in a separate field.

• Required when the containing object is present.

Creator and source credit.

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

Packaged accessible transcript; role filtering matches the original media.

• Optional; omitted values remain unspecified.

Path under assets/ within the package. Reject absolute paths, .. segments, symlinks, duplicate paths, and external fetches.

• Optional; omitted values remain unspecified.

Digest verified against bytes before use; integrity does not prove safety or authorship.

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

Authored symptoms, findings, and measurements with provenance, visibility, and availability.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Stable finding or measurement identity; a repeat collection creates a new observation ID.

• Required when the containing object is present.

Patient to whom the observation belongs.

• Required when the containing object is present.

Namespaced concept, such as usim:general-appearance; codes do not imply external terminology certification.

• Required when the containing object is present.

Separates reported experience, observed findings, and measured values.

• Required when the containing object is present.

Time of authored assessment or acquisition, possibly before baseline.

• Optional; omitted values remain unspecified.

Earliest simulated time for release; disclosure conditions must also be satisfied.

• Optional; omitted values remain unspecified.

Method, location, or equipment used to obtain the finding.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Authorized output audiences. UI hints do not replace output filtering.

• Required when the containing object is present.

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

• Required when the containing object is present.

Initial reveals at baseline; other modes require an action, condition, or facilitator release.

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

Successful completion of this action reveals the entry.

• Optional; omitted values remain unspecified.

Reveal when the condition first becomes true; reject unrelated trigger fields.

• Optional; omitted values remain unspecified.

Identifies the patient actor, relative, or colleague supplying the history.

• Optional; omitted values remain unspecified.

Facilitator context on conflicting or incomplete history; visibility follows the observation's disclosure policy.

• Optional; omitted values remain unspecified.

On collection, snapshot this variable's current value into a new measurement; later trends do not rewrite past results.

• Optional; omitted values remain unspecified.

At least one bound or text description; numeric bounds require the observation's unit and low must not exceed high. Context describes the authored population/method.

• Optional; omitted values remain unspecified.

Numeric low. Do not infer an omitted value.

• Optional; omitted values remain unspecified.

Numeric high. Do not infer an omitted value.

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Explicit authored flag, never inferred from a generic source default.

• Optional; omitted values remain unspecified.

Known requires a value. Other statuses prohibit a value rather than using zero or an empty string as a sentinel.

• Required when the containing object is present.

Type must match the registered concept. Qualitative findings can be text or explicit booleans.

• Optional; omitted values remain unspecified.

Fixed by the concept definition; no inferred conversions.

• Optional; omitted values remain unspecified.

The patient phases, transitions, and requestable resources that define how the scenario progresses.

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Whether initial value applies. Omitted optional values remain unspecified.

• Required when the containing object is present.

Named, bounded predicates referenced by actions, states, and cues.

• Optional; omitted values remain unspecified.

All predicates must be true; empty all is explicitly true. No recursive or executable expression text.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Operand types must match the target. Boolean flags support only eq/ne; numeric comparisons use the variable's declared unit.

• Required when the containing object is present.

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

• Required when the containing object is present.

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

• Required when the containing object is present.

Numeric value. Do not infer an omitted value.

• Required when the containing object is present.

Action completes through AI interpretation of learner intent against its completion criterion, configured resource interactions, or explicit learner/facilitator confirmation. Scheduled runs once after its delay from the first source-state entry, remaining pending across later states unless canceled or the scenario concludes. Omitted means action.

• Optional; omitted values remain unspecified.

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

• Required when the containing object is present.

Named event allows explicit cancellation.

• Required when the containing object is present.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

For a scheduled transition, completion of any selected action cancels this timer for the rest of the run, including after state re-entry. The action may stay in its current state. Selected unfinished actions stay available while this timer is pending once their source event has occurred, even after another event becomes current. Future-source actions remain unavailable. Completing the action enters its destination; a self-loop stays in the current event. Conclusion states do not allow recovery. Cancellation does not undo a deterioration that already occurred. The timer starts when the source event first occurs and remains pending when other events occur. Ending the scenario cancels pending timers.

• Optional; omitted values remain unspecified.

A learner action whose completion prevents this scheduled transition from firing.

• Required when the containing object is present.

Simulated seconds after the declared schedule anchor. State-entry schedules follow onAnchorStateExit and cancellation references; action timing is separate.

• Required when the containing object is present.

Evaluate when due. False skips that occurrence; it does not poll until true.

• Optional; omitted values remain unspecified.

Explicit ordering for simultaneous events. Equal priority uses schedule ID lexical order.

• Required when the containing object is present.

Operations applied atomically if the due event and transition guards are valid.

• Required when the containing object is present.

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

• Required when the containing object is present.

Optional phase transition; omit for a result or actor cue that does not move the main phase.

• Optional; omitted values remain unspecified.

Count includes the initial occurrence. Finite repetition prevents unbounded schedules.

• Optional; omitted values remain unspecified.

Numeric interval seconds. Do not infer an omitted value.

• Required when the containing object is present.

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

• Required when the containing object is present.

State/action anchors require the corresponding ID. Scenario-start prohibits refId.

• Required when the containing object is present.

The required literal value "scenario-start".

• Required when the containing object is present.

Cancel removes pending occurrences from that entry; re-entry creates a new schedule instance.

• Optional; omitted values remain unspecified.

Named reusable effects that change scenario state or disclosure.

• Optional; omitted values remain unspecified.

One typed effect with a stable identifier and explicit target.

• Required when the containing object is present.

Stable effect identifier referenced by states, actions, or schedules.

• Required when the containing object is present.

The operation performed by this effect.

• Required when the containing object is present.

The identifier of the variable or other entity changed by this effect.

• Optional; omitted values remain unspecified.

The resulting value, expressed in the target variable’s declared unit.

• Optional; omitted values remain unspecified.

The target variable’s declared unit; effects cannot silently convert units.

• Optional; omitted values remain unspecified.

Duration of a linear authored change from current value to target. Instant changes use set-variable.

• Optional; omitted values remain unspecified.

The format supports one explicit interpolation rule; no inferred dose-response or disease model.

• Optional; omitted values remain unspecified.

Numeric percent, at least -100, at most 1000. Do not infer an omitted value.

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.

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

• Optional; omitted values remain unspecified.