Skip to documentation
ReferencePatient

Patient

Vital signs

A clinical snapshot that can change as the scenario progresses.

Format definition

Define physiologic variables separately from measured observations and support authored trends.

Portable format · Suite implementation support

Normal ranges by age

Use the patient's age to choose a row. ‘Under’ excludes the upper age; the next row starts at that age. Values at either end of a vital-sign range are within range.

AgeGroupHRRRSystolic BPDiastolic BP
Birth to under 28 daysNewborn100–20530–5367–8435–53
28 days to under 1 yearInfant100–18030–5372–10437–56
1 to under 3 yearsToddler98–14022–3786–10642–63
3 to under 6 yearsPreschool80–12020–2889–11246–72
6 to under 12 yearsSchool age75–11818–2597–11557–76
12 to under 16 yearsAdolescent60–10012–20102–12061–80
16 years and olderOlder adolescent / adult60–10012–1890–12060–80

Ranges shared across ages

These defaults also require a known age. HR is in beats/min, RR in breaths/min, and blood pressure in mmHg.

Vital signNormal rangeUnit
Oxygen saturation (SpO2)95–100%
Temperature36.5–37.3°C
End-tidal CO2 (EtCO2)35–45mmHg

How a reading is interpreted

PriorityUseMeaning
1Authored flagAn explicitly authored flag takes precedence, including none or not-interpreted.
2Authored reference intervalUse the scenario's own range. A text-only interval leaves numeric interpretation unspecified.
3Age-based defaultIf neither is supplied, use the patient's age and the tables above. Missing or invalid age leaves the reading uninterpreted.

Parameters

patients[].variables[]

{ id: ID, concept: string, value: number, unit: string }

Optional; default []

Underlying authored numeric state. Measurements reference it explicitly rather than appearing automatically.

observations[].variableId

Variable ID

Optional; omitted means unspecified

On collection, snapshot this variable's current value into a new measurement; later trends do not rewrite past results.

events.effects[].durationSeconds

positive number

Required only for trend-variable

Duration of a linear authored change from current value to target. Instant changes use set-variable.

events.effects[].interpolation

literal "linear"

Required only for trend-variable

The format supports one explicit interpolation rule; no inferred dose-response or disease model.

resources[].diagnostic.orthostaticResponse

{ patientId: Patient ID, systolicVariableId: Variable ID, diastolicVariableId: Variable ID, systolicDrop: number, diastolicDrop: number }

Optional; physiologic diagnostics only

Baseline-relative standing BP at three minutes. Both drops are finite values from 0 to 100 mmHg; both variables belong to the named patient and use mmHg.

Behavior and validation

  • Core vital concepts use hr (beats/min), sbp/dbp (mmHg), rr (breaths/min), spo2 (%), temperature (Cel), and etco2 (mmHg). Normal-value interpretation uses the usim:age-based-vitals profile published in referenceProfiles, shared by preview, PDF, and other consumers.
  • Read age from the patient’s demographics.age in days, months, or years. For display, 28 days is approximately 0.077 years. Calculations use the exact conversion (days ÷ 365.25 or months ÷ 12), without rounding. Do not infer age from weight, title, or appearance.
  • For a known numeric vital measurement: explicit observations[].flag takes precedence, then an authored observations[].referenceInterval, then the age-based default. A text-only authored interval suppresses automatic numeric interpretation. Validate authored intervals and unit agreement; never fall back to defaults after an invalid override. Compare strictly below low or above high; endpoints are within range. Derived flags are output interpretation, not mutations of authored values or flags. Defaults never infer critical severity.
  • The default profile uses awake/resting values after postnatal transition, not physiologic limits or treatment targets. Changing a patient's age immediately changes the default range applied to both initial and event vitals; it never changes the actual authored values. Keep the profile version fixed for reproducible interpretation. Custom numeric concepts require an authored reference interval; no vital defaults apply to unrelated laboratory tests.
  • orthostaticResponse requires the orthostatic-results execution capability. Snapshot both resting BP variables when the diagnostic is requested; compute standing systolic = baseline systolic minus systolicDrop and standing diastolic = baseline diastolic minus diastolicDrop. Persist that request-time snapshot through delayed release. This produces a result, not a set-variable effect: resting physiology is unchanged, and no heart-rate response is inferred.
  • An authored nonblank result takes precedence over the computed orthostatic report. Missing baseline BP, nonpositive computed pressure, or computed systolic not greater than diastolic produces an unavailable result, never invented values. Invalid references, units, or drop parameters invalidate the document. Explicit learner disclosure still controls delivery; a disconnected monitor does not prevent a requested bedside measurement.
  • The format supplies no default orthostatic drop. The included positive teaching resource authors systolicDrop 20 and diastolicDrop 10 mmHg; 130/80 therefore reports 110/70. Suite maps this payload to events.objects[].orthostaticResponse and its single patient's current sbp/dbp. Portable patient/variable references require an adapter; the Suite importer does not accept portable documents directly.
  • A new set or trend targeting the same variable cancels its prior trend. Trend start value is the value at that simulated instant. Validate finite values and concept bounds; unit mismatch is an error.

Shared format conventions · All format elements · Download specification

Field reference

10 records in this view
objectApplication field

Absolute resulting measurements, never signed deltas. Omitted values are unspecified or inherited in an event context. Bounds are storage limits, not clinical reference intervals.

  • Optional; omitted values remain unspecified.
numberApplication field

Heart rate in beats per minute. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Noninvasive systolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Noninvasive diastolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Respiratory rate in breaths per minute. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Peripheral oxygen saturation as a percentage from 0 to 100. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Body temperature in degrees Celsius. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

End-tidal carbon dioxide pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Invasive arterial systolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.
numberApplication field

Invasive arterial diastolic blood pressure in mmHg. Enter the resulting measurement, not an amount of change; omit to leave it unspecified or retain the previous value during a transition.

  • Optional; omitted values remain unspecified.