Skip to documentation
ReferenceEvent model

Event model

Objects and results

Reusable typed content that actions can reference.

Format definition

Resources define reusable content and explicit result delivery.

Scenario standard · Execution capabilities

Early order execution example

Runtime records belong to the revision-pinned run, separately from the scenario fragment above. Delivery does not change credit.

TimeEventPersisted evidenceCredit
5 secondsInitial; resource hidden from menu; explicit chat order acceptedpendingResourceRequests: [{objectId: thyroid, requestedAtSeconds: 5, requestHistoryLength: 1}]; resourceResults: []1 point
20 secondsEnter Results availablependingResourceRequests: []; resourceResults: [{objectId: thyroid, requestedAtSeconds: 5, requestHistoryLength: 1, availableAtSeconds: 50, result: authored response}]1 point
50 secondsExisting delayed response machinery delivers onceThe same result record and original accepted-order timestamp remain1 point

Parameters

resources[]

object

Optional; omitted means unspecified

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

resources[].name

string

Required

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

resources[].builderTitle

string

Optional; omitted means unspecified

An optional explanatory title for Builder selection and authoring, such as XR Pediatric Neck (2 Views): Esophageal Button Battery. Never use it as a learner label or spoken title. Omission uses name in Builder; name remains the learner title.

resources[].response.unavailableAfterResourceIds

string[]

Optional; omitted means unspecified

New requests are blocked once any listed resource has been requested, even while its result is pending. This describes request order, not confirmed administration. Results already requested remain available. Omitted means no request-order restriction.

resources[].response.availableAfterResourceResponses

object[]

Optional; omitted means unspecified

All listed resource responses must already exist before this request command begins, and simulation time must reach each persisted response availability time plus authored seconds. Response availability is not inferred administration. Gates new requests only; pending and already delivered results remain. Cannot combine with automatic release.

resources[].response.availableInStateIds

string[]

Optional; omitted means unspecified

Only new requests in these events are allowed. Already requested results remain available and their delays continue after leaving the event. Omitted means available in every event.

resources[].response.effectIds

string[]

Optional; omitted means unspecified

Direct simulation effects are authored only for medication, procedure, and equipment resources. Diagnostic, consultation, and information resources retain result delivery, timing, availability, and Event links. Existing effects remain stored and executable, but must be moved to Events or the resource reclassified before publishing.

resources[].response.releaseOnStateId

string

Optional; omitted means unspecified

Choose when this resource result is released. With no linked event, learners request it in chat or from the bedside menu, and the response delay starts when the request is recorded. A linked event releases the result when that step starts, after any response delay; requests for non-diagnostic resources are checked against the action instructions. Diagnostic requests return only the requested test: completing an action does not order other tests linked to the same step. Timed or facilitator-delivered steps can still release their linked results automatically. If a step waits for required results, configure that link in Events.

events.actions[].resourceId

string

Optional; omitted means unspecified

Requests a resource when this transition fires. Builder authors resource links on the state under Results.

resources[].results[]

object

Optional; omitted means unspecified

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

resources[].results[].interpretation

object

Optional; omitted means unspecified

Separate diagnostic or teaching explanation from the raw learner result.

resources[].response.earlyRequest

object

Optional; omitted means unspecified

