API Reference

Workflow Events Reference

Open in Claude

Available workflow events and their entity mappings

Workflow events fire once when the provider triggers an action in the EHR. Each event carries typed entity references.

Subscribing

import type { EventType } from '@vimconnect/app-sdk';

// Single event
sdk.ehr.workflow.on('chart_open', (event) => {
  // A reference — { type: 'existing', id, entityType } — not the patient record.
  console.log('Patient reference:', event.entities.patient);
});

// Multiple events
sdk.ehr.workflow.on(['chart_open', 'encounter_open'], (event) => {
  console.log(event.type, event.entities);
});

For detailed usage patterns, see Workflow Events guide.

Available Events

Expand Example payload on any row to see the object your handler receives. entities holds references, not records: read the data with the entity API. componentId and systemId vary by EHR.

Loading from CDN...

On this page