Overview

Events capture various changes to API resources. By setting up a webhook you can be notified when various events occur. This is particularly useful for listening to asynchronous events such as generating notes or audio transcriptions.

The Event Object

string

The type of the event.

object

Additional data about the event.

Types of Events

data is an audio transcriptionOccurs whenever an audio transcription succeeds.

Hide properties

object

Show properties

string

The ID of the audio transcription.

string

The status of the audio transcription.

object

Hide properties

string

The text of the audio transcription.

Occurs whenever an audio transcription fails.

Hide properties

object

Show properties

string

The ID of the audio transcription.

string

The status of the audio transcription.

string

The error message of the audio transcription.

data is a noteOccurs whenever a note generation succeeds.

Hide properties

object

Show properties

string

The id of the note.

string

The status of the note generation.

object

Hide properties

object

The JSON representation of the note. The note style used will determine which fields are present. See the SOAP Note example.

string

The markdown representation of the note.

object

Hide properties

number

The start time of the note generation.

number

The completion time of the note generation.

Occurs whenever a note generation fails.

Hide properties

object

Show properties

string

The id of the note.

string

The status of the note generation.

object

Hide properties

number

The start time of the note generation.

number

The completion time of the note generation.

data is a coding resultOccurs whenever a coding operation succeeds.

Hide properties

object

Show properties

string

The id of the coding operation.

string

The status of the coding operation.

string

ISO 8601 timestamp of when the coding operation was created.

string

ISO 8601 timestamp of when the coding operation was last updated.

object

Hide properties

array

Array of diagnosed conditions with ICD-10-CM and SNOMED CT codes.

Show diagnosis object

string

Unique identifier for the diagnosis.

object

Show properties

array

Array of coding systems (ICD-10-CM, SNOMED CT).

string

Human-readable description of the diagnosis.

object

Show properties

number

Start character position in the source text.

number

End character position in the source text.

string

The actual text that was coded.

array

Array of medical procedures with CPT codes.

Show procedure object

string

Unique identifier for the procedure.

object

Show properties

array

Array of coding systems (CPT).

string

Human-readable description of the procedure.

object

Show properties

number

Start character position in the source text.

number

End character position in the source text.

string

The actual text that was coded.

Occurs whenever a coding operation fails.

Hide properties

object

Show properties

string

The id of the coding operation.

string

The status of the coding operation (will be “failed”).

string

The error message describing why the coding operation failed.

Audio Transcriptions

Notes

Note Styles

Codings

Macros

Utils

Events

Schemas

The Event Object

Types of Events

​The Event Object

​Types of Events

The Event Object

Types of Events