Skip to documentation
ReferenceReference

Reference

All fields

Search field definitions and event behavior.

Search names, paths, descriptions, or options. A blank default means unspecified; it is never converted to zero, false, or an empty string.

Field reference

551 records in this view
format
stringApplication field

Identifies the .usim scenario document used by all consumers.

  • Required when the containing object is present.
stringApplication field

Identifies the document format used for validation.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

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

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • concept
  • value-type
  • unit
  • dimension
  • value-set
  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • 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 Identifier for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
integerApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Structured composition details. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Required when the containing object is present.
objectApplication field

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

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

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

  • Required when the containing object is present.
objectApplication field

Structured outputs details. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Required when the containing object is present.
objectApplication field

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

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

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

Allowed values

  • brief
  • guide
  • event-map
  • checklist
  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Case identification, authorship, and the teaching context used to find and select this scenario.

  • Required when the containing object is present.
stringApplication field

The internal case title used by authors. Campus uses the separate learner title.

  • Required when the containing object is present.
stringApplication field

The internal scenario premise, scope, and intended learning activity. This summary is not shown in Campus.

  • Required when the containing object is present.
arrayApplication field

People and organizations credited for authorship, review, or other contributions.

  • Required when the containing object is present.
objectApplication field

A named contributor with stable identity and credited roles.

  • Required when the containing object is present.
stringApplication field

Stable contributor identifier used by review attribution.

  • Required when the containing object is present.
stringApplication field

The person or team credited with creating this scenario.

  • Required when the containing object is present.
arrayApplication field

The roles this contributor performed for this content.

  • Required when the containing object is present.
integerApplication field

The authored content revision, independent of a storage revision identifier.

  • Required when the containing object is present.
objectApplication field

The terms under which this scenario may be reused.

  • Required when the containing object is present.
stringApplication field

The license identifier or explicit rights statement. Suggested reuse licenses are advisory; preserve custom terms.

  • Required when the containing object is present.
stringApplication field

An optional asset containing the complete license text.

  • Optional; omitted values remain unspecified.
objectApplication field

Clinical review status, attribution, date, and supporting sources.

  • Required when the containing object is present.
stringApplication field

Review state stored as draft, reviewed, or needs-review. Builder displays Draft, Reviewed, and Needs review.

Allowed values

  • draft
  • reviewed
  • needs-review
  • Required when the containing object is present.
stringApplication field

The date and time the recorded review was completed. Builder displays local date and time and stores the selected instant as a UTC ISO 8601 timestamp; omission means unspecified.

  • Optional; omitted values remain unspecified.
arrayApplication field

Contributor identifiers for the reviewers.

  • Required when the containing object is present.
stringApplication field

A contributor credited with reviewing this revision.

  • Required when the containing object is present.
arrayApplication field

Stable metadata.sources IDs selected as evidence for the recorded review. Citation edits and source reordering preserve these links.

  • Required when the containing object is present.
arrayApplication field

Citations supporting the scenario and its clinical content.

  • Required when the containing object is present.
objectApplication field

A source citation with stable identity and optional web location.

  • Required when the containing object is present.
stringApplication field

Stable source identifier used by review references.

  • Required when the containing object is present.
stringApplication field

The complete bibliographic citation or source attribution.

  • Required when the containing object is present.
stringApplication field

An HTTPS location where this source can be found.

  • Optional; omitted values remain unspecified.
stringApplication field

The main diagnosis or case theme that guides the scenario.

  • Optional; omitted values remain unspecified.
stringApplication field

The clinical specialty or specialties relevant to this scenario.

  • Optional; omitted values remain unspecified.
stringApplication field

The intended learner level and experience.

  • Optional; omitted values remain unspecified.
numberApplication field

The suggested scenario duration in minutes; this does not control the simulation clock.

  • Optional; omitted values remain unspecified.
stringApplication field

Spoiler-free title shown on Campus cards and in the scenario preview. For example: Penetrating chest injury. Copy chief complaint copies the first patient's complaint once; you can edit it without changing patient history. If omitted or blank, Campus shows Practice scenario.

  • Optional; omitted values remain unspecified.
stringApplication field

Brief introduction shown to learners before starting. Include only what they should know initially; omit diagnoses, expected actions, outcomes, and facilitator guidance. For example: A patient arrives after a penetrating injury to the right chest. If omitted, Campus shows no description.

  • Optional; omitted values remain unspecified.
