Skip to documentation
ReferenceScenario content

Scenario content

Education and objectives

Keep learning intent beside the scenario behavior.

Format definition

Define the learning audience, preparation, observable objectives, assessment evidence, facilitation, and transfer to practice.

Portable format · Suite implementation support

Parameters

education.rationale

string

Optional; omitted means unspecified

Why this learning need warrants the exercise; describe intended learning without claiming demonstrated effectiveness.

education.audience

{ professions: string[], learnerLevels: string[], prerequisites: string[] }

Optional; omitted means unspecified

Authored audience and entry knowledge or skills. Use locally meaningful levels; an empty prerequisite list explicitly means none are authored.

education.sessionPlan

{ modality: facilitated | self-directed | hybrid, participantCount: { min: positive integer, max: positive integer }, phases: SessionPhase[] }

Optional; omitted means unspecified

SessionPhase is { id: ID, kind: preparation | prebrief | scenario | debrief | follow-up, durationMinutes: positive number, guidance: string }. Phases are ordered; durations are planning estimates in wall-clock minutes, not simulated event deadlines.

education.preparation[]

{ id: ID, audience: learner | facilitator, instructions: string, assetIds: Asset ID[] }

Optional; omitted means unspecified

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. Suite implements the corresponding authoring surface as education.prerequisites and embedded education.prerequisiteDocuments in its application schema.

education.objectives[].domain

knowledge | reasoning | technical-skill | communication | teamwork | professionalism | systems

Optional; omitted means unspecified

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

education.objectives[].performance

{ context: string, expectedBehavior: string, successCriteria: string, scope: individual | team }

Optional; omitted means unspecified

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

education.objectives[].curriculumMappings[]

{ framework: URI, version: string, code: string, label: string }

Optional; omitted means unspecified

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.

education.objectives[].learnerBrief

string

Optional; omitted means unspecified

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

education.rubrics[].observationGuide

{ opportunity: string, acceptableAlternatives: string[], limitations: string, calibration: string }

Optional; omitted means unspecified

Define when evidence is available, alternative valid approaches, what the method cannot establish, and how raters align their judgments.

education.assessmentPlan

{ purpose: practice | formative | summative, feedbackTiming: during | after | both, interpretation: string }

Optional; omitted means unspecified

Intended use and limits of the evidence. Summative intent alone does not supply validation, a pass rule, or authority to make a credentialing decision.

education.facilitation

{ cuePolicy: string, pauseAndResume: string, repeatPolicy: string, adaptations: string[] }

Optional; omitted means unspecified

Guidance for assistance, interruption, deliberate practice, and access needs. Record actual adaptations separately in the delivery record.

education.debriefPlan

{ approach: string, phases: DebriefPhase[], takeHomeMessages: string[] }

Optional; omitted means unspecified

DebriefPhase is { id: ID, title: string, promptIds: DebriefPrompt ID[] }. Phases and their prompt references are ordered; name a method only when the author intends that method.

education.followUp[]

{ id: ID, objectiveIds: Objective ID[], activity: string, evidence: string, assetIds: Asset ID[] }

Optional; omitted means unspecified

Planned remediation, repeated practice, or transfer activity and what would demonstrate progress. Actual completion stays in learning records.

education.objectives[]

{ id: ID, statement: string, evidenceActionIds: Action ID[], rubricIds: Rubric ID[] }

Required; nonempty

Observable outcome with explicit event evidence and assessment references.

education.rubrics[]

{ id: ID, objectiveId: Objective ID, evidence: facilitator | event, levels: RubricLevel[] }

Required; may be empty

RubricLevel is { id: ID, label: string, description: string, score?: number }; describe observable performance before assigning any number.

education.cues[]

{ id: ID, objectiveId: Objective ID, conditionId?: Condition ID, text: string, level: prompt | hint | direct, delivery: facilitator | display }

Required; may be empty

Ordered assistance ladder. Record cue ID, delivery time, and operator in the run, not the scenario.

education.endings[]

{ id: ID, label: string, outcome: complete | incomplete | alternative, debriefPromptIds: ID[] }

