Retrieve a study by DICOM UID

StudyRetrieveByUidResponse autoScribe().studies().retrieveByUid(, )

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.

ParametersExpand Collapse

StudyRetrieveByUidParams params

Optional<String> studyInstanceUid

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

minLength1

ReturnsExpand Collapse

class StudyRetrieveByUidResponse:

A study entity in the AutoScribe system with report workflow status

Optional<LocalDateTime> cancelledAt

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

Optional<LocalDateTime> createdAt

Timestamp when the study was created

formatdate-time

boolean isCancelled

Whether the study has been cancelled

StudyReportMetadata reportMetadata

Patient demographics and scan information for report generation

Optional<String> age

Patient's age at time of scan (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'})

Unit unit

Accepts 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> referringPhysicianName

Name of the physician who referred the patient for this scan

Optional<String> scanDate

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

Optional<String> scanTime

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

Optional<String> scanType

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

Optional<Sex> sex

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

Accepts one of the following:

MALE("male")

FEMALE("female")

OTHER("other")

Optional<Weight> weight

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

Unit unit

Accepts one of the following:

LBS("lbs")

KG("kg")

double value

minimum0

Severity severity

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

Accepts one of the following:

NORMAL("normal")

HIGH("high")

STAT("stat")

String studyDescription

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

minLength1

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

minLength1

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

Accepts one of the following:

UNASSIGNED("unassigned")

ASSIGNED("assigned")

IN_PROGRESS("in_progress")

COMPLETED("completed")

ADDENDUM_ACTIVE("addendum_active")

Optional<LocalDateTime> updatedAt

Timestamp when the study was last updated

formatdate-time

Optional<AssignedTo> assignedTo

Reference to the assigned radiologist, null if unassigned

String email

User's email address

String userId

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

Optional<String> firstName

User's first name

Optional<String> lastName

User's last name

Optional<String> middleName

User's middle name

Optional<String> suffix1

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

Optional<String> suffix2

Additional name suffix

Optional<CreatedByApiKey> createdByApiKey

Reference to the API key used to create this study

String apiKeyId

Unique API key identifier (UUIDv4 format)

formatuuid

String description

Human-readable description of the API key

minLength1

Optional<Boolean> isViewerEnabled

Whether this API key has access to the Viewer product

Optional<CreatedByUser> createdByUser

Reference to the user who created this study via dashboard

String email

User's email address

String userId

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

Optional<String> firstName

User's first name

Optional<String> lastName

User's last name

Optional<String> middleName

User's middle name

Optional<String> suffix1

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

Optional<String> suffix2

Additional name suffix

Optional<Metadata> metadata

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

Optional<Org> org

Reference to the organization this study belongs to

String orgId

Unique organization identifier. Format: org_{32-hex-chars}

String orgName

Name of the organization

minLength1

Optional<List<String>> priorReportTexts

Array of prior report texts to provide clinical context

Optional<List<String>> priorStudyIds

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

Optional<List<ReportIdWithStatus>> reportIds

Array of report IDs associated with this study, including addendums

String reportId

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

Status status

Current status of the report

Accepts one of the following:

IN_PROGRESS("in_progress")

COMPLETED("completed")

Retrieve a study by DICOM UID

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.studies.StudyRetrieveByUidParams;
import com.avara.models.autoscribe.studies.StudyRetrieveByUidResponse;

public final class Main {
    private Main() {}

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

        StudyRetrieveByUidResponse response = client.autoScribe().studies().retrieveByUid("1.2.840.10008.5.1.4.1.1.2");
    }
}

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "reportMetadata": {
    "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
    }
  },
  "severity": "normal",
  "studyDescription": "Brain MRI with Contrast",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyReportStatus": "in_progress",
  "updatedAt": "2024-03-15T14:20:00Z",
  "assignedTo": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "createdByApiKey": {
    "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "Production API Key",
    "isViewerEnabled": true
  },
  "createdByUser": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}

Returns Examples

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "reportMetadata": {
    "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
    }
  },
  "severity": "normal",
  "studyDescription": "Brain MRI with Contrast",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyReportStatus": "in_progress",
  "updatedAt": "2024-03-15T14:20:00Z",
  "assignedTo": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "createdByApiKey": {
    "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "Production API Key",
    "isViewerEnabled": true
  },
  "createdByUser": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}