objectApplication field

Optional learner-facing cover photo for Campus cards and scenario preview, separate from the patient portrait. Upload PNG, JPEG, or WebP; avoid images that reveal a diagnosis or expected action. Embedded bytes travel with the .usim file.

  • Optional; omitted values remain unspecified.
stringApplication field

Embedded PNG, JPEG, or WebP data URL populated by the cover photo upload control.

  • Required when the containing object is present.
stringApplication field

Accessible description of the cover photo for learners who cannot see it. Describe visible content without revealing the teaching point.

  • Required when the containing object is present.
arrayApplication field

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

  • Required when the containing object is present.
objectApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

The fictional patient's display name.

  • Required when the containing object is present.
stringApplication field

The name the patient asks others to use, when different from their display name. Omitted means unspecified. Builder displays this field in Communication while retaining its patient-level storage path.

  • Optional; omitted values remain unspecified.
stringApplication field

Usual mobility, cognition, self-care, and support. Distinguish baseline function from acute changes. Builder displays this field in expanded Demographics while retaining its patient-level storage path.

  • Optional; omitted values remain unspecified.
objectApplication field

Authored language, communication methods, interpreter needs, and accessibility supports. Do not infer these from identity or appearance. Builder places preferred name first, then preferred language and communication method together, followed by interpreter needs and communication supports. Rows stack at narrow widths.

  • Optional; omitted values remain unspecified.
stringApplication field

The patient's preferred language for this encounter. Do not infer fluency from ethnicity or name.

  • Optional; omitted values remain unspecified.
stringApplication field

Whether and how a qualified interpreter is needed, including spoken or signed language. Omitted means unspecified.

  • Optional; omitted values remain unspecified.
stringApplication field

How the patient communicates, such as speech, ASL, writing, or an augmentative device.

  • Optional; omitted values remain unspecified.
stringApplication field

Specific supports and interaction preferences, such as hearing aids, facing the patient, or caregiver participation.

  • Optional; omitted values remain unspecified.
objectApplication field

Optional age, gender, pronouns, sexual orientation, sex assigned at birth, height, and weight. Unspecified fields remain unknown; identity does not determine clinical behavior.

  • Optional; omitted values remain unspecified.
objectApplication field

Patient age with an explicit unit. Retain days or months for young infants.

  • Optional; omitted values remain unspecified.
valueApplication field

Age unit; preserve days or months when appropriate.

Allowed values

  • days
  • months
  • years
  • Required when the containing object is present.
objectApplication field

Patient weight, stored in kilograms. The editor can also display pounds.

  • Optional; omitted values remain unspecified.
objectApplication field

Patient height, stored in centimeters. The editor can also display feet and inches.

  • Optional; omitted values remain unspecified.
stringApplication field

The patient's authored pronouns. Never infer these from name, appearance, gender, or sex assigned at birth.

  • Optional; omitted values remain unspecified.
stringApplication field

Optional self-described sexual orientation. This does not specify sexual practices, anatomy, relationships, or pregnancy potential.

  • Optional; omitted values remain unspecified.
stringApplication field

Optional authored sex assigned at birth, separate from gender. Does not establish current anatomy, reproductive history, or treatment.

  • Optional; omitted values remain unspecified.
stringApplication field

Preferred height display unit in the scenario editor; the measurement remains stored in centimeters.

Allowed values

  • cm
  • in
  • ft-in
  • Optional; omitted values remain unspecified.
stringApplication field

Preferred weight display unit in the scenario editor; the measurement remains stored in kilograms.

Allowed values

  • kg
  • lb
  • Optional; omitted values remain unspecified.
arrayApplication field

The history available about this patient, including symptoms, background, medications, and allergies.

  • Optional; omitted values remain unspecified.
valueApplication field

Separate entries for chief-complaint, present-illness, medical, surgical, medication, allergy, family, and social history.

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

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • chief-complaint
  • present-illness
  • medical
  • surgical
  • medication
  • family
  • social
  • Required when the containing object is present.
objectApplication field

Structured allergy detail for category allergy only. Substance identifies the authored allergen; reaction describes the manifestation; severity describes that reaction, not future risk. Omitted reaction or severity remains unspecified.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • mild
  • moderate
  • severe
  • unknown
  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

