Create a report addendum

client.autoScribe.reports.addendum(, ?): ReportAddendumResponse { success, message }

POST/v1/autoScribe/reports/{reportId}/addendum

Initiates the creation of an addendum to an existing completed report. The study status will change to ‘addendum_active’ allowing the radiologist to dictate additional findings.

ParametersExpand Collapse

reportID: string

Unique report identifier. Format: rep_{32-hex-chars}

ReturnsExpand Collapse

ReportAddendumResponse { success, message }

Response for creating a report addendum

success: boolean

message?: string

Create a report addendum

import Avara from 'avara-software';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const response = await client.autoScribe.reports.addendum('rep_1234567890abcdef1234567890abcdef');

console.log(response.success);

{
  "success": true,
  "message": "message"
}

Returns Examples

{
  "success": true,
  "message": "message"
}