General Functionality

Keeping the Heidi Widget active

The Heidi Widget is designed to stay open and active across multiple areas of your EHR. For example, if there are multiple areas or tabs within a patient file, then the Heidi Widget should remain open regardless of where the user navigates.

Active Patient Sync

The Heidi Widget should also synchronise with whichever patient is active in your EHR.

If your EHR allows users to switch patients, then ensure that you likewise update the widget to start a session for that second patient. This very important to ensure clinical safety and eliminate documentation errors.

Use Heidi.setPatient(patientInfo) to set the active patient.

Prevent Transcription Loss

When the User has a transcription in progress, it is important to ensure this session is not stopped without warning. For example, you can stop the User from navigating to a new page unless the transcription has been stopped.

The following methods and callbacks will inform you of the status of Heidi, and allow you to control the widget appropriately.

• Heidi.onSessionStarted(callback)
• Heidi.onRecordingStarted(callback)
• Heidi.onRecordingStopped(callback)

Store and restore Heidi Sessions

When a new session has started on the Heidi widget, we will provide you with the Heidi SessionID. You can store this SessionID and associate it with the patient appointment or encounter where the session was started. If the user ever opens Heidi from this appointment/encounter in the future, then you can automatically load the correct Heidi session.

Heidi.onSessionStarted(callback) will provide you with the sessionID

Use Heidi.open(params?) with the sessionId as described here: https://heidihealth.com/developers/heidi-widget/methods-and-callbacks#widget-open-parameters (opens in a new tab)

Receiving Data - Simple Note

Once a note has been generated on the Heidi Widget, the user can then "Push Note". This will trigger Heidi.onPushData(callback).

This note should be placed into a consultation notes section of the patient file.

Receiving Data - Documents

If a user generates a document on the Heidi Widget (e.g. a referral letter), then this can also be pushed back to the EHR. To enable this, you must enable Heidi.onPushDocument(callback).

This will then enable the "Push Document" button in the Heidi Widget.

The text that is sent should be placed into the appropriate area in your EHR. The most common use case is inserting it to the body of a letter that has been created in your EHR’s letter writer.

Providing Additional Patient Context

The Heidi Widget has the ability to accept additional information about the patient via Heidi.setContext(context). There is no limit or format specifications to what you can send, however it should be relevant to your clinical use case. Common information that may be sent:

• Past medical history or past diagnosis list
• Medications
• Allergies
• Previous consultation note
• Etc...