# Reports

## List

`ReportListResponse AutoScribe.Reports.List(ReportListParams?parameters, CancellationTokencancellationToken = default)`

**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.

### Parameters

- `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')

### Returns

- `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

    - `required Boolean IsAddendum`

      Whether this report is an addendum to a previous report

    - `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

    - `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`

          - `"in"In`

          - `"cm"Cm`

        - `required Double Value`

      - `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'

        - `"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`

          - `"lbs"Lbs`

          - `"kg"Kg`

        - `required Double Value`

    - `required Status Status`

      Report status: 'in_progress' or 'completed'

      - `"in_progress"InProgress`

      - `"completed"Completed`

    - `required string StudyID`

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

    - `required DateTimeOffset? UpdatedAt`

      Timestamp when the report was last updated

    - `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')

### Example

```csharp
ReportListParams parameters = new();

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

Console.WriteLine(reports);
```

## 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.

### Parameters

- `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')

### Returns

- `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`

          - `"in"In`

          - `"cm"Cm`

        - `required Double Value`

      - `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'

        - `"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`

          - `"lbs"Lbs`

          - `"kg"Kg`

        - `required Double Value`

    - `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')

    - `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`

            - `"in"In`

            - `"cm"Cm`

          - `required Double Value`

        - `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'

          - `"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`

            - `"lbs"Lbs`

            - `"kg"Kg`

          - `required Double Value`

      - `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')

      - `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')

### Example

```csharp
ReportTextParams parameters = new();

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

Console.WriteLine(response);
```

## Pdf

`ReportPdfResponse AutoScribe.Reports.Pdf(ReportPdfParams?parameters, CancellationTokencancellationToken = default)`

**get** `/v1/autoScribe/reports/pdf`

Retrieves presigned URLs for accessing report PDFs. Can fetch a single report by report ID, or all reports for a study by study ID/DICOM UID. URLs are time-limited for security.

### Parameters

- `ReportPdfParams 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')

### Returns

- `class ReportPdfResponse: A class that can be one of several variants.union`

  Response containing a single report with its PDF download URL

  - `SingleReportPdfResponse`

    - `required string PresignedUrl`

      Time-limited presigned URL to download the PDF (expires after 1 hour)

    - `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`

          - `"in"In`

          - `"cm"Cm`

        - `required Double Value`

      - `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'

        - `"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`

          - `"lbs"Lbs`

          - `"kg"Kg`

        - `required Double Value`

    - `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')

  - `ListReportsPdfResponse`

    - `required IReadOnlyList<Report> Reports`

      Array of report PDF items with download URLs

      - `required string PresignedUrl`

        Time-limited presigned URL to download the PDF (expires after 1 hour)

      - `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`

            - `"in"In`

            - `"cm"Cm`

          - `required Double Value`

        - `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'

          - `"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`

            - `"lbs"Lbs`

            - `"kg"Kg`

          - `required Double Value`

      - `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')

    - `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')

### Example

```csharp
ReportPdfParams parameters = new();

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

Console.WriteLine(response);
```

## Addendum

`ReportAddendumResponse AutoScribe.Reports.Addendum(ReportAddendumParamsparameters, CancellationTokencancellationToken = default)`

**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.

### Parameters

- `ReportAddendumParams parameters`

  - `required string reportID`

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

### Returns

- `class ReportAddendumResponse:`

  Response for creating a report addendum

  - `required Boolean Success`

  - `string Message`

### Example

```csharp
ReportAddendumParams parameters = new()
{
    ReportID = "rep_1234567890abcdef1234567890abcdef"
};

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

Console.WriteLine(response);
```

## Cancel Addendum

`ReportCancelAddendumResponse AutoScribe.Reports.CancelAddendum(ReportCancelAddendumParamsparameters, CancellationTokencancellationToken = default)`

**post** `/v1/autoScribe/reports/{reportId}/cancel-addendum`

Cancels an in-progress addendum and reverts the study status to 'completed'. The original report remains unchanged. Only valid for active addendums.

### Parameters

- `ReportCancelAddendumParams parameters`

  - `required string reportID`

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

### Returns

- `class ReportCancelAddendumResponse:`

  Response for cancelling a report addendum

  - `required Boolean Success`

  - `string Message`

### Example

```csharp
ReportCancelAddendumParams parameters = new()
{
    ReportID = "rep_1234567890abcdef1234567890abcdef"
};

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

Console.WriteLine(response);
```