Skip to documentation
.usim
ReferenceEvent model

Event model

Objects and results

Reusable typed content that actions can reference.

Format definition

Resources define reusable content and explicit result delivery.

Portable format · Suite implementation support

Parameters

resources[]

{ id: ID, kind: enum, name: string, description: string, sourceIds: ID[] }

Required; may be empty

Kinds: medication, diagnostic, procedure, equipment, consultation, information. Type-specific payloads are defined in their domain chapters.

events.actions[].resourceId

Resource ID

Optional; omitted means unspecified

Resource used by the action. Use count and repetition belong to the action rather than a global once-per-object rule.

resources[].results[]

{ id: ID, content: string, observationIds: Observation ID[], assetIds: Asset ID[], disclosure: Disclosure }

Optional; default []

Named result combines authored report text, structured observations, media, and audience rules.

resources[].results[].interpretation

{ learner?: string, facilitator: string }

Optional; omitted means unspecified

Separate diagnostic or teaching explanation from the raw learner result.

Behavior and validation

  • Resource classification is stored in events.objects[].type. Diagnostic resources require diagnosticCategory: lab, imaging, or physiologic. Other resource types omit diagnosticCategory. Procedures include nursing and physician actions performed on the patient.
  • Reusable resources describe content; requests, administrations, and result deliveries are runtime instances with unique IDs and timestamps.
  • Use a schedule anchored to action completion for delayed release. No universal result delay also delays administration or every effect; timing must be expressed explicitly.
  • A resource type does not grant access. Result availability and role filtering apply to exports, network payloads, and UI alike.

Shared format conventions · All format elements · Download specification

Field reference

47 records in this view
events.objects
arrayApplication field

Medications, tests, procedures, and other resources available in the case. Each resource can be used once per run; use separate entries for repeat doses or serial results.

  • Optional; omitted values remain unspecified.
events.objects.*
objectApplication field

One resource with learner-facing information, release timing, and any authored response or patient changes.

  • Required when the containing object is present.
events.objects.*.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.
events.objects.*.type
stringApplication field

Categorize the resource for selection and display. Choosing a type alone does not define its physiologic effects.

Allowed values

  • medication
  • diagnostic
  • procedure
  • equipment
  • consultation
  • information
  • Required when the containing object is present.
events.objects.*.name
stringApplication field

The name learners use to identify or request this resource. Include the dose or study details needed to distinguish similar choices.

  • Required when the containing object is present.
events.objects.*.diagnosticCategory
stringApplication field

Required only for diagnostic resources: lab for specimen-based tests, imaging for images and reports, or physiologic for recordings and functional measurements such as ECG, EEG, and spirometry.

Allowed values

  • lab
  • imaging
  • physiologic
  • Required for diagnostic resources; omitted for other resource types.
events.objects.*.description
stringApplication field

Optional context about the resource and why it is available. Leave blank when the name is sufficient. Put findings released after use in Learner result.

  • Optional; omitted values remain unspecified.
events.objects.*.result
stringApplication field

Information shown when the resource response is released, such as a report, consultation advice, or procedure outcome. If empty, the description is shown instead.

  • Optional; omitted values remain unspecified.
events.objects.*.labResults
arrayApplication field

Structured test results shown before the result notes. Supply the fictional case's values and units; missing results are not inferred.

  • Optional; omitted values remain unspecified.
events.objects.*.labResults.*
objectApplication field

One laboratory measurement, with its test name, reported value, and unit.

  • Required when the containing object is present.
events.objects.*.labResults.*.value
stringApplication field

The reported result as text, preserving decimals, inequalities, or qualitative values such as Negative.

  • Required when the containing object is present.
events.objects.*.labResults.*.unit
stringApplication field

The unit accompanying this result, such as g/dL or mmol/L. Leave empty for a unitless or qualitative result.

  • Required when the containing object is present.
events.objects.*.image
objectApplication field

An embedded image released with this resource, with a text description of its content.

  • Optional; omitted values remain unspecified.
events.objects.*.image.dataUrl
stringApplication field

The image encoded as a data URL so it travels with the scenario. Use the image upload control to populate it.

  • Required when the containing object is present.
events.objects.*.image.description
stringApplication field