Numeric physiologic state with explicit concepts and units; observations describe when values are measured or disclosed.

  • Optional; omitted values remain unspecified.
objectApplication field

One numeric physiologic variable belonging to this patient.

  • Required when the containing object is present.
stringApplication field

Stable variable identifier used by effects and observations.

  • Required when the containing object is present.
stringApplication field

The meaning of the variable, such as usim:hr for heart rate.

  • Required when the containing object is present.
numberApplication field

The initial numeric value in the declared unit.

  • Optional; omitted values remain unspecified.
stringApplication field

The unit of this value; core concepts use the standard unit defined by the specification.

  • Required when the containing object is present.
objectApplication field

The monitor configuration used to present patient observations.

  • Optional; omitted values remain unspecified.
stringApplication field

The ECG rhythm displayed on the monitor. Select the rhythm separately from whether the patient has a palpable pulse.

Allowed values

  • sinus
  • sinus_tachycardia
  • sinus_bradycardia
  • atrial_fibrillation
  • atrial_flutter
  • svt
  • ventricular_tachycardia
  • torsades
  • ventricular_fibrillation
  • asystole
  • av_block_1
  • av_block_2_mobitz_1
  • av_block_2_mobitz_2
  • av_block_3
  • junctional
  • ventricular_paced
  • Optional; omitted values remain unspecified.
booleanApplication field

Whether a palpable pulse is present. Use this to distinguish perfusing and pulseless presentations of the displayed rhythm.

  • Optional; omitted values remain unspecified.
objectApplication field

Connected channels expose available measurements without changing physiology. An explicit empty patient connection map starts disconnected. Omitted event channels inherit their preceding connection. Omitting the patient connection map makes available channels connected.

  • Optional; omitted values remain unspecified.
booleanApplication field

ECG: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Blood pressure cuff: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Pulse oximetry: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Respiratory monitoring: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Temperature probe: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Capnography: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Arterial pressure: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
valueApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

The required literal value "natural".

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
assets
arrayApplication field

Portable media manifest referenced by diagnostics and role outputs.

  • Optional; omitted values remain unspecified.
valueApplication field

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

  • Required when the containing object is present.
stringApplication field

Stable asset reference used by results and outputs.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

Creator and source credit.

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

Packaged accessible transcript; role filtering matches the original media.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

Patient to whom the observation belongs.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

Separates reported experience, observed findings, and measured values.

Allowed values

  • symptom
  • finding
  • measurement
  • Required when the containing object is present.
numberApplication field

Time of authored assessment or acquisition, possibly before baseline.

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

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

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • low
  • high
  • critical
  • none
  • not-interpreted
  • Optional; omitted values remain unspecified.
stringApplication field

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

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

  • Optional; omitted values remain unspecified.
stringApplication field

Fixed by the concept definition; no inferred conversions.

  • Optional; omitted values remain unspecified.
objectApplication field

The location, preparation, equipment, and people needed to deliver the simulation.

  • Required when the containing object is present.
stringApplication field

Where the scenario takes place and the relevant features of the care environment.

  • Required when the containing object is present.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

Portable learner role requirements. Counts are nonnegative with maxCount ≥ minCount; actual assignments belong to delivery records.

  • 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 Name for this entry. Omit optional information that has not been specified.

  • Required when the containing object is present.
integerApplication field

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

  • Required when the containing object is present.
integerApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

Pre-session tasks for the simulation center, each with a concrete action and setup outcome. Equipment and supplies belong in equipment.

  • Required when the containing object is present.
objectApplication field

One pre-session setup task with a concrete outcome, such as programming initial manikin observations or briefing an actor.

  • 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

One pre-session setup task with a concrete outcome, such as programming initial manikin observations or briefing an actor.

  • 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.
booleanApplication field

Whether Required applies. Omitted optional values remain unspecified.

  • Optional; omitted values remain unspecified.
arrayApplication field

The people portraying scenario roles, with their names, roles, and briefing instructions.

  • Optional; omitted values remain unspecified.
objectApplication field

One role-player's identity, role in the case, and instructions for responding to learners.

  • 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

The character's name or role-player label used to identify this actor.

  • Required when the containing object is present.
stringApplication field

The character's relationship to the patient or care team, such as parent, bedside nurse, or consultant.

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

