Other operations
List, update, and cancel studies; open Viewer from your app; and manage users — the rest of the Viewer API around study create.
Create studies is the write that puts an exam into Viewer when you are not on Avara PACS. Everything on this page is the rest of the Viewer API around that study: look it up, change it, cancel it, and manage who can access studies. To open Viewer from your own app, see Temporary access views.
There are no code samples here. Method names and request fields live in the API Reference.
Identifiers you will see: studies stu_…, users usr_…, invitations inv_….
Viewer has no report delivery, addendums, or clinical references. Those are AutoScribe.
Studies
Section titled “Studies”Once a study exists (created by you, or seeded by Avara PACS), you can find it and change its workflow state.
- List — Page through studies for your organization (cursor pagination). Use this to sync a worklist into your PACS or RIS.
- Retrieve — Fetch one study by Avara
studyId(stu_…). - Retrieve by UID — Fetch the same study by DICOM Study Instance UID when your system thinks in UIDs, not Avara ids.
- Update — Patch description, severity, assignment, and custom
metadata. Viewer update does not take report headers (reportMetadata) or priors (priorStudyIds,priorReportTexts). - Cancel — Mark a study cancelled so it drops out of the active worklist. The record remains; it is not deleted.
- Uncancel — Restore a cancelled study to the worklist.
Staff who work in Viewer. You can invite from the dashboard or from the API when the key has user access.
- Invite — Create an invitation (email, name, role, level, dashboard access, and whether they can manage studies). Viewer invitations do not include NPI or report-creation flags. Owners cannot be invited via API.
- List / retrieve / update — Directory of users; change permissions or name after they exist.
- Revoke access — Remove the user from the organization.
- Reactivate — Restore a previously revoked user.
Invitations are their own records (inv_…): list, retrieve, update, and revoke a pending invite. The invited person must accept before you can assign studies to them. Status includes sent, accepted, rejected, and revoked.