Create a new study

client.viewer.studies.create(, ?): StudyCreateResponse { cancelledAt, createdAt, isCancelled, 11 more }

post/v1/viewer/studies

Creates a new study in the Viewer system with the specified DICOM Study Instance UID and metadata. The study can be optionally assigned to a user.

ParametersExpand Collapse

body: StudyCreateParams { severity, studyDescription, studyInstanceUid, 3 more }

severity: "normal" | "high" | "stat"

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

Accepts one of the following:

"normal"

"high"

"stat"

studyDescription: string

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

minLength1

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

assignedTo?: string

User ID to assign the study to. Format: usr_{32-hex-chars}

metadata?: Record<string, string>

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

orgId?: string

Organization ID for the study. Format: org_{32-hex-chars}

ReturnsExpand Collapse

StudyCreateResponse { cancelledAt, createdAt, isCancelled, 11 more }

A study entity in the Viewer system with viewing status

cancelledAt: string | null

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string | null

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

severity: "normal" | "high" | "stat"

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

Accepts one of the following:

"normal"

"high"

"stat"

studyDescription: string

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

minLength1

studyId: string

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

studyInstanceUid: string

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: "incomplete" | "complete"

Accepts one of the following:

"incomplete"

"complete"

updatedAt: string | null

Timestamp when the study was last updated

formatdate-time

assignedTo?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User's email address

userId: string

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

firstName?: string

User's first name

lastName?: string

User's last name

middleName?: string

User's middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

createdByApiKey?: APIKeyReference { apiKeyId, description, isViewerEnabled } | null

A reference to an API key with basic identifying information

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isViewerEnabled?: boolean

Whether this API key has access to the Viewer product

createdByUser?: UserReference { email, userId, firstName, 4 more } | null

A reference to a user with basic identifying information

email: string

User's email address

userId: string

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

firstName?: string

User's first name

lastName?: string

User's last name

middleName?: string

User's middle name

suffix1?: string

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

suffix2?: string

Additional name suffix

metadata?: Record<string, string>

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

org?: OrgReference { orgId, orgName } | null

A reference to an organization with basic identifying information

orgId: string

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

orgName: string

Name of the organization

minLength1

Create a new study

import Avara from 'avara';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

const study = await client.viewer.studies.create({
  severity: 'high',
  studyDescription: 'CT Chest/Abdomen/Pelvis',
  studyInstanceUid: '1.2.840.113619.2.55.3.604688119.868.1234567890.123',
});

console.log(study.studyInstanceUid);

{
  "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"
  }
}