Skip to documentation
.usim
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.

Scenario standard · Execution capabilities

Parameters

patients[].history[]

object

Optional; omitted means unspecified

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

patients[].history[].allergy

object

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

number

Optional; omitted means unspecified

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

patients[].history[].disclosure.audience

"learner" | "facilitator"[]

Optional; omitted means unspecified

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

patients[].history[].disclosure.mode

"initial" | "facilitator"

Optional; omitted means unspecified

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

patients[].history[].disclosure.actionId

string

Optional; omitted means unspecified

Successful completion of this action reveals the entry.

patients[].history[].disclosure.conditionId

string

Optional; omitted means unspecified

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

17 records in this view
patients.*.history
arrayApplication field

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

  • Optional; omitted values remain unspecified.
patients.*.history.*
valueApplication field

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

  • Required when the containing object is present.
patients.*.history.*.id
stringApplication field

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

  • Required when the containing object is present.
patients.*.history.*.content
stringApplication field

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

  • Required when the containing object is present.
patients.*.history.*.disclosure
valueApplication field

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

  • Required when the containing object is present.
patients.*.history.*.disclosure.audience.*
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.
patients.*.history.*.disclosure.mode
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.
patients.*.history.*.disclosure.resourceId
stringApplication field

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

  • Optional; omitted values remain unspecified.
patients.*.history.*.category
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.
patients.*.history.*.allergy
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.
patients.*.history.*.allergy.substance
stringApplication field

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

  • Required when the containing object is present.
patients.*.history.*.allergy.reaction
stringApplication field

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

  • Optional; omitted values remain unspecified.
patients.*.history.*.allergy.severity
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.
Compatibility and current support