Introduction

This section is for integrating partners: PACS companies, EHR/RIS companies, distributors with their own software platform, and IT teams wiring Avara into an existing system.

You sell or operate imaging or clinical software. AutoScribe, Viewer, or both should show up inside that product — studies created from your system, webhooks back to your archive or RIS, users opening Avara without a second login when you want that.

Clinical Platform sites do not need a separate integration. Start from the Clinical Platform overview. Distributors who only do support and resale, without a software platform, should use a separate Avara organization per customer, not Express.

Which product to integrate

Pick the track that matches what you are embedding. Each product spells out what to configure (API key, which webhooks, when to create studies) so you do not implement every endpoint.

AutoScribeReporting and dictation. Configure an API key, pick webhook profiles, create studies if you are not on Avara PACS, invite readers.ViewerViewing only — no reporting. Three webhooks at most. Create studies if DICOM lives in your archive.Avara ExpressSell AutoScribe and/or Viewer as a service to your customers. Deep integration — expect a real API implementation to fit your data model.Clinical PlatformNo partner integration to stand up. Use the product overview.

How configuration is spelled out

For AutoScribe and Viewer, start at API Config (create the key, webhook URLs, signing secret), then What webhooks should I configure. That page maps who you are (PACS with your own archive vs EHR/RIS on Avara PACS, with or without Avara Viewer) to the endpoints to set. Leave the rest blank.

Express adds tenants on top of those products: enable Express, create customers, add users, attach expressCustomerId on study create. Isolation is membership-based — Isolation.

AutoScribe

API ConfigCreate the AutoScribe API key and set webhook URLs.What webhooks should I configureThree profiles: PACS without Avara Viewer, PACS with Avara Viewer, EHR/RIS with Avara PACS.Create studiesRequired when you are the archive and not using Avara PACS.Temporary access viewsOpen AutoScribe (or viewer-only) from your app without a dashboard login.

Viewer

API ConfigCreate the Viewer API key and set the three Viewer webhook URLs.What webhooks should I configureTwo profiles: your DICOM archive plus Avara Viewer, or EHR/RIS with Avara PACS.Create studiesRequired when you are the archive and not using Avara PACS.Temporary access viewsOpen Viewer from your app with a short-lived URL.

Avara Express

IntroductionWho Express is for, billing, and how to enable it.IsolationAdmins see everything. Members see only the customers they belong to.CustomersCreate and manage Express customers.StudiesAttach expressCustomerId so tenant members can see the exam.

Objects, pixels, and the API

Identifiers (stu_…, usr_…, cus_…) and the shape of studies, users, and Express customers are on the API Data Model page. How the viewer actually fetches DICOM — presigned blob URLs, not DICOMweb — is on Loading Viewer Data. Method names, request fields, and generated SDK snippets are on the API Reference.

API Data ModelBranded IDs, AutoScribe vs Viewer objects, and Express customer fields.Loading Viewer DataPresigned blob URLs, just-in-time parse, Avara PACS vs your archive webhook.API ReferenceEvery endpoint and SDK operation — docs.avarasoftware.com/api.