Retrieve a study by ID

StudyRetrieveResponse viewer().studies().retrieve(, )

get/v1/viewer/studies/{studyId}

Retrieves a single study by its unique study ID. Returns the complete study object with all metadata and status information.

ParametersExpand Collapse

StudyRetrieveParams params

Optional<String> studyId

Unique study identifier. Format: stu_{32-hex-chars}

ReturnsExpand Collapse

class StudyRetrieveResponse:

A study entity in the Viewer system with viewing 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

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

StudyViewerStatus studyViewerStatus

Accepts one of the following:

INCOMPLETE("incomplete")

COMPLETE("complete")

Optional<LocalDateTime> updatedAt

Timestamp when the study was last updated

formatdate-time

Optional<UserReference> assignedTo

A reference to a user with basic identifying information

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<ApiKeyReference> createdByApiKey

A reference to an API key with basic identifying information

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<UserReference> createdByUser

A reference to a user with basic identifying information

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<OrgReference> org

A reference to an organization with basic identifying information

String orgId

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

String orgName

Name of the organization

minLength1

Retrieve a study by ID

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.viewer.studies.StudyRetrieveParams;
import com.avara.models.viewer.studies.StudyRetrieveResponse;

public final class Main {
    private Main() {}

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

        StudyRetrieveResponse study = client.viewer().studies().retrieve("stu_1234567890abcdef1234567890abcdef");
    }
}

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "severity": "high",
  "studyDescription": "CT Chest/Abdomen/Pelvis",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyViewerStatus": "incomplete",
  "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": "urgent"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  }
}

Returns Examples

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "severity": "high",
  "studyDescription": "CT Chest/Abdomen/Pelvis",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyViewerStatus": "incomplete",
  "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": "urgent"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  }
}