AugnitoAmbientSDK 1.0.1

Augnito Ambient SDK

Use this .Net SDK to integrate Augnito’s Ambient Tech within your EMR. To get access credentials or know more about how Augnito Ambient can benefit you, please visit our website and connect with our sales team: https://augnito.ai/

Installation

Install the library in your project Using nuget package manager Search AugnitoAmbientSDK click on install Using Package manager console
Install-Package AugnitoAmbientSDK

Basic Usage

Import the library

using AugnitoAmbientSDK;
using AugnitoAmbientSDK.Config;
using AugnitoAmbientSDK.Utils;

Create the configuration file and instantiate Augnito Ambient Client

AmbientConfig _configParams = new AmbientConfig()
    {
        accessKey = "<your server>",
        enableLogs = "false",// set to true to check sdk logs in the output window
        server = "<your server>",
        subscriptionCode = "<your subscription code>",
        userTag = "<your usertag>"
    };
AugnitoAmbient _augnitoAmbientClient = new AugnitoAmbient(_configParams, HeavyDataOperation);

For the provided subscription code, accesskey and usertag, any authentication failure will be returned in onError callback for all the APIs provided below

1- Get Note Parameters

• Get Region, Note Type and Gender

  Get all possible note-parameters (applicable categories and possible values) that are expected to be passed when creating a job (when doctor-patient consultation is started). These details are used to provide consultation SOAP notes with higher accuracy.

  //Returns JSON string of Region, Note Type and Gender
  try
  {
    var noteParamsJson = await _augnitoAmbientClient.GetNoteParams();
  }
  catch(Exception ex)
  {
    if(ex is HttpCodeException error)
    {
        Console.Writeline(error.ErrorCode, error.ErrorMessage)
    }
  }
  

• Get Speciality and Visit Types

  Augnito allows the speciality-type and visit-types for the doctor-patient consultation mapped at the hospital organization level. This method returns the list of speciality-type or visit-type (based on the value of ConfigTypeId parameter) mapped for the user in the hospital-organization.

  All supported specialty-types and visit-types for the hospital-organization can be specified to Augnito team at the start of integration or as and when needed.

  At the start of recording it is necessary to pass the ConfigID of applicable (user can select one or default value to be sent) Speciality and VisitType in the noteparams string.

  /** Response JSON string for each item of speciality and visit type
  * ID: number,
  * ConfigID: number,
  * Value: string,
  * Description: string,
  * IsSelected: boolean,
  * IsDefault: boolean
  */
  
  try
  {
        //Get list of specialities enabled for organisation
        var specialities = await _augnitoAmbientClient.getUserConfiguration(SettingsConfigType.SPECIALITY);
  
        //Get list of visit types enabled for organisation
        var visitTypes = await _augnitoAmbientClient.getUserConfiguration(SettingsConfigType.VISIT_TYPE); 
  }
  catch(Exception ex)
  {
        if(ex is HttpCodeException error)
        {
            Console.Writeline(error.ErrorCode, error.ErrorMessage)
        }
  }
  

2- Toggle the client

Now all you have to do is toggle the status when you want to start/stop or pause/resume recording!

/**
 * @param filetype Type of file being uploaded, wav, mp3, etc. Ex: “filetype=wav“
 * @param noteparams Qualifiers to determine the type of clinical note to be generated for that audio file. Region, NoteType and Gender values to be passed from response for getNoteParams(). Speciality and Visit Type can be set to the ConfigID returned by getUserConfiguration()
 * @param jobName, optional, a title for the note generated
 * @param jobId, optional, to be set if reconnecting to paused job id to continue recording the note
 * @param recordedDuration, optional, set recorded duration of previous paused job id if reconnecting to it
 */

// Toggles the start/stop recording
AugnitoAmbientClient.ToggleListening(
    string filetype, 
    string noteparams, 
    string jobName = null, 
    string jobId = null, 
    int recordedDuration = 0)

