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

Portable format · Suite implementation support

Parameters

patients[].id

ID

Required

Stable target for observations, actions, medications, and devices.

patients[].name

string

Required

Fictional display name; distinct from identity.

patients[].demographics.age

{ value: nonnegative number, unit: days | months | years }

Optional; omitted means unspecified

Explicit unit supports neonatal and pediatric scenarios. Do not infer an exact date of birth from age.

patients[].demographics.gender

string

Optional; omitted means unspecified

Authored gender description as text.

patients[].demographics.pronouns

string

Optional; omitted means unspecified

Optional actor and communication guidance.

patients[].demographics.weight

{ value: positive number, unit: kg }

Optional; omitted means unspecified

Authored weight with a fixed explicit unit; used by expressions only if an operation expressly references it.

patients[].demographics.height

{ value: positive number, unit: cm }

Optional; omitted means unspecified

Authored height; no automatic ideal-body-weight or physiology calculation.

patients[].baselineFunction

string

Optional; omitted means unspecified

Usual mobility, communication, cognition, and support relevant to interpreting the case.

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.

Shared format conventions · All format elements · Download specification

Field reference

7 records in this view
objectApplication field

Patient age, gender, height, and weight used to describe the case.

  • Optional; omitted values remain unspecified.
numberApplication field

Patient age in years. Use the patient narrative to clarify a young infant's age when needed.

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • Optional; omitted values remain unspecified.
numberApplication field

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

  • Optional; omitted values remain unspecified.
stringApplication field

The patient's authored gender description.

  • Optional; omitted values remain unspecified.
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.
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.