Required; nonempty

Intentional endpoints distinguish task closure from assessment scores.

education.debriefPrompts[]

{ id: ID, objectiveIds: Objective ID[], question: string, facilitatorRationale: string }

Required; nonempty

Targeted reflection connected to the experience and learning purpose.

education.prebrief

string

Required

Learner-facing orientation covering roles, equipment limitations, help requests, confidentiality expectations, assessment purpose, and the right to pause. Do not promise confidentiality beyond local policy.

education.stopConditions

string[]

Required; nonempty

Human-readable reasons for a facilitator to pause or stop; actual interruption and reason are runtime records.

Behavior and validation

  • All objective, rubric, cue, ending, debrief, and follow-up references resolve to their declared entity type. Reference lists contain no duplicates. Each rubric appears in its objective rubricIds, and each listed rubric points back to that same objective. Rubric levels are nonempty and have globally unique IDs.
  • An objective may be ungraded: an empty rubricIds list declares no authored rating, not successful performance. Facilitator evidence may use an empty evidenceActionIds list. Event rubrics require at least one evidence action on their objective; multiple action references identify candidate evidence, not an implicit all/any success predicate.
  • Rubric levels describe distinguishable observed performance. Their order and optional finite scores do not imply a selection algorithm. Not observed, not applicable, and interrupted are delivery-record statuses, not lowest-level ratings or zero scores. Missing evidence cannot silently become failure.
  • Conditions make cues eligible, not delivered. Omitted conditionId means facilitator selection; display delivery requires a conditionId and an execution profile defining timing, repetition, and suppression. Preserve authored cue order, record assistance separately, and never infer an uncued attempt merely because no delivery record was captured.
  • participantCount.min must not exceed max. A supplied sessionPlan or debriefPlan contains at least one phase. Follow-up objectiveIds and debrief prompt objectiveIds are nonempty. Phase IDs obey the document-wide ID rules. Planning phases do not schedule runtime events.
  • Prebrief and objective learnerBrief are learner-facing. Preparation follows its declared audience. Rationale, performance criteria, rubrics, cue text before delivery, ending outcomes, debrief rationales, facilitation, and assessment interpretation are facilitator-only by default. Release debrief questions and follow-up activities through an explicit delivery view; includeIds never overrides audience restrictions.
  • Interruption is separate from an authored ending and from an assessment result. A complete ending means the authored task closed; it does not establish that objectives were met. Repeated attempts retain separate evidence, assistance, and adaptation records rather than overwriting earlier performance.
  • Keep learner identities, rater identities, selected levels, actual timing, feedback, recordings, and progress outside the portable scenario. Delivery records identify scenarioId and metadata.revision; comparisons must account for changes in objectives, rubric anchors, assistance, or adaptations.
  • These fields define portable educational content. They do not add Suite Builder controls, execute rubric scoring, or validate educational outcomes. Consumers must report unsupported content and preserve it or explicitly report export loss; they must not silently flatten structured objectives into equivalent-looking scored criteria.
  • Do not infer competence solely from a transition. Event evidence can establish that an action occurred; quality of communication or procedure performance may require facilitator judgment.
  • Scores are optional per rubric level. No universal total, weights, pass threshold, or negative reward is implied; the assessment policy must define aggregation explicitly.
  • Acceptable alternatives belong in rubric level descriptions and outcome branches. Cue-assisted completion remains distinguishable from independent performance.

Shared format conventions · All format elements · Download specification

Field reference

29 records in this view
objectApplication field

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

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

  • Optional; omitted values remain unspecified.
stringApplication field

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

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

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

  • Required when the containing object is present.
stringApplication field

Who the scenario is designed for, including profession, training stage, and team composition.

  • Optional; omitted values remain unspecified.
stringApplication field

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

  • Optional; omitted values remain unspecified.
arrayApplication field

Downloadable learning materials attached by the author for learners to complete before starting. This does not track completion.

  • Optional; omitted values remain unspecified.
objectApplication field

One preparation document with an identifier, filename, and embedded file content.

  • 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

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.