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

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.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 observations, media, and audience rules.

resources[].results[].interpretation

object

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.
  • 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.
  • Reusable resources describe content; requests, administrations, and result deliveries are runtime instances with unique IDs and timestamps.
  • Builder authors patient physiology changes only in Events. Resources configure learner-facing content, release conditions, and delay. Equipment monitor connectivity remains a resource setting and does not change patient physiology.
  • Compatibility: existing or programmatically authored resource response fields remain supported by the schema and execution engine. Removing their Builder controls does not erase or migrate existing responses; imported or previously saved responses retain their behavior. Author new patient changes in Events.
  • 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

130 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.
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

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 observations 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.

  • Required when the containing object is present.
objectApplication field

Setting is { name: string, value: number, unit: string }; settings and observations 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.
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.
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

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

  • 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 observations, 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 observation ids. An empty list means no entries have been authored.

  • Required when the containing object is present.
stringApplication field

Identifier of an existing observations 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.