Skip to documentation
ReferencePatient

Patient

ECG

Rhythm vocabulary and an associated recording.

Format definition

Distinguish rhythm, ECG findings, acquisition settings, and a recording.

Portable format · Suite implementation support

Parameters

patients[].monitor.connections

{ ecg?: boolean, bloodPressure?: boolean, spo2?: boolean, respiration?: boolean, temperature?: boolean, capnography?: boolean, arterialPressure?: boolean }

Optional; omitted means unspecified

Initial patient monitor connections. An explicit map starts every omitted channel disconnected; an empty map means all channels disconnected.

resources[].equipment.monitorConnection

{ channel: MonitorChannel, connected: boolean }

Optional; omitted means unspecified

Declares which channel this equipment connects or disconnects. The using action targets the patient through an explicit set-monitor-connection effect; importing the resource alone does not connect it.

events.effects[].channel

ecg | bloodPressure | spo2 | respiration | temperature | capnography | arterialPressure

Required only for set-monitor-connection; prohibited for other effects

MonitorChannel identifies the affected patient measurement channel; targetId is a Patient ID and value is the connected boolean.

resources[].diagnostic.ecg

{ leadConfiguration: string, paperSpeedMmPerSecond?: number, gainMmPerMv?: number, rhythmObservationId?: Observation ID, findingObservationIds: Observation ID[] }

Required for physiologic diagnostics that record an ECG

Acquisition context plus independent rhythm and morphology findings; all supplied scale numbers must be positive.

resources[].diagnostic.ecg.recordingAssetId

Asset ID

Required

ECG image, signal, or video manifest entry with an accessible description.

Behavior and validation

  • Monitor fields and set-monitor-connection require the monitor-connections execution capability. A consumer lacking a required capability must reject execution, not silently expose readings. Unknown channel names and nonboolean connection values invalidate the document.
  • Connections control availability, not physiology or rhythm. ECG gates hr; bloodPressure gates sbp/dbp; spo2 gates oxygen saturation; respiration gates rr; temperature gates temperature; capnography gates etco2; arterialPressure gates artSbp/artDbp. Connecting a channel with no authored measurement cannot invent a reading. Disconnection hides live and newly recorded readings; it does not erase earlier measurements or underlying variables.
  • set-monitor-connection changes only its target patient's selected channel and persists until another effect changes it. Use onEnterEffectIds for event changes and action outcome effects for equipment use; schedule the effect with delayed result release when connection should occur at that time. A declared equipment.monitorConnection must agree with its using action's channel/value. Equipment status alone never implicitly enables every monitor channel.
  • Portable omission leaves baseline connection state unspecified; an execution profile must define it before displaying measurements. Suite maps patients[].monitor.connections to patients.monitor.connections, set-monitor-connection entry effects to events.states[].monitor.connections, and equipment.monitorConnection to events.objects[].monitorConnection. Suite new drafts explicitly enable all monitor channels; omission in existing Suite files preserves available channels as connected. Omitted event channels inherit their preceding state. These mappings describe the execution contract, not an implemented portable importer.
  • Do not force one mutually exclusive selection for rhythm and non-rhythm findings. Each finding is separately disclosed and attributed.
  • This format packages authored recordings. Suite schematic monitor synthesis is separately specified in docs/monitor-rhythms.md (profile 1.0.0); portable extension binding is not yet implemented.

Shared format conventions · All format elements · Download specification

Field reference

11 records in this view
objectApplication field

The monitor configuration used to present patient observations.

  • Optional; omitted values remain unspecified.
stringApplication field

The ECG rhythm displayed on the monitor. Select the rhythm separately from whether the patient has a palpable pulse.

Allowed values

  • sinus
  • sinus_tachycardia
  • sinus_bradycardia
  • atrial_fibrillation
  • atrial_flutter
  • svt
  • ventricular_tachycardia
  • torsades
  • ventricular_fibrillation
  • asystole
  • av_block_1
  • av_block_2_mobitz_1
  • av_block_2_mobitz_2
  • av_block_3
  • junctional
  • ventricular_paced
  • Optional; omitted values remain unspecified.
booleanApplication field

Whether a palpable pulse is present. Use this to distinguish perfusing and pulseless presentations of the displayed rhythm.

  • Optional; omitted values remain unspecified.
objectApplication field

Connected channels expose available measurements without changing physiology. An explicit empty patient connection map starts disconnected. Omitted event channels inherit their preceding connection. Omitting the patient connection map makes available channels connected.

  • Optional; omitted values remain unspecified.
booleanApplication field

ECG: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Blood pressure cuff: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Pulse oximetry: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Respiratory monitoring: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Temperature probe: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Capnography: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.
booleanApplication field

Arterial pressure: connected exposes the available measurement; disconnected hides it without changing physiology.

  • Optional; omitted values remain unspecified.