Skip to documentation
.usim
ReferencePatient

Patient

Patient demographics

Describe the fictional person at the center of the case.

Format definition

Represent multiple fictional patients without ambiguous age units or demographic assumptions.

Scenario standard · Execution capabilities

Parameters

patients[].id

string

Required

Stable patient identifier used by observations, actions, and other scenario references.

patients[].name

string

Required

The fictional patient's display name.

patients[].demographics.age

object

Optional; omitted means unspecified

Patient age with an explicit unit. Retain days or months for young infants.

patients[].demographics.gender

string

Optional; omitted means unspecified

The patient's authored gender description.

patients[].demographics.pronouns

string

Optional; omitted means unspecified

The patient's authored pronouns. Never infer these from name, appearance, gender, or sex assigned at birth.

patients[].demographics.sexualOrientation

string

Optional; omitted means unspecified

Optional self-described sexual orientation. This does not specify sexual practices, anatomy, relationships, or pregnancy potential.

patients[].demographics.sexAssignedAtBirth

string

Optional; omitted means unspecified

Optional authored sex assigned at birth, separate from gender. Does not establish current anatomy, reproductive history, or treatment.

patients[].preferredName

string

Optional; omitted means unspecified

The name the patient asks others to use, when different from their display name. Omitted means unspecified. Builder displays this field in Communication while retaining its patient-level storage path.

patients[].communication

object

Optional; omitted means unspecified

Authored language, communication methods, interpreter needs, and accessibility supports. Do not infer these from identity or appearance. Builder places preferred name first, then preferred language and communication method together, followed by interpreter needs and communication supports. Rows stack at narrow widths.

patients[].demographics.weight

object

Optional; omitted means unspecified

Patient weight, stored in kilograms. The editor can also display pounds.

patients[].demographics.height

object

Optional; omitted means unspecified

Patient height, stored in centimeters. The editor can also display feet and inches.

patients[].baselineFunction

string

Optional; omitted means unspecified

Usual mobility, cognition, self-care, and support. Distinguish baseline function from acute changes. Builder displays this field in expanded Demographics while retaining its patient-level storage path.

Behavior and validation

  • All patient-targeted behavior requires patientId even in single-patient scenarios. Names may repeat; IDs may not.
  • Do not derive symptoms, physiology, or actor behavior solely from a demographic attribute. Any such relationship must be authored and reviewed explicitly.
  • Gender, pronouns, sexual orientation, and sex assigned at birth are independent optional text values. Omission means unspecified. Author relevant anatomy, pregnancy, treatments, and disclosure separately.

Shared format conventions · All format elements · Download specification

Field reference

23 records in this view
patients.*.preferredName
stringApplication field

The name the patient asks others to use, when different from their display name. Omitted means unspecified. Builder displays this field in Communication while retaining its patient-level storage path.

  • Optional; omitted values remain unspecified.
patients.*.baselineFunction
stringApplication field

Usual mobility, cognition, self-care, and support. Distinguish baseline function from acute changes. Builder displays this field in expanded Demographics while retaining its patient-level storage path.

  • Optional; omitted values remain unspecified.
patients.*.communication
objectApplication field

Authored language, communication methods, interpreter needs, and accessibility supports. Do not infer these from identity or appearance. Builder places preferred name first, then preferred language and communication method together, followed by interpreter needs and communication supports. Rows stack at narrow widths.

  • Optional; omitted values remain unspecified.
patients.*.communication.preferredLanguage
stringApplication field

The patient's preferred language for this encounter. Do not infer fluency from ethnicity or name.

  • Optional; omitted values remain unspecified.
patients.*.communication.interpreterNeeds
stringApplication field

Whether and how a qualified interpreter is needed, including spoken or signed language. Omitted means unspecified.

  • Optional; omitted values remain unspecified.
patients.*.communication.method
stringApplication field

How the patient communicates, such as speech, ASL, writing, or an augmentative device.

  • Optional; omitted values remain unspecified.
patients.*.communication.supports
stringApplication field

Specific supports and interaction preferences, such as hearing aids, facing the patient, or caregiver participation.

  • Optional; omitted values remain unspecified.
patients.*.demographics
objectApplication field

Optional age, gender, pronouns, sexual orientation, sex assigned at birth, height, and weight. Unspecified fields remain unknown; identity does not determine clinical behavior.

  • Optional; omitted values remain unspecified.
patients.*.demographics.age
objectApplication field

Patient age with an explicit unit. Retain days or months for young infants.

  • Optional; omitted values remain unspecified.
patients.*.demographics.age.unit
valueApplication field

Age unit; preserve days or months when appropriate.

Allowed values

  • days
  • months
  • years
  • Required when the containing object is present.
patients.*.demographics.weight
objectApplication field

Patient weight, stored in kilograms. The editor can also display pounds.

  • Optional; omitted values remain unspecified.
patients.*.demographics.height
objectApplication field

Patient height, stored in centimeters. The editor can also display feet and inches.

  • Optional; omitted values remain unspecified.
patients.*.demographics.pronouns
stringApplication field

The patient's authored pronouns. Never infer these from name, appearance, gender, or sex assigned at birth.

  • Optional; omitted values remain unspecified.
patients.*.demographics.sexualOrientation
stringApplication field

Optional self-described sexual orientation. This does not specify sexual practices, anatomy, relationships, or pregnancy potential.

  • Optional; omitted values remain unspecified.
patients.*.demographics.sexAssignedAtBirth
stringApplication field

Optional authored sex assigned at birth, separate from gender. Does not establish current anatomy, reproductive history, or treatment.

  • Optional; omitted values remain unspecified.
patients.*.demographics.heightUnit
stringApplication field

Preferred height display unit in the scenario editor; the measurement remains stored in centimeters.

Allowed values

  • cm
  • in
  • ft-in
  • Optional; omitted values remain unspecified.
patients.*.demographics.weightUnit
stringApplication field

Preferred weight display unit in the scenario editor; the measurement remains stored in kilograms.

Allowed values

  • kg
  • lb
  • Optional; omitted values remain unspecified.
Compatibility and current support