Retrieve an external report

ReportRetrieveResponse autoScribe().studies().external().reports().retrieve(, )

GET/v1/autoScribe/studies/external/reports/{externalReportId}

Returns snapshot metadata plus report text and/or a short-lived download URL. Text is what AI priors use; the file is reader-only and is not used for AI.

ParametersExpand Collapse

ReportRetrieveParams params

Optional<String> externalReportId

External report identifier. Format: ext_{32-hex-chars}

ReturnsExpand Collapse

class ReportRetrieveResponse:

External report snapshot including text and/or a presigned file URL

Optional<LocalDateTime> createdAt

formatdate-time

String externalReportId

String studyId

String studyInstanceUid

minLength1

Optional<String> presignedUrl

Short-lived download URL for the attached PDF or image. Not used for AI tooling; the reader can still access it.

Optional<String> readerName

Optional<String> reportText

When this study is used as a prior, report AI tools leverage this text directly.

Optional<String> signedAt

Optional<StudyReportMetadata> snapshotMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient’s age at study date (e.g., ‘34.5 years’, ‘2 months’)

Optional<String> dateOfBirth

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

Optional<String> facilityName

Name of the medical facility where the scan was performed

Optional<Height> height

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

HeightUnit unit

Unit of measure for a height value. ‘in’ = inches, ‘cm’ = centimeters.

One of the following:

IN("in")

CM("cm")

double value

minimum0

Optional<String> mrn

Medical Record Number - unique patient identifier

Optional<String> patientName

Full name of the patient

Optional<String> procedure

Procedure or study type (e.g., ‘MRI Brain with Contrast’). Maps to database scan_type and dictation report_header.scan_type.

Optional<String> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<Sex> sex

Patient’s biological sex. Options: ‘male’, ‘female’, ‘other’

One of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<String> studyDate

Study date (YYYY-MM-DD). Maps to database scan_date and dictation report_header.scan_date.

Optional<String> studyTime

Study time (HH:MM). Maps to database scan_time and dictation report_header.scan_time.

Optional<Weight> weight

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

WeightUnit unit

Unit of measure for a weight value. ‘lbs’ = pounds, ‘kg’ = kilograms.

One of the following:

LBS("lbs")

KG("kg")

double value

minimum0

Retrieve an external report

package com.avarasoftware.example;

import com.avarasoftware.client.AvaraClient;
import com.avarasoftware.client.okhttp.AvaraOkHttpClient;
import com.avarasoftware.models.autoscribe.studies.external.reports.ReportRetrieveParams;
import com.avarasoftware.models.autoscribe.studies.external.reports.ReportRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        ReportRetrieveResponse report = client.autoScribe().studies().external().reports().retrieve("ext_1234567890abcdef1234567890abcdef");
    }
}

{
  "createdAt": "2019-12-27T18:11:19.117Z",
  "externalReportId": "ext_1234567890abcdef1234567890abcdef",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "presignedUrl": "https://viewer.avarasoftware.com/study/stu_1234",
  "readerName": "readerName",
  "reportText": "reportText",
  "signedAt": "signedAt",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "procedure": "MRI Brain with Contrast",
    "referringPhysicianName": "Dr. Michael Chen",
    "sex": "female",
    "studyDate": "2024-03-15",
    "studyTime": "14:30",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  }
}

Returns Examples

{
  "createdAt": "2019-12-27T18:11:19.117Z",
  "externalReportId": "ext_1234567890abcdef1234567890abcdef",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "presignedUrl": "https://viewer.avarasoftware.com/study/stu_1234",
  "readerName": "readerName",
  "reportText": "reportText",
  "signedAt": "signedAt",
  "snapshotMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "procedure": "MRI Brain with Contrast",
    "referringPhysicianName": "Dr. Michael Chen",
    "sex": "female",
    "studyDate": "2024-03-15",
    "studyTime": "14:30",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  }
}