Accept explicit chat orders before availability. The resource stays out of the menu until available or requested. Accepted orders wait for every event and response requirement, then the response delay begins. No request means no delivery. Cannot combine with automatic release.

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.
  • name is always the learner title; builderTitle must never substitute for it in learner labels or spoken titles. Authoring interfaces may use builderTitle, falling back to name when it is absent. Existing documents without builderTitle retain their names. Marketplace imports preserve descriptive catalog titles as builderTitle and supply explicit neutral learner names. Titles do not control the disclosure of report text, captions, or image descriptions.
  • response.unavailableAfterResourceIds gates new requests using persisted request history, not treatment completion. Automatic delivery is skipped when invalidated; prior results and delays remain intact. Consumers without resource-request-availability support must reject execution.
  • response.availableInStateIds gates new requests, including automatic delivery, only. A linked automatic release event must be allowed. Delays continue and already delivered results remain visible after leaving that event. Consumers without resource-state-availability support must reject execution instead of ignoring the constraint. Omitted means unrestricted request availability.
  • Reusable resources describe content; requests, administrations, and result deliveries are runtime instances with unique IDs and timestamps.
  • Builder authors patient physiology in Events and, for medication, procedure, and equipment only, in the Simulation response disclosure. Custom responses support absolute set-variable, percentage scale-variable, and relative offset-variable effects; medication alone also supports versioned apply-model presets. None removes supported direct effects. Equipment monitor connectivity remains independent.
  • Diagnostic (lab, imaging, and physiologic), consultation, and information resources do not author response.effectIds or expose Simulation response. All resource types retain result delivery, timing, availability, and Event links. Existing excluded-type effects remain stored and executable, including pinned revisions, but publication and new AI regressions are blocked until effects are moved to Events or the resource is appropriately reclassified. Builder identifies existing effects without deleting or silently disabling them.
  • 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.
  • response.earlyRequest opts into accepting explicit orders before availability; omission retains rejection. An empty object uses ‘Request received. We’ll let you know when it’s available.’ An optional message overrides it. The resource remains hidden from browsing until available or requested. Automatic release cannot combine with early requests.
  • Persist accepted pending requests separately from resourceResults, with objectId, original requestedAtSeconds and requestHistoryLength. Pending requests have no returned content or availableAtSeconds. They never satisfy response gates. At eligibility, schedule the existing response delay from that instant, retaining the accepted order time. Recheck on event/time/result updates and resumed execution; deduplicate, cancel on invalidation, and never deliver after completion.

Shared format conventions · All format elements · Download specification

Field reference

158 records in this view
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.
objectApplication field

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

  • 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

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.
stringApplication field

The neutral title 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.
stringApplication field

An optional explanatory title for Builder selection and authoring, such as XR Pediatric Neck (2 Views): Esophageal Button Battery. Never use it as a learner label or spoken title. Omission uses name in Builder; name remains the learner title.

  • Optional; omitted values remain unspecified.
booleanApplication field

Hide this resource from learner menus until requested. Explicit chat and voice requests remain available; pending and completed results remain visible.

  • Optional; omitted values remain unspecified.
objectApplication field

A named request with explicit result references. Laboratory requests require an authored specimen description.

  • Optional; omitted values remain unspecified.
valueApplication 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 when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
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.
objectApplication field

Acquisition context plus independent rhythm and morphology findings; all supplied scale numbers must be positive.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
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.
objectApplication field

Covers vascular access, urinary/gastric tubes, invasive monitoring, and other authored devices.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • available
  • connected
  • malfunctioning
  • removed
  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Separate placement time and authored confirmation from mere presence.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • unknown
  • confirmed
  • incorrect
  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

Named capabilities referenced by procedure prerequisites or environment requirements.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication 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.
objectApplication field

Setting is { name: string, value: number, unit: string }; settings and findings remain distinct.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Optional resource order template. These authored instructions do not create an executed order, administration record, infusion, or repeat schedule. Hidden details are retained when route, method, frequency, or PRN changes.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • mg
  • mcg
  • g
  • mL
  • L
  • units
  • apheresis unit
  • mEq
  • mmol
  • mg/kg
  • mcg/kg
  • g/kg
  • mL/kg
  • units/kg
  • mEq/kg
  • mg PE/kg
  • Required when the containing object is present.
valueApplication field

How the medication is administered. IV, IO, and subcutaneous routes also support an administration method.

Allowed values

  • Oral
  • IV
  • IO
  • Intramuscular
  • Subcutaneous
  • Inhaled
  • Intranasal
  • Sublingual
  • Rectal
  • Topical
  • IV / IO
  • Nebulized
  • Oral / NG
  • Local infiltration
  • Intratracheal
  • Wound infiltration / IM
  • Optional; omitted values remain unspecified.
