Skip to documentation
ReferencePatient

Patient

History

Presenting concerns and the context learners need to uncover.

Format definition

Make patient information discoverable, with an explicit timeline and disclosure rules.

Portable format · Suite implementation support

Parameters

patients[].history[]

{ id: ID, category: enum, content: string, disclosure: Disclosure, occurredAtSeconds?: number, allergy?: Allergy }

Optional; default []

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

patients[].history[].allergy

{ substance: string, reaction?: string, severity?: mild | moderate | severe | unknown }

Optional; omitted means unspecified

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.

patients[].history[].occurredAtSeconds

finite number

Optional; omitted means unspecified

Time relative to scenario start; negative values describe pre-arrival events.

patients[].history[].disclosure.audience

(learner | facilitator)[]

Required; nonempty

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

patients[].history[].disclosure.mode

initial | on-action | on-condition | facilitator

Required

Initial reveals at baseline; other modes require an action, condition, or facilitator release.

patients[].history[].disclosure.actionId

Action ID

Required only for on-action

Successful completion of this action reveals the entry.

patients[].history[].disclosure.conditionId

Condition ID

Required only for on-condition

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

Behavior and validation

  • Disclosure is a shared structure for history, observations, and result interpretations. Once revealed, content stays available.
  • Store unknown allergy status explicitly as content. An empty allergy category means no entry was authored, not no known allergies.
  • The optional allergy object is permitted only on allergy history entries and follows the entry disclosure rules. Keep unknown status explicit; do not invent a substance for a no-known-allergy statement. Severity is mild, moderate, severe, or unknown; omission means unspecified.

Shared format conventions · All format elements · Download specification

Field reference

16 records in this view
objectApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

The main symptom or concern prompting care, ideally in the patient's own words. This is the scenario title shown to learners.

  • Optional; omitted values remain unspecified.
stringApplication field

Describe symptom onset, progression, associated symptoms, relevant negatives, and treatment before arrival.

  • Optional; omitted values remain unspecified.
arrayApplication field

Relevant diagnoses and comorbidities, one condition per entry. Include details that affect decisions in this case.

  • Optional; omitted values remain unspecified.
stringApplication field

One prior diagnosis or ongoing condition, with relevant severity or treatment.

  • Required when the containing object is present.
arrayApplication field

Previous operations or procedures relevant to the case, with timing and complications when useful.

  • Optional; omitted values remain unspecified.
stringApplication field

One previous operation or procedure, including its approximate date and relevant outcome.

  • Required when the containing object is present.
arrayApplication field

Medications taken before this encounter. Include dose, route, frequency, and adherence when relevant.

  • Optional; omitted values remain unspecified.
stringApplication field

One home medication, using its generic name and relevant dose, route, and frequency.

  • Required when the containing object is present.
arrayApplication field

Known allergies and reactions. Distinguish no known allergies from an unknown allergy history.

  • Optional; omitted values remain unspecified.
valueApplication field

One allergy as text or as a substance, reaction, and severity record.

  • Required when the containing object is present.
stringApplication field

What happened after exposure, such as hives or wheezing. State when the reaction is unknown.

  • Optional; omitted values remain unspecified.
stringApplication field

The reported severity of the allergic reaction; choose unknown when it has not been established.

Allowed values

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

Family conditions or inherited risks relevant to the presentation; include pertinent negative history.

  • Optional; omitted values remain unspecified.
stringApplication field

Living situation, supports, occupation, exposures, and substance use relevant to care.

  • Optional; omitted values remain unspecified.