List reports for a study

ReportListResponse AutoScribe.Reports.List(, )

GET/v1/autoScribe/reports

Retrieves all reports (including versions and addendums) for a specific study. Must provide either study ID or DICOM Study Instance UID. Returns report metadata including status, version, and timestamps.

ParametersExpand Collapse

ReportListParams parameters

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 ReportListResponse:

Response containing a list of reports for a study

required IReadOnlyList<Report> Reports

Array of report objects with full details

required DateTimeOffset? CreatedAt

Timestamp when the report was created

formatdate-time

required Boolean IsAddendum

Whether this report is an addendum to a previous report

required Boolean? IsCritical

Whether the report was marked critical at sign-off. null when the report is not yet completed; true/false once completed.

required string ReportID

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

required DateTimeOffset? SignedAt

Timestamp when the report was signed, null if not yet signed

formatdate-time

required StudyReportMetadata SnapshotMetadata

Patient demographics and scan information for report generation

string Age

Patient's age at study date (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 HeightUnit Unit

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

Accepts one of the following:

required Double Value

minimum0

string Mrn

Medical Record Number - unique patient identifier

string PatientName

Full name of the patient

string Procedure

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

string ReferringPhysicianName

Name of the physician who referred the patient for this scan

Sex Sex

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

Accepts one of the following:

string StudyDate

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

string StudyTime

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

Weight Weight

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

required WeightUnit Unit

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

Accepts one of the following:

required Double Value

minimum0

required ReportStatus Status

Status of an individual report. 'in_progress' = actively being dictated, 'completed' = signed.

Accepts one of the following:

required string StudyID

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

required DateTimeOffset? UpdatedAt

Timestamp when the report was last updated

formatdate-time

required string UserID

User ID of the radiologist who created/signed this report. Format: usr_{32-hex-chars}

string ReportPlainText

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

List reports for a study

ReportListParams parameters = new();

var reports = await client.AutoScribe.Reports.List(parameters);

Console.WriteLine(reports);

{
  "reports": [
    {
      "createdAt": "2024-03-15T14:30:00Z",
      "isAddendum": false,
      "isCritical": false,
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "signedAt": "2024-03-15T16:00:00Z",
      "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
        }
      },
      "status": "completed",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "updatedAt": "2024-03-15T16:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "reportPlainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
    }
  ],
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}

Returns Examples

{
  "reports": [
    {
      "createdAt": "2024-03-15T14:30:00Z",
      "isAddendum": false,
      "isCritical": false,
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "signedAt": "2024-03-15T16:00:00Z",
      "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
        }
      },
      "status": "completed",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "updatedAt": "2024-03-15T16:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "reportPlainText": "FINDINGS: Normal brain MRI. No acute intracranial abnormality. IMPRESSION: Unremarkable brain MRI."
    }
  ],
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123"
}