Describe the image and relevant visible findings for readers who cannot see it.

  • Required when the containing object is present.
events.objects.*.releaseOnStateId
stringApplication field

Attach this result to a step. Diagnostics can also be requested individually; learner action completion does not deliver unrequested tests. Timed or facilitator event entry delivers linked results automatically. The response delay starts when the individual request or automatic delivery is recorded.

  • Optional; omitted values remain unspecified.
events.objects.*.delaySeconds
numberApplication field

Seconds from the learner request or linked event until the response and its effects become available. Zero or omitted means immediate.

  • Optional; omitted values remain unspecified.
events.objects.*.effects
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.
events.objects.*.effects.hr
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.
events.objects.*.effects.sbp
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.
events.objects.*.effects.dbp
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.
events.objects.*.effects.rr
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.
events.objects.*.effects.spo2
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.
events.objects.*.effects.temperature
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.
events.objects.*.effects.etco2
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.
events.objects.*.effects.artSbp
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.
events.objects.*.effects.artDbp
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.
events.objects.*.advanceToStateId
stringApplication field

Enter this event when the resource response is released. Destination vitals replace resource effects; do not combine with effects or effectPercent.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent
objectApplication field

Signed percentage changes applied once to current vitals at response time. Missing values stay unspecified. Mutually exclusive with effects and advanceToStateId.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.hr
numberApplication field

Percentage change to heart rate in beats per minute. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.sbp
numberApplication field

Percentage change to noninvasive systolic blood pressure in mmhg. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.dbp
numberApplication field

Percentage change to noninvasive diastolic blood pressure in mmhg. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.rr
numberApplication field

Percentage change to respiratory rate in breaths per minute. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.spo2
numberApplication field

Percentage change to peripheral oxygen saturation as a percentage from 0 to 100. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.temperature
numberApplication field

Percentage change to body temperature in degrees celsius. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.etco2
numberApplication field

Percentage change to end-tidal carbon dioxide pressure in mmhg. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.artSbp
numberApplication field

Percentage change to invasive arterial systolic blood pressure in mmhg. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.effectPercent.artDbp
numberApplication field

Percentage change to invasive arterial diastolic blood pressure in mmhg. Applied once when the resource response arrives: -20 reduces the current value by 20%; 20 increases it by 20%. Omit to leave unchanged.

  • Optional; omitted values remain unspecified.
events.objects.*.monitorConnection
objectApplication field

Connect or disconnect an equipment channel when this resource response is released.

  • Optional; omitted values remain unspecified.
events.objects.*.monitorConnection.channel
stringApplication field

The monitor channel controlled by this equipment resource; all controls every channel; standard controls ECG, SpO2, NIBP, temperature, and respiratory rate.

Allowed values

  • ecg
  • bloodPressure
  • spo2
  • respiration
  • temperature
  • capnography
  • arterialPressure
  • all
  • standard
  • Required when the containing object is present.
events.objects.*.orthostaticResponse
objectApplication field

Report standing BP relative to current resting BP when requested, without changing resting physiology. An authored learner result takes precedence.

  • Optional; omitted values remain unspecified.
events.objects.*.medicationResponse
stringApplication field

Versioned educational medication response, applied once to current vitals after the response delay. Requires a known patient age of at least 18 years. Do not combine with absolute, percentage or event responses. Exact changes are simulation assumptions; author condition-specific responses when needed.

Allowed values

  • fluid-250-v1
  • fluid-500-v1
  • fluid-1000-v1
  • antipyretic-v1
  • pressor-v1
  • alpha-pressor-v1
  • epinephrine-v1
  • atropine-v1
  • rate-control-v1
  • beta-blocker-v1
  • vasodilator-v1
  • nitrate-v1
  • sedative-v1
  • propofol-sedation-v1
  • propofol-induction-v1
  • ketamine-analgesia-v1
  • ketamine-induction-v1
  • dexmedetomidine-v1
  • Optional; omitted values remain unspecified.
events.objects.*.source
stringApplication field

Credit the source of the resource content, including a citation or URL when available. Attribution alone does not verify clinical accuracy.

  • Optional; omitted values remain unspecified.
Compatibility and current support