objectApplication field
Case identification, authorship, and the teaching context used to find and select this scenario.
- Required when the containing object is present.
ReferenceScenario content
Scenario content
Metadata and authors
Identity, diagnostic context, and the people who created the scenario.
Format definition
Separate content identity, contributor credit, revision history, and clinical review.
Scenario standard · Execution capabilities
Suggested reuse licenses
Builder offers searchable suggestions with brief explanations and original-license links. The identifier remains open text; custom rights statements are valid. Read the original terms for the complete conditions.
| Identifier | Brief explanation | Original terms |
|---|---|---|
| All rights reserved | Copyright is retained. Reuse requires permission unless an applicable exception allows it. | No standard license text; explicit rights statement |
| CC BY 4.0 | Share and adapt, including commercially, with credit to the creator. | Read original terms |
| CC BY-SA 4.0 | Share and adapt with credit, including commercially. Adaptations use the same or compatible license. | Read original terms |
| CC BY-NC 4.0 | Share and adapt with credit for noncommercial purposes only. | Read original terms |
| CC BY-NC-SA 4.0 | Share and adapt with credit for noncommercial purposes. Adaptations use the same or compatible license. | Read original terms |
| CC BY-ND 4.0 | Share unchanged copies with credit, including commercially. Adaptations cannot be distributed. | Read original terms |
| CC BY-NC-ND 4.0 | Share unchanged copies with credit for noncommercial purposes only. Adaptations cannot be distributed. | Read original terms |
| CC0 1.0 | Waive copyright to the extent allowed by law. Others may copy, adapt, and share, including commercially, without permission. | Read original terms |
Parameters
metadata.title
string
Required
The internal case title used by authors. Campus uses the separate learner title.
metadata.summary
string
Required
The internal scenario premise, scope, and intended learning activity. This summary is not shown in Campus.
metadata.learnerTitle
string
Optional; omitted means unspecified
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.
metadata.learnerDescription
string
Optional; omitted means unspecified
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.
metadata.coverPhoto
object
Optional; omitted means unspecified
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.
metadata.coverPhoto.dataUrl
string
Required
Embedded PNG, JPEG, or WebP data URL populated by the cover photo upload control.
metadata.coverPhoto.description
string
Required
Accessible description of the cover photo for learners who cannot see it. Describe visible content without revealing the teaching point.
metadata.contributors[]
object
Optional; omitted means unspecified
A named contributor with stable identity and credited roles.
metadata.revision
integer
Required
The authored content revision, independent of a storage revision identifier.
metadata.license
object
Required
The terms under which this scenario may be reused.
metadata.review
object
Required
Clinical review status, attribution, date, and supporting sources.
metadata.license.identifier
string
Required
The license identifier or explicit rights statement. Suggested reuse licenses are advisory; preserve custom terms.
metadata.license.textAssetId
string
Optional; omitted means unspecified
An optional asset containing the complete license text.
metadata.review.status
"draft" | "reviewed" | "needs-review"
Required
Review state stored as draft, reviewed, or needs-review. Builder displays Draft, Reviewed, and Needs review.
metadata.review.reviewedAt
string
Optional; omitted means unspecified
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.
metadata.review.reviewerIds
string[]
Required
Contributor identifiers for the reviewers.
metadata.review.sourceIds
string[]
Required
Stable metadata.sources IDs selected as evidence for the recorded review. Citation edits and source reordering preserve these links.
metadata.sources[]
object
Optional; omitted means unspecified
A source citation with stable identity and optional web location.
metadata.sources[].id
string
Required
Stable source identifier used by review references.
metadata.sources[].citation
string
Required
The complete bibliographic citation or source attribution.
metadata.sources[].url
string
Optional; omitted means unspecified
An HTTPS location where this source can be found.
metadata.sources[].accessedAt
string
Optional; omitted means unspecified
The date the linked source was accessed.
Behavior and validation
- Builder presents Learner-facing details expanded immediately after Scenario context in Overview. Copy chief complaint copies the first patient's complaint once into learnerTitle; later edits do not change history. Copy scenario description copies metadata.summary once into learnerDescription. Both copy actions sit inside their controls; description copy shares the dictation action row. Learner fields are optional for backward-compatible import and export. Campus cards and preview use these fields without falling back to internal authoring title or summary. Campus preview omits role; learner preparation instructions and documents appear only when defined in scenario prerequisites.
- License suggestions are advisory, not a required enum. New blank scenarios start with All rights reserved. Opening, importing, or editing existing content preserves its authored license identifier and optional textAssetId; selecting a suggestion changes only the identifier.
- Review status is stored as draft, reviewed, or needs-review; Builder capitalizes the labels without changing those values. Choosing a status or timestamp does not assign reviewers or certify the content.
- Builder's Reviewed at selector uses the author's local date and time and serializes the selected instant as a UTC ISO 8601 timestamp. Now records the current instant; Clear removes the optional timestamp. Preserve existing authored timestamps on import and export.
- Source records stay in the ordered metadata.sources array. Builder presents them inside Review sources in Review status and evidence. Add source creates a stable source ID, selects it as review evidence, and opens its accordion; it does not create a separate empty Sources panel.
- metadata.review.sourceIds selects evidence by stable source ID. Use as review evidence changes only membership. Renaming, editing, or reordering a source preserves its ID and existing review/resource links. Deleting a source in Builder removes that ID from review and resource sourceIds to avoid dangling references.
- Changing clinical behavior after review changes status to needs-review in the authoring workflow. Review metadata never grants automatic publication approval.
- Contributor contact details are optional extensions rather than required portable fields. Use fictional patients and keep actual learners out of scenario content.
Shared format conventions · All format elements · Download specification
Field reference
36 records in this view
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.
stringApplication field
One credited contribution role.
- Required when the containing object is present.
stringApplication field
The contributor’s organization or institutional affiliation.
- Optional; omitted values remain unspecified.
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.
stringApplication field
A source cited by this review.
- 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 date the linked source was accessed.
- 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.