Explicit trigger and repeat bound. Display sends authored text; facilitator means a prompt for a human actor.

  • 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.conditions entry. Preserve the referenced entry when editing this field.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • facilitator
  • display
  • Required when the containing object is present.
stringApplication field

Tell the actor what they know, how to behave, what to disclose, and how to respond to likely learner actions.

  • Required when the containing object is present.
objectApplication field

Optional authored age and gender for voice casting. Omit unknown details; voice uses a neutral adult default.

  • Optional; omitted values remain unspecified.
objectApplication field

The character's authored age quantity, used to guide natural voice delivery without exaggeration.

  • Optional; omitted values remain unspecified.
stringApplication field

The character's authored gender, used for default voice selection. Never inferred from their name or occupation.

  • Optional; omitted values remain unspecified.
arrayApplication field

Ordered steps to restore equipment, media, supplies, and actor starting conditions.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
arrayApplication field

The equipment and supplies needed to run the scenario.

  • Optional; omitted values remain unspecified.
stringApplication field

One item of equipment or supplies needed for the session, with configuration or an acceptable substitute when useful.

  • Required when the containing object is present.
objectApplication field

The patient model and scene configuration shown during the simulation.

  • Optional; omitted values remain unspecified.
stringApplication field

The URL of the patient model to load in the 3D scene. Use a model accessible to the simulation viewer.

  • Required when the containing object is present.
stringApplication field

Credit the model creator and record the source and license or permission to use it.

  • Required when the containing object is present.
arrayApplication field

Clickable locations on the patient model, each linked to an existing learner interaction.

  • Required when the containing object is present.
objectApplication field

One interaction hotspot with an action, a model-space position, and an outward-facing direction.

  • Required when the containing object is present.
stringApplication field

The existing learner action to invoke when this hotspot is selected; scheduled transitions cannot be selected.

  • Required when the containing object is present.
stringApplication field

Hotspot location as three space-separated model-space coordinates (x y z), for example 0m 1m 0m.

  • Required when the containing object is present.
stringApplication field

Hotspot surface direction as three space-separated vector components (x y z), for example 0 0 1.

  • Required when the containing object is present.
objectApplication field

Learning goals, learner preparation, assessment criteria, and guidance for reflection after the case.

  • Required when the containing object is present.
stringApplication field

Explain why this case is educationally useful and how its decisions and challenges support the learning objectives.

  • Optional; omitted values remain unspecified.
arrayApplication field

Preparation activities and learner or facilitator materials. Asset references retain the source documents. Builder groups prerequisite instructions and documents in Teaching context alongside the educational rationale.

  • Optional; omitted values remain unspecified.
objectApplication field

Preparation activities and packaged resources, with an explicit audience for each item. Instructions may use Markdown for formatted module directions and links; assetIds reference packaged learning documents. This describes preparation, not completion tracking or an enforced start gate. Builder presents prerequisite instructions and documents in Teaching context alongside the educational rationale.

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

Rich-text instructions stored as Markdown for knowledge, skills, modules, or preparation learners should complete before starting.

  • Required when the containing object is present.
arrayApplication field

Entries for Supporting materials. 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.
arrayApplication field

The observable knowledge, skills, or behaviors learners should demonstrate.

  • Required when the containing object is present.
objectApplication field

One observable learning goal, using an action verb such as recognize, assess, communicate, or initiate.

  • Required when the containing object is present.
stringApplication field

A stable objective identifier. Preserve it when editing or reordering the objective.

  • Required when the containing object is present.
stringApplication field

An observable learning outcome, using an action verb such as recognize, assess, communicate, or initiate.

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

Optional author-selected ACGME core competency codes. Omitted or empty means unmapped. This is not a Milestone level or a judgment of competence. Do not infer mappings from source text that does not explicitly supply them.

  • Optional; omitted values remain unspecified.
valueApplication field

One of the six ACGME core domain codes: PC, MK, PBLI, ICS, PROF, or SBP. Each code may appear only once per objective.

Allowed values

  • PC
  • MK
  • PBLI
  • ICS
  • PROF
  • SBP
  • Required when the containing object is present.
valueApplication field

Optional classification for discovery; it does not select a scoring algorithm.

Allowed values

  • knowledge
  • reasoning
  • technical-skill
  • communication
  • teamwork
  • professionalism
  • systems
  • Optional; omitted values remain unspecified.
