Skip to content
Avara
Get started
API Reference
Auto Scribe
Reports

Retrieve report text

ReportTextResponse AutoScribe.Reports.Text(ReportTextParams?parameters, CancellationTokencancellationToken = default)
GET/v1/autoScribe/reports/text

Retrieves the text content of a report. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. Returns plain text report content.

ParametersExpand Collapse
ReportTextParams parameters
string reportID

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

string studyID

Unique study identifier. Format: stu_{32-hex-chars}

string studyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

ReturnsExpand Collapse
class ReportTextResponse: A class that can be one of several variants.union

Response containing a single report with its plain text

SingleReportTextResponse
required string ReportID

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

required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

Patient's age at time of scan (e.g., '34.5 years', '2 months')

string DateOfBirth

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

string FacilityName

Name of the medical facility where the scan was performed

Height Height

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

required Unit Unit
Accepts one of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

string ScanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

string ScanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

string ScanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Sex Sex

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:
"male"Male
"female"Female
"other"Other
Weight Weight

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

required Unit Unit
Accepts one of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required string StudyID

Study ID this report belongs to. Format: stu_{32-hex-chars}

required string StudyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
string PlainText

Plain text content of the report

ListReportsTextResponse
required IReadOnlyList<Report> Reports

Array of report text items

required string ReportID

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

required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

Patient's age at time of scan (e.g., '34.5 years', '2 months')

string DateOfBirth

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

string FacilityName

Name of the medical facility where the scan was performed

Height Height

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

required Unit Unit
Accepts one of the following:
"in"In
"cm"Cm
required Double Value
minimum0
string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

string ScanDate

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

string ScanTime

Time the scan was performed. Format: HH:MM (e.g., '14:30')

string ScanType

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

Sex Sex

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:
"male"Male
"female"Female
"other"Other
Weight Weight

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

required Unit Unit
Accepts one of the following:
"lbs"Lbs
"kg"Kg
required Double Value
minimum0
required string StudyID

Study ID this report belongs to. Format: stu_{32-hex-chars}

required string StudyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1
string PlainText

Plain text content of the report

required string StudyID

Study ID the reports belong to. Format: stu_{32-hex-chars}

required string StudyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

Retrieve report text

ReportTextParams parameters = new();

var response = await client.AutoScribe.Reports.Text(parameters);

Console.WriteLine(response);
{
  "reportId": "rep_1234567890abcdef1234567890abcdef",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "plainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
}
Returns Examples
{
  "reportId": "rep_1234567890abcdef1234567890abcdef",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "plainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
}