example: _augnitoAmbientClient.ToggleListening("wav","{'Region': 1, 'Speciality': 11, 'NoteType': 1, 'VisitType':29, 'Gender': 0}");

//Toggles the Pause/Resume recording
augnitoAmbient.TogglePauseResumeListening(string filetype, string noteparams, string jobName = null, string jobId = null, int recordedDuration = 0)

example: augnitoAmbient.togglePauseResumeListening("wav","{'Region': 1, 'Speciality': 11, 'NoteType': 1, 'VisitType':29, 'Gender': 0}")

//#region Callbacks

//Callback to change recording button style
_augnitoAmbientClient.OnStateChanged = OnStateChangedCallback;
private void OnStateChangedCallback(RecordingStatusType recordingStatus)
{
    Console.Writeline(recordingStatus.ToString());
}

//Callback to receive the Job Id
_augnitoAmbientClient.OnJobCreated = OnJobCreatedCallback;
private void OnJobCreatedCallback(string jobId)
{
    Console.Writeline(jobId);    
}

//Callback to receive when an error occurs within the SDK
_augnitoAmbientClient.OnError = onErrorCallback;
private void onErrorCallback(ErrorInfo error)
{
    Console.Writeline(error);
}

//Callback to receive when SDK send logs this will be only there when EnableLog is true in config file
_augnitoAmbientClient.OnShowLog = OnShowLogCallback;
private void OnShowLogCallback(string logMessage)
{
    Console.Writeline(logMessage);
}

//#endregion

Below Errors with Error Code will be returned via onError callback for toggleListening/togglePauseResumeListening

3- Explicitly stop the recording

/**
 * Stops the recording and cleans up resources
 * This function needs to be explicitly called whenever togglePauseResumeListening() function is used
 */
_augnitoAmbientClient.stopListening();

4- List Jobs

Get all Jobs (SOAP notes and other clinical notes) created within the doctor (user’s) account with respect to the given usertag along with meta data. These notes are sorted by timestamp of creation and support pagination.

/**
 * @param PageSize a number, to fetch specified number of notes as a page for each request
 * @param PageID is optional parameter, a string value, When PageID is not given, first set of notes is retrieved according to the specified PageSize. To fetch next set of notes send the PageIDNext received as part of response from the previous getAllNotes call
 * @returns list of notes for the user on success else fail response
 */
 try
 {
    string jobsString = await _augnitoAmbientClient.FetchAllJob(PageSize,PageID);
 }
 catch(Exception ex)
 {
    if(ex is HttpCodeException error)
    {
        Console.Writeline(error.ErrorCode, error.ErrorMessage)
    }
 }

HttpCodeException returned by List job API

5- Fetch Job Output

Retrieve a particular SOAP note or any other clinical note for the given JobId and with respect to the given UserTag (doctor).

/**
 * @param JobId string, to retrieve output for a specific audio file
 * @returns JSON string contains Transcript, Note, FormattedSoap, Codes, NoteParams and SystemEOS on success else fail response
 */
 try
 {
    var jobResponse = await _augnitoAmbientClient.FetchJob(jobId);
 }
 catch(Exception ex)
 {
    if(ex is HttpCodeException error)
    {
        Console.Writeline(error.ErrorCode, error.ErrorMessage)
    }
 }

HttpCodeException returned by Fetch Job API

6- Delete Notes

Allows you to build a capability for the user (doctor) to delete one or more notes generated under his/her UserTag.

/**
 * @param JobIds array of jobid string values, to delete one or more notes
 * @returns success response on successful delete of notes else fail response
 */
try
{
    var responseStr = await _augnitoAmbientClient.DeleteNotes(JobIds);
}
catch(Exception ex)
{
    if(ex is HttpCodeException error)
    {
        Console.Writeline(error.ErrorCode, error.ErrorMessage)
    }
}

HttpCodeException returned by Delete Notes API

Note

Other errors that the SDK may return in OnError callback are as below