Other operations

Create studies is the write that puts an exam into AutoScribe when you are not on Avara PACS. Everything on this page is the rest of the AutoScribe API around that study: look it up, change it, cancel it, pull the report, manage who can sign, and store clinical references. To open AutoScribe 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_…, reports rep_…, invitations inv_….

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, report headers (reportMetadata), priors (priorStudyIds, priorReportTexts), and custom metadata. Use this when demographics or clinical history arrive after create.
• Cancel — Mark a study cancelled so it drops out of active reading. The record remains; it is not deleted.
• Uncancel — Restore a cancelled study to the worklist.

Reports

Signing happens in AutoScribe. Your integration either receives the finished report on the report.delivered webhook, or pulls it when you need it.

• List — Reports (and addendums) for a study, each with status (in_progress or completed).
• Text — Plain-text body of a completed report.
• PDF — Downloadable PDF of a completed report (typically via a presigned URL).

If you configured Report Data, Avara pushes report.delivered when a report is signed (plainText, PDF URL, isCritical). List / text / PDF are the pull equivalent — useful for backfill, retries, or when you did not enable the webhook.

Addendums

A signed report is immutable. Corrections go on as addendums so the original stays intact.

• Addendum — Start an addendum on a completed report. The study moves to addendum_active until the addendum is signed.
• Cancel addendum — Drop an in-progress addendum. The original completed report is unchanged.

Any number of addendums can be signed over time. Each is timestamped and attributed to the signing reader.

Users

Readers and staff who work in AutoScribe. 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, study-management and report-creation flags). Report creation requires an NPI. Owners cannot be invited via API.
• List / retrieve / update — Directory of users; change permissions, name, or NPI 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.

Clinical references

Clinical references are reusable clinical records you store in Avara so the same patient context can follow across studies — not just the fields you send on a single study create.

• Create — Add a reference, optionally keyed by an id from your own system.
• List / retrieve — Find references for your organization, or fetch one by Avara id.
• Retrieve by external reference id — Look up the same object using the id from your EHR or PACS.
• Update / delete — Correct or remove a reference when the source system changes.

One-off priors on a single exam can still go on study create or clinical context enrichment. Use clinical references when that history should live in Avara and be looked up again later.