objectApplication field

Observable behavior, conditions of performance, and acceptable standard. Team evidence cannot be attributed automatically to each individual.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • individual
  • team
  • Required when the containing object is present.
objectApplication field

Curriculum or competency references; mappings are author assertions, not accreditation or equivalence. ACGME core competency mappings use framework https://www.acgme.org/programs-and-institutions/programs/common-program-requirements/, version core-competencies-2026-09, and codes PC, MK, PBLI, ICS, PROF, SBP. Specialty-specific Milestones require their own framework and version; do not infer levels from scenario scores.

  • Required when the containing object is present.
stringApplication field

Learner-facing statement of the task or objective. Facilitator success criteria may contain spoilers and are not included implicitly.

  • Optional; omitted values remain unspecified.
arrayApplication field

Reflection prompts stored as a canonical array supporting multiple records. Builder provides a single primary Debrief prompt editor without add/remove controls. Additional existing records retain their IDs, questions, objective references, and facilitator notes; these additional details are preserved in scenario data and are not displayed in the Builder.

  • Required when the containing object is present.
objectApplication field

One reflection prompt with a stable ID and optional objective references and facilitator notes. Builder edits the primary question in the single Debrief prompt field and preserves additional existing questions and notes in scenario data without displaying them in the Builder.

  • 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 education.objectives entry. Preserve the referenced entry when editing this field.

  • Required when the containing object is present.
stringApplication field

A prompt for facilitated reflection after the scenario. Formatting is stored as Markdown.

  • Required when the containing object is present.
arrayApplication field

The authored criteria used to assess learner performance.

  • Optional; omitted values remain unspecified.
objectApplication field

One scored criterion linking an observable skill to a recorded action, with points and debrief feedback.

  • Required when the containing object is present.
stringApplication field

Optional link to the stable ID of a structured learning objective. Multiple criteria may support one objective. No link means unspecified, never a failed objective.

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

Name the observable skill or objective being assessed, such as recognizing deterioration.

  • Required when the containing object is present.
stringApplication field

Select the learner action that earns credit for this criterion. Scheduled transitions cannot earn action credit.

  • Required when the containing object is present.
stringApplication field

Single equivalent resource. Used when objectIds is omitted; the required action's linked resource is used when both are omitted.

  • Optional; omitted values remain unspecified.
arrayApplication field

Alternative learner-requestable resources that earn credit for this criterion. Any selected request qualifies, using the earliest request time regardless of result delay. Points are awarded once. Omit to use objectId or the required action's linked resource when present.

  • Optional; omitted values remain unspecified.
stringApplication field

The identifier of a learner-requestable resource accepted as an alternative for this assessment criterion.

  • Required when the containing object is present.
numberApplication field

The weight of this criterion in the total score, from 1 to 100. Credit is awarded once when the criterion is met.

  • Required when the containing object is present.
numberApplication field

Latest qualifying action time in seconds from the start of the run, inclusive. Omit to assess the action without a deadline.

  • Optional; omitted values remain unspecified.
stringApplication field

Explain the expected behavior, why it matters, and what to discuss when the action is completed or missed.

  • Required when the containing object is present.
stringApplication field

An HTTPS link to learning material relevant to this criterion, such as a guideline or teaching resource.

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

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

  • Required when the containing object is present.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • 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.
booleanApplication field

Whether initial value applies. Omitted optional values remain unspecified.

  • Required when the containing object is present.
arrayApplication field

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • 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.
arrayApplication field

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

  • Required when the containing object is present.
valueApplication field

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

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

  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • eq
  • ne
  • lt
  • lte
  • gt
  • gte
  • Required when the containing object is present.
arrayApplication field

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

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

  • Required when the containing object is present.
stringApplication field

Named event allows explicit cancellation.

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

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

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

  • Required when the containing object is present.
numberApplication field

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

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

  • Optional; omitted values remain unspecified.
integerApplication field

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

  • Required when the containing object is present.
arrayApplication field

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

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

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

  • Optional; omitted values remain unspecified.
objectApplication field

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

  • Optional; omitted values remain unspecified.
integerApplication field

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

  • Required when the containing object is present.
objectApplication field

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

  • Required when the containing object is present.
stringApplication field

The required literal value "scenario-start".

  • Required when the containing object is present.
