testaugnitoambientsdk2 2.1.63 → 2.1.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -9
- package/dist/augnitoambientsdk.js +3936 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -155,32 +155,38 @@ Now all you have to do is toggle the status when you want to start/stop or pause
|
|
|
155
155
|
|
|
156
156
|
```js
|
|
157
157
|
/**
|
|
158
|
-
* @param filetype Type of file being uploaded, wav, mp3, etc. Ex:
|
|
158
|
+
* @param filetype Type of file being uploaded, wav, mp3, etc. Ex: "filetype=wav"
|
|
159
159
|
* @param noteparams Qualifiers to determine the type of clinical note to be generated for that audio file. Values for Region, NoteType and Gender can be obtained from getNoteParams(). Speciality and Visit Type can be set to the ConfigID returned by getUserConfiguration(). Region, Gender, Patient age in months and Template Id params are optional. Sample noteparams available in example below
|
|
160
160
|
* @param jobName, optional, a title for the note generated
|
|
161
161
|
* @param jobId, optional, to be set if reconnecting to paused job id to continue recording the note
|
|
162
162
|
* @param recordedDuration, optional, set recorded duration of previous paused job id if reconnecting to it
|
|
163
|
+
* @param parentJobId, optional, to be set when resuming a recording as a continuation of a previous job; the previous job's id is passed here
|
|
164
|
+
* @param inheritParentConfig, optional, set to true to inherit the note configuration (noteparams) from the parent job when resuming
|
|
163
165
|
*/
|
|
164
166
|
|
|
165
167
|
// Toggles the start/stop recording
|
|
166
|
-
augnitoAmbient.toggleListening(
|
|
168
|
+
await augnitoAmbient.toggleListening(
|
|
167
169
|
filetype:string,
|
|
168
170
|
noteparams:string,
|
|
169
171
|
jobName?: string,
|
|
170
172
|
jobId?: string,
|
|
171
|
-
recordedDuration?: number
|
|
173
|
+
recordedDuration?: number,
|
|
174
|
+
parentJobId?: string,
|
|
175
|
+
inheritParentConfig?: boolean
|
|
172
176
|
);
|
|
173
|
-
example: augnitoAmbient.toggleListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0, "PatientAge":231, "TemplateIdSoapNote":1}`)
|
|
177
|
+
example: await augnitoAmbient.toggleListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0, "PatientAge":231, "TemplateIdSoapNote":1}`)
|
|
174
178
|
|
|
175
179
|
//Toggles the Pause/Resume recording
|
|
176
|
-
augnitoAmbient.togglePauseResumeListening(
|
|
180
|
+
await augnitoAmbient.togglePauseResumeListening(
|
|
177
181
|
filetype: string,
|
|
178
182
|
noteparams: string,
|
|
179
183
|
jobName?: string,
|
|
180
184
|
jobId?: string,
|
|
181
|
-
recordedDuration?: number
|
|
185
|
+
recordedDuration?: number,
|
|
186
|
+
parentJobId?: string,
|
|
187
|
+
inheritParentConfig?: boolean
|
|
182
188
|
);
|
|
183
|
-
example: augnitoAmbient.togglePauseResumeListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0}`)
|
|
189
|
+
example: await augnitoAmbient.togglePauseResumeListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0}`)
|
|
184
190
|
```
|
|
185
191
|
|
|
186
192
|
### Callbacks
|
|
@@ -357,11 +363,12 @@ Get all Jobs (SOAP notes and other clinical notes) created within the doctor (us
|
|
|
357
363
|
/**
|
|
358
364
|
* @param PageSize a number, to fetch specified number of notes as a page for each request
|
|
359
365
|
* @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
|
|
366
|
+
* @param Collapse optional boolean, when set to true (default) child jobs created via resume are collapsed under their parent job in the listing; set to false to list all jobs individually
|
|
360
367
|
* @returns list of notes for the user on success else fail response
|
|
361
368
|
*/
|
|
362
369
|
|
|
363
370
|
try {
|
|
364
|
-
const JobList = await augnitoAmbient.getAllNotes(PageSize: number, PageID?: string);
|
|
371
|
+
const JobList = await augnitoAmbient.getAllNotes(PageSize: number, PageID?: string, Collapse?: boolean);
|
|
365
372
|
} catch (err) {
|
|
366
373
|
if (err instanceof HttpCodedError) {
|
|
367
374
|
console.log(err.code, err.message);
|
|
@@ -436,10 +443,11 @@ Allows you to build a capability for the user (doctor) to delete one or more not
|
|
|
436
443
|
```js
|
|
437
444
|
/**
|
|
438
445
|
* @param JobIds array of jobid string values, to delete one or more notes
|
|
446
|
+
* @param DeleteParent optional boolean, when set to true deletes the parent job along with all its associated child (resumed) jobs
|
|
439
447
|
* @returns success response on successful delete of notes else fail response
|
|
440
448
|
*/
|
|
441
449
|
try {
|
|
442
|
-
const result = await augnitoAmbient.deleteNotes(JobIds: string[])
|
|
450
|
+
const result = await augnitoAmbient.deleteNotes(JobIds: string[], DeleteParent?: boolean)
|
|
443
451
|
} catch (err) {
|
|
444
452
|
if (err instanceof HttpCodedError) {
|
|
445
453
|
console.log(err.code, err.message);
|
|
@@ -787,3 +795,4 @@ General SDK errors returned in onError callback are as below
|
|
|
787
795
|
| SDK12 | Internet is not available. Try again later. | Action can not be performed. No internet connectivity. Reach out to your IT team. | Received from SDK when internet is not available at the time of specific recording related actions are triggered |
|
|
788
796
|
| SDK13 | Automatic Transcription is not enabled for the organisation | Transcript can not be generated. Please reach out to your IT team. | Received when fetchTranscriptionForNote is called and the feature is not enabled for the user |
|
|
789
797
|
| SDK14 | Feedback is not enabled. Please contact administrator for more details. | Feedback can not be submitted. Please reach out to your IT team. | Received when sendFeedback is called and the feature is not enabled for the user |
|
|
798
|
+
| SDK15 | Resume job is not enabled for the organisation | Resume recording is not available. Please reach out to your IT team. | Received when `parentJobId` is passed to `toggleListening` or `togglePauseResumeListening` but the resume recording feature is not enabled for the organisation |
|