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.

Portable format · Suite implementation support

Parameters

metadata.title

string

Required

Human-readable case title; use a neutral title when a diagnosis would reveal the teaching point.

metadata.summary

string

Required

Premise, audience, and scope of the exercise.

metadata.contributors[]

{ id: ID, name: string, roles: string[], affiliation?: string }

Required; at least one

Structured attribution permits authors, reviewers, illustrators, and editors without importing account permissions.

metadata.revision

positive integer

Required

Content revision counter within scenarioId; does not substitute for a package digest.

metadata.license

{ identifier: string, textAssetId?: ID }

Required

Explicit reuse terms; custom terms may reference a packaged text asset.

metadata.review

{ status: enum, reviewedAt?: ISO date, reviewerIds: ID[], sourceIds: ID[] }

Required

Status is draft, reviewed, or needs-review. Reviewed requires a date and at least one contributor and source reference; this records author assertions, not external certification.

metadata.sources[]

{ id: ID, citation: string, url?: HTTPS URL, accessedAt?: ISO date }

Required; may be empty for an unreviewed draft

Named references support traceable clinical and educational content.

Behavior and validation

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