valueApplication field

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

Allowed values

  • cancel
  • continue
  • Optional; omitted values remain unspecified.
arrayApplication field

Named reusable effects that change scenario state or disclosure.

  • Optional; omitted values remain unspecified.
valueApplication field

One typed effect with a stable identifier and explicit target.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

The operation performed by this effect.

  • Required when the containing object is present.
stringApplication field

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

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • 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 model id for this entry. Omit optional information that has not been specified.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • ecg
  • bloodPressure
  • spo2
  • respiration
  • temperature
  • capnography
  • arterialPressure
  • Optional; omitted values remain unspecified.
arrayApplication field

Patient phases in the scenario. Baseline contains starting conditions only. Newly authored milestones advance to distinct non-baseline phases even with unchanged vitals; do not return to baseline. Include exactly one baseline and at least one conclusion; connect phases with interactions.

  • Required when the containing object is present.
objectApplication field

One phase of the case, with learner information, tutor guidance, and any changed patient observations.

  • 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

A short name for this phase, such as Initial assessment or Worsening respiratory distress.

  • Required when the containing object is present.
stringApplication field

Guard checked immediately before entry. Failed manual transitions are rejected; scheduled failures are recorded and skipped.

  • Optional; omitted values remain unspecified.
stringApplication field

Must hold to leave the phase; does not cause a transition by itself.

  • Optional; omitted values remain unspecified.
arrayApplication field

Ordered effect identifiers applied when this state is entered.

  • Optional; omitted values remain unspecified.
stringApplication field

An effect applied at this position in the state’s entry sequence.

  • Required when the containing object is present.
arrayApplication field

Ordered effect identifiers applied when this state is exited; execution requires support for exit effects.

  • Optional; omitted values remain unspecified.
stringApplication field

An effect applied at this position in the state’s exit sequence.

  • Required when the containing object is present.
stringApplication field

Information presented to the learner at this phase: the patient's condition, new findings, or an immediate task. Keep tutor instructions and unrevealed answers in the tutor prompt.

  • Required when the containing object is present.
stringApplication field

Guide the tutor through this phase: expected learner actions, cues to offer if learners struggle, and when and why to advance. Include relevant reasoning and facilitation instructions.

  • Required when the containing object is present.
arrayApplication field

Links the phase to an educational objective.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

Baseline starts the case; triggered and scheduled describe intermediate phases; conclusion ends the run. A scheduled phase still needs an incoming timed interaction.

Allowed values

  • baseline
  • phase
  • conclusion
  • Required when the containing object is present.
objectApplication field

Monitor rhythm, pulse status, and channel connection overrides for this phase. Connection-only overrides preserve the preceding rhythm; omitted channels keep their preceding connection.

  • Optional; omitted values remain unspecified.
stringApplication field

The ECG rhythm displayed on the monitor. Select the rhythm separately from whether the patient has a palpable pulse.

Allowed values

  • sinus
  • sinus_tachycardia
  • sinus_bradycardia
  • atrial_fibrillation
  • atrial_flutter
  • svt
  • ventricular_tachycardia
  • torsades
  • ventricular_fibrillation
  • asystole
  • av_block_1
  • av_block_2_mobitz_1
  • av_block_2_mobitz_2
  • av_block_3
  • junctional
  • ventricular_paced
  • Optional; omitted values remain unspecified.
booleanApplication field

Whether a palpable pulse is present. Use this to distinguish perfusing and pulseless presentations of the displayed rhythm.

  • Optional; omitted values remain unspecified.
objectApplication field

Connected channels expose available measurements without changing physiology. An explicit empty patient connection map starts disconnected. Omitted event channels inherit their preceding connection. Omitting the patient connection map makes available channels connected.

  • Optional; omitted values remain unspecified.
booleanApplication field

ECG: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Pulse oximetry: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Respiratory monitoring: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Temperature probe: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Mark an educationally important phase. This does not award points or require every path to pass through the phase.

  • Optional; omitted values remain unspecified.
objectApplication field

Enter this event once when selected learner-requested resource results become available. Incoming transitions remain alternative paths into the event.

  • Optional; omitted values remain unspecified.
stringApplication field

All waits for every selected resource result; any enters on the first selected result. Requests alone do not satisfy the rule until their response delays elapse.

Allowed values

  • any
  • all
  • Required when the containing object is present.
