Create a report addendum

auto_scribe.reports.addendum() -> ReportAddendumResponse

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

report_id: str

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

ReturnsExpand Collapse

class ReportAddendumResponse: …

Response for creating a report addendum

success: bool

message: Optional[str]

Create a report addendum

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.auto_scribe.reports.addendum(
    "rep_1234567890abcdef1234567890abcdef",
)
print(response.success)

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

Returns Examples

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