Dictation Status

The Dictation Status feature allows the user to get the dictation status for a particular encounter. The Dictatatable Section Reference allows the user to retrieve a list of dictation transcripts directly to an encounter.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Endpoints

Primary

GET

Get dictation status for given
encounter
Reference

GET

Get list of dictatable sections for given
encounter

Get dictation status for given encounter

GET

/v1/{practiceid}/chart/encounter/{encounterid}/dictationstatus

Retrieves the current status on whether or not an encounter is waiting for more transcription messages

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

encounterid integer encounterid

Output Parameters

Expand all

closedencounter string Boolean field indicating if the encounter has already been closed. A closed encounter cannot receive dictations. This field and ISWAITINGFORTRANSCRIPTION will never both be true at the same time.

iswaitingfortranscription string Boolean field that describes whether the encounter is locked and waiting for more transcription messages.

receivedtranscriptioncount integer The number of received transcriptions. No more transcriptions will be accepted when this number reaches the totalmessagecount that was included with the first transcription.

receivedtranscriptions array An array containing information about the transcriptions that have already been processed.

Example Code

Get list of dictatable sections for given encounter

GET

/v1/{practiceid}/chart/encounter/{encounterid}/dictatablesections

Retrieve a list of sections available for dictation for a specific encounter

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

encounterid integer encounterid

limit integer Number of entries to return (default 1500, max 5000)

offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all

name string The name of the section.

Example Code