arrayApplication field

Scenario resources whose completed results trigger this event. Select learner-requestable resources without a separate resource destination event.

  • Required when the containing object is present.
arrayApplication field

Connections between phases, activated by a learner action or a timer measured from entry into the source phase.

  • Required when the containing object is present.
objectApplication field

One transition from a source phase to a destination, including its explicit learner choice or timer. Author resource links and patient changes on the destination state.

  • 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

Use a short, observable action or timed-event label: 2–6 words, at most 48 characters. Put conditions, clinical detail, and what happens in description, not in the label. Do not append the destination state; from/to already identify it.

  • Required when the containing object is present.
stringApplication field

Longer explanation of the action or timed event, its conditions, and what happens. Plain-language context only; executable behavior remains in the selected trigger, timing, resource references, and destination state. Text does not automatically detect learner behavior. Optional when the label provides sufficient context.

  • Optional; omitted values remain unspecified.
stringApplication field

Required when the action targets a patient; omit for team-only actions.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

Describe the learner intent or behavior that fulfills this action. The AI interprets chat, conversation context, and simulator interactions against this criterion; equivalent wording is accepted. Distinguish an order from actual administration, and specify essential requirements. If omitted, the action label and description provide the criterion. Only available authored actions can advance the case; ambiguous intent requires clarification.

  • Optional; omitted values remain unspecified.
objectApplication field

Recognize this action from learner-requested resources while its source state is active. Any completes on the first selected request; all waits for all selected requests. Result delays do not delay action completion. Facilitators can confirm the same action directly. Confirming all requests every selected resource; confirming any does not guess which alternative was used. Omitted uses AI interpretation of completionCriteria (or label and description) or explicit confirmation.

  • Optional; omitted values remain unspecified.
stringApplication field

Choose whether any or all selected resource requests complete this action.

Allowed values

  • any
  • all
  • Required when the containing object is present.
arrayApplication field

Select the resources that define the learner activity, such as BMP and CBC for Order labs. Only learner-requestable resources qualify. Automatic state releases do not count.

  • Required when the containing object is present.
arrayApplication field

The phase in which this interaction is available or its scheduled timer begins.

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

Prerequisite evaluated at start and again at completion.

  • Optional; omitted values remain unspecified.
numberApplication field

Simulated time between start and completion. Availability is evaluated at start.

  • Optional; omitted values remain unspecified.
objectApplication field

Completed uses count against maxUses; cooldown starts at completion. No implicit unlimited repeats.

  • Optional; omitted values remain unspecified.
integerApplication field

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

  • Optional; omitted values remain unspecified.
booleanApplication field

Whether an operator can cancel before completion; cancellation does not count as a completed use.

  • Optional; omitted values remain unspecified.
valueApplication field

Policy for unfinished work when another event changes phase. Conclusion always cancels.

Allowed values

  • cancel
  • continue
  • Optional; omitted values remain unspecified.
arrayApplication field

The phase entered when this interaction occurs. Set scenario-specific vitals, rhythm, and patient information here; reusable treatment responses stay with resources. Destination vital signs override overlapping transition effects.

  • Required when the containing object is present.
objectApplication field

Choose first matching outcome at completion. Exactly one final unconditional fallback is required. Omit nextStateId to stay in the phase.

  • 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.conditions entry. Preserve the referenced entry when editing this field.

  • Optional; omitted values remain unspecified.
arrayApplication field

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

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

Discriminator for conditional action payloads. Specialized fields are prohibited unless kind selects the corresponding branch.

Allowed values

  • generic
  • medication-order
  • medication-administration
  • Optional; omitted values remain unspecified.
objectApplication field

Quantity is { value: positive number, unit: string }. Units are explicit; route must belong to allowedRoutes.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
objectApplication field

Structured numerator details. Omitted optional values remain unspecified.

  • Required when the containing object is present.
stringApplication field

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

  • Required when the containing object is present.
valueApplication field

Administration is a separate observable action referencing an order, not an automatic consequence of writing it.

  • Optional; omitted values remain unspecified.
valueApplication field

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

Allowed values

  • bolus
  • infusion-stop
  • Required when the containing object is present.
objectApplication field

Explicit amount per time or volume per time. No implicit unit conversion or pump calculation.

  • Optional; omitted values remain unspecified.