valueApplication field

How often the medication is intended to be given. Select Custom for another schedule. These instructions do not automatically schedule simulation doses.

Allowed values

  • Once
  • Every hour
  • Every 4 hours
  • Every 6 hours
  • Every 8 hours
  • Every 12 hours
  • Daily
  • Custom
  • Optional; omitted values remain unspecified.
valueApplication field

Choose a push or injection, an infusion given intermittently, or an ongoing continuous infusion.

Allowed values

  • push-injection
  • intermittent-infusion
  • continuous-infusion
  • Optional; omitted values remain unspecified.
objectApplication field

The amount infused per unit of time. Select the unit that matches the intended infusion rate.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • mL/hr
  • L/hr
  • mL/kg/day
  • mg/hr
  • mg/min
  • mcg/min
  • mcg/kg/min
  • mcg/kg/hr
  • units/hr
  • units/min
  • units/kg/hr
  • Required when the containing object is present.
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.
objectApplication field

Structured Resource response details. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
objectApplication field

Accept explicit chat orders before availability. The resource stays out of the menu until available or requested. Accepted orders wait for every event and response requirement, then the response delay begins. No request means no delivery. Cannot combine with automatic release.

  • Optional; omitted values remain unspecified.
stringApplication field

Optional acknowledgment while an accepted order waits. Leave blank for: Request received. We’ll let you know when it’s available.

  • Optional; omitted values remain unspecified.
arrayApplication field

All listed resource responses must already exist before this request command begins, and simulation time must reach each persisted response availability time plus authored seconds. Response availability is not inferred administration. Gates new requests only; pending and already delivered results remain. Cannot combine with automatic release.

  • Optional; omitted values remain unspecified.
arrayApplication field

New requests are blocked once any listed resource has been requested, even while its result is pending. This describes request order, not confirmed administration. Results already requested remain available. Omitted means no request-order restriction.

  • Optional; omitted values remain unspecified.
arrayApplication field

Only new requests in these events are allowed. Already requested results remain available and their delays continue after leaving the event. Omitted means available in every event.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

Choose when this resource result is released. With no linked event, learners request it in chat or from the bedside menu, and the response delay starts when the request is recorded. A linked event releases the result when that step starts, after any response delay; requests for non-diagnostic resources are checked against the action instructions. Diagnostic requests return only the requested test: completing an action does not order other tests linked to the same step. Timed or facilitator-delivered steps can still release their linked results automatically. If a step waits for required results, configure that link in Events.

  • Optional; omitted values remain unspecified.
numberApplication field

Numeric delay seconds, at least 0. Do not infer an omitted value.

  • Optional; omitted values remain unspecified.
arrayApplication field

Direct simulation effects are authored only for medication, procedure, and equipment resources. Diagnostic, consultation, and information resources retain result delivery, timing, availability, and Event links. Existing effects remain stored and executable, but must be moved to Events or the resource reclassified before publishing.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Reusable product definition. QuantityRatio is numerator Quantity / denominator Quantity; positive denominator is required.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Structured concentration details. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

A structured exchange with authored requests and responses rather than a one-line result.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Preparation and performance content with an explicit action deciding the authored result.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
valueApplication field

Ordered observable steps. Action evidence requires actionId; facilitator evidence is recorded during the run.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

Conditional authored consequences evaluated once at procedure completion, in listed order.

  • Required when the containing object is present.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

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

  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • learner
  • facilitator
  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • initial
  • facilitator
  • Required when the containing object is present.
objectApplication field

Separate diagnostic or teaching explanation from the raw learner result.

  • Optional; omitted values remain unspecified.
stringApplication field

Human-readable panel grouping; does not inject assumed analytes.

  • Optional; omitted values remain unspecified.
valueApplication field

Allows rejected or unavailable specimens to drive a repeat-collection branch.

Allowed values

  • adequate
  • inadequate
  • not-collected
  • Optional; omitted values remain unspecified.