## Retrieve By Uid

`StudyRetrieveByUidResponse AutoScribe.Studies.RetrieveByUid(StudyRetrieveByUidParamsparameters, CancellationTokencancellationToken = default)`

**get** `/v1/autoScribe/studies/by-uid/{studyInstanceUid}`

Retrieves a single study by its DICOM Study Instance UID. This is useful when you have the DICOM UID but not the Avara study ID.

### Parameters

- `StudyRetrieveByUidParams parameters`

  - `required string studyInstanceUid`

    DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2).

### Returns

- `class StudyRetrieveByUidResponse:`

  A study entity in the AutoScribe system with report workflow status

  - `required DateTimeOffset? CancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `required DateTimeOffset? CreatedAt`

    Timestamp when the study was created

  - `required Boolean IsCancelled`

    Whether the study has been cancelled

  - `required StudyReportMetadata ReportMetadata`

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

    Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

    - `"normal"Normal`

    - `"high"High`

    - `"stat"Stat`

  - `required string StudyDescription`

    Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')

  - `required string StudyID`

    Unique study identifier. 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 StudyReportStatus StudyReportStatus`

    Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

    - `"unassigned"Unassigned`

    - `"assigned"Assigned`

    - `"in_progress"InProgress`

    - `"completed"Completed`

    - `"addendum_active"AddendumActive`

  - `required DateTimeOffset? UpdatedAt`

    Timestamp when the study was last updated

  - `AssignedTo? AssignedTo`

    Reference to the assigned radiologist, null if unassigned

    - `required string Email`

      User's email address

    - `required string UserID`

      Unique user identifier. Format: usr_{32-hex-chars}

    - `string FirstName`

      User's first name

    - `string LastName`

      User's last name

    - `string MiddleName`

      User's middle name

    - `string Suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `string Suffix2`

      Additional name suffix

  - `CreatedByApiKey? CreatedByApiKey`

    Reference to the API key used to create this study

    - `required string ApiKeyID`

      Unique API key identifier (UUIDv4 format)

    - `required string Description`

      Human-readable description of the API key

    - `Boolean IsViewerEnabled`

      Whether this API key has access to the Viewer product

  - `CreatedByUser? CreatedByUser`

    Reference to the user who created this study via dashboard

    - `required string Email`

      User's email address

    - `required string UserID`

      Unique user identifier. Format: usr_{32-hex-chars}

    - `string FirstName`

      User's first name

    - `string LastName`

      User's last name

    - `string MiddleName`

      User's middle name

    - `string Suffix1`

      Name suffix (e.g., 'MD', 'Jr.')

    - `string Suffix2`

      Additional name suffix

  - `ExpressCustomer? ExpressCustomer`

    Reference to the Express customer this study belongs to

    - `required string ExpressCustomerID`

      Unique Express customer identifier. Format: cus_{32-hex-chars}

    - `required string ExpressCustomerName`

      Name of the Express customer

  - `IReadOnlyDictionary<string, string> Metadata`

    Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

  - `IReadOnlyList<string> PriorReportTexts`

    Array of prior report texts to provide clinical context

  - `IReadOnlyList<string> PriorStudyIds`

    Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

  - `IReadOnlyList<ReportIDWithStatus> ReportIds`

    Array of report IDs associated with this study, including addendums

    - `required string ReportID`

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

    - `required Status Status`

      Current status of the report

      - `"in_progress"InProgress`

      - `"completed"Completed`

### Example

```csharp
StudyRetrieveByUidParams parameters = new()
{
    StudyInstanceUid = "1.2.840.10008.5.1.4.1.1.2"
};

var response = await client.AutoScribe.Studies.RetrieveByUid(parameters);

Console.WriteLine(response);
```