# Studies ## Create `viewer.studies.create(StudyCreateParams**kwargs) -> StudyCreateResponse` **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. ### Parameters - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `assigned_to: Optional[str]` User ID to assign the study to. Format: usr_{32-hex-chars} - `express_customer_id: Optional[str]` Express customer ID for the study. Format: cus_{32-hex-chars} - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Returns - `class StudyCreateResponse: …` A study entity in the Viewer system with viewing status - `cancelled_at: Optional[datetime]` Timestamp when the study was cancelled, null if not cancelled - `created_at: Optional[datetime]` Timestamp when the study was created - `is_cancelled: bool` Whether the study has been cancelled - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `study_viewer_status: Literal["incomplete", "complete"]` - `"incomplete"` - `"complete"` - `updated_at: Optional[datetime]` Timestamp when the study was last updated - `assigned_to: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `created_by_api_key: Optional[APIKeyReference]` A reference to an API key with basic identifying information - `api_key_id: str` Unique API key identifier (UUIDv4 format) - `description: str` Human-readable description of the API key - `is_viewer_enabled: Optional[bool]` Whether this API key has access to the Viewer product - `created_by_user: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `express_customer: Optional[ExpressCustomerReference]` A reference to an Express customer with basic identifying information - `express_customer_id: str` Unique Express customer identifier. Format: cus_{32-hex-chars} - `express_customer_name: str` Name of the Express customer - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) study = client.viewer.studies.create( severity="high", study_description="CT Chest/Abdomen/Pelvis", study_instance_uid="1.2.840.113619.2.55.3.604688119.868.1234567890.123", ) print(study.study_instance_uid) ``` ## List `viewer.studies.list(StudyListParams**kwargs) -> SyncCursorStudies[StudyListResponse]` **get** `/v1/viewer/studies` Retrieves a paginated list of studies with optional filtering by assignment, severity, description, cancellation status, and viewer status. Returns up to 100 studies per request. ### Parameters - `assigned_to: Optional[str]` Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars> - `cursor: Optional[str]` Base64 encoded cursor from previous response - `express_customer_id: Optional[str]` Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars} - `is_cancelled: Optional[bool]` Filter by cancellation status - `limit: Optional[float]` Number of results to return (1-100) - `severity: Optional[Literal["normal", "high", "stat"]]` Filter by study severity - `"normal"` - `"high"` - `"stat"` - `study_description: Optional[str]` Filter by study description (contains match) - `study_viewer_status: Optional[Literal["incomplete", "complete"]]` Filter by study viewer status - `"incomplete"` - `"complete"` ### Returns - `class StudyListResponse: …` A study entity in the Viewer system with viewing status - `cancelled_at: Optional[datetime]` Timestamp when the study was cancelled, null if not cancelled - `created_at: Optional[datetime]` Timestamp when the study was created - `is_cancelled: bool` Whether the study has been cancelled - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `study_viewer_status: Literal["incomplete", "complete"]` - `"incomplete"` - `"complete"` - `updated_at: Optional[datetime]` Timestamp when the study was last updated - `assigned_to: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `created_by_api_key: Optional[APIKeyReference]` A reference to an API key with basic identifying information - `api_key_id: str` Unique API key identifier (UUIDv4 format) - `description: str` Human-readable description of the API key - `is_viewer_enabled: Optional[bool]` Whether this API key has access to the Viewer product - `created_by_user: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `express_customer: Optional[ExpressCustomerReference]` A reference to an Express customer with basic identifying information - `express_customer_id: str` Unique Express customer identifier. Format: cus_{32-hex-chars} - `express_customer_name: str` Name of the Express customer - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) page = client.viewer.studies.list() page = page.studies[0] print(page.study_instance_uid) ``` ## Retrieve `viewer.studies.retrieve(strstudy_id) -> StudyRetrieveResponse` **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. ### Parameters - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} ### Returns - `class StudyRetrieveResponse: …` A study entity in the Viewer system with viewing status - `cancelled_at: Optional[datetime]` Timestamp when the study was cancelled, null if not cancelled - `created_at: Optional[datetime]` Timestamp when the study was created - `is_cancelled: bool` Whether the study has been cancelled - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `study_viewer_status: Literal["incomplete", "complete"]` - `"incomplete"` - `"complete"` - `updated_at: Optional[datetime]` Timestamp when the study was last updated - `assigned_to: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `created_by_api_key: Optional[APIKeyReference]` A reference to an API key with basic identifying information - `api_key_id: str` Unique API key identifier (UUIDv4 format) - `description: str` Human-readable description of the API key - `is_viewer_enabled: Optional[bool]` Whether this API key has access to the Viewer product - `created_by_user: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `express_customer: Optional[ExpressCustomerReference]` A reference to an Express customer with basic identifying information - `express_customer_id: str` Unique Express customer identifier. Format: cus_{32-hex-chars} - `express_customer_name: str` Name of the Express customer - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) study = client.viewer.studies.retrieve( "stu_1234567890abcdef1234567890abcdef", ) print(study.study_instance_uid) ``` ## Update `viewer.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse` **patch** `/v1/viewer/studies/{studyId}` Updates a study's properties including description, severity, assignment, organization, and metadata. All fields are optional - only provided fields will be updated. ### Parameters - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `assigned_to: Optional[str]` User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars} - `metadata: Optional[Dict[str, str]]` - `severity: Optional[Literal["normal", "high", "stat"]]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: Optional[str]` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_viewer_status: Optional[Literal["incomplete", "complete"]]` - `"incomplete"` - `"complete"` ### Returns - `class StudyUpdateResponse: …` A study entity in the Viewer system with viewing status - `cancelled_at: Optional[datetime]` Timestamp when the study was cancelled, null if not cancelled - `created_at: Optional[datetime]` Timestamp when the study was created - `is_cancelled: bool` Whether the study has been cancelled - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `study_viewer_status: Literal["incomplete", "complete"]` - `"incomplete"` - `"complete"` - `updated_at: Optional[datetime]` Timestamp when the study was last updated - `assigned_to: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `created_by_api_key: Optional[APIKeyReference]` A reference to an API key with basic identifying information - `api_key_id: str` Unique API key identifier (UUIDv4 format) - `description: str` Human-readable description of the API key - `is_viewer_enabled: Optional[bool]` Whether this API key has access to the Viewer product - `created_by_user: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `express_customer: Optional[ExpressCustomerReference]` A reference to an Express customer with basic identifying information - `express_customer_id: str` Unique Express customer identifier. Format: cus_{32-hex-chars} - `express_customer_name: str` Name of the Express customer - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) study = client.viewer.studies.update( study_id="stu_1234567890abcdef1234567890abcdef", ) print(study.study_instance_uid) ``` ## Cancel `viewer.studies.cancel(StudyCancelParams**kwargs) -> StudyCancelResponse` **post** `/v1/viewer/studies/cancel` Marks a study as cancelled. Cancelled studies are preserved but flagged as inactive. Can be identified by either study ID or DICOM Study Instance UID. ### Parameters - `study_id: Optional[str]` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: Optional[str]` 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 StudyCancelResponse: …` Response for cancelling a study in Viewer - `success: bool` - `message: Optional[str]` ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) response = client.viewer.studies.cancel() print(response.success) ``` ## Uncancel `viewer.studies.uncancel(StudyUncancelParams**kwargs) -> StudyUncancelResponse` **post** `/v1/viewer/studies/uncancel` Restores a cancelled study to active status. The study must have been previously cancelled. Can be identified by either study ID or DICOM Study Instance UID. ### Parameters - `study_id: Optional[str]` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: Optional[str]` 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 StudyUncancelResponse: …` Response for uncancelling a study in Viewer - `success: bool` - `message: Optional[str]` ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) response = client.viewer.studies.uncancel() print(response.success) ``` ## Reroute URL `viewer.studies.reroute_url(StudyRerouteURLParams**kwargs) -> StudyRerouteURLResponse` **post** `/v1/viewer/studies/reroute-url` Generates a tokenized URL that redirects users directly to the Avara Viewer for the specified study. The URL includes authentication and is time-limited for security. ### Parameters - `study_id: Optional[str]` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: Optional[str]` 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 StudyRerouteURLResponse: …` Response containing the generated reroute URL for a study in Viewer - `url: str` ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) response = client.viewer.studies.reroute_url() print(response.url) ``` ## Retrieve By Uid `viewer.studies.retrieve_by_uid(strstudy_instance_uid) -> StudyRetrieveByUidResponse` **get** `/v1/viewer/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 - `study_instance_uid: str` 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 Viewer system with viewing status - `cancelled_at: Optional[datetime]` Timestamp when the study was cancelled, null if not cancelled - `created_at: Optional[datetime]` Timestamp when the study was created - `is_cancelled: bool` Whether the study has been cancelled - `severity: Literal["normal", "high", "stat"]` Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention - `"normal"` - `"high"` - `"stat"` - `study_description: str` Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT') - `study_id: str` Unique study identifier. Format: stu_{32-hex-chars} - `study_instance_uid: str` DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2') - `study_viewer_status: Literal["incomplete", "complete"]` - `"incomplete"` - `"complete"` - `updated_at: Optional[datetime]` Timestamp when the study was last updated - `assigned_to: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `created_by_api_key: Optional[APIKeyReference]` A reference to an API key with basic identifying information - `api_key_id: str` Unique API key identifier (UUIDv4 format) - `description: str` Human-readable description of the API key - `is_viewer_enabled: Optional[bool]` Whether this API key has access to the Viewer product - `created_by_user: Optional[UserReference]` A reference to a user with basic identifying information - `email: str` User's email address - `user_id: str` Unique user identifier. Format: usr_{32-hex-chars} - `first_name: Optional[str]` User's first name - `last_name: Optional[str]` User's last name - `middle_name: Optional[str]` User's middle name - `suffix1: Optional[str]` Name suffix (e.g., 'MD', 'Jr.') - `suffix2: Optional[str]` Additional name suffix - `express_customer: Optional[ExpressCustomerReference]` A reference to an Express customer with basic identifying information - `express_customer_id: str` Unique Express customer identifier. Format: cus_{32-hex-chars} - `express_customer_name: str` Name of the Express customer - `metadata: Optional[Dict[str, str]]` Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars ### Example ```python import os from avara import Avara client = Avara( api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted ) response = client.viewer.studies.retrieve_by_uid( "1.2.840.10008.5.1.4.1.1.2", ) print(response.study_instance_uid) ```