Studies

Integration

Avara Express

Attach an Express customer on study create so members of that tenant can see the exam — and nobody else’s members can.

Pass expressCustomerId when you create a study. That label is what Isolation uses.

Use the same create payloads as AutoScribe create studies and Viewer create studies, plus the customer id. You need an API key with Express customer access.

AutoScribe

TypeScript

import Avara from "avara";

const client = new Avara({
  apiKey: process.env.AVARA_API_KEY,
});

const study = await client.autoScribe.studies.create({
  studyInstanceUid: "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  studyDescription: "Brain MRI with Contrast",
  severity: "normal",
  expressCustomerId: "cus_1234567890abcdef1234567890abcdef",
  reportMetadata: {
    scanDate: "2026-08-13",
    patientName: "Jane Doe",
    dateOfBirth: "1980-01-15",
    facilityName: "South Tampa Imaging",
  },
});

Python

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),
)
study = client.auto_scribe.studies.create(
    study_instance_uid="1.2.840.113619.2.55.3.604688119.868.1234567890.123",
    study_description="Brain MRI with Contrast",
    severity="normal",
    express_customer_id="cus_1234567890abcdef1234567890abcdef",
    report_metadata={
        "scan_date": "2026-08-13",
        "patient_name": "Jane Doe",
        "date_of_birth": "1980-01-15",
        "facility_name": "South Tampa Imaging",
    },
)

Java

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.StudyReportMetadata;
import com.avara.models.autoscribe.studies.StudyCreateParams;
import com.avara.models.autoscribe.studies.StudyCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyCreateParams params = StudyCreateParams.builder()
            .severity(StudyCreateParams.Severity.NORMAL)
            .studyDescription("Brain MRI with Contrast")
            .studyInstanceUid("1.2.840.113619.2.55.3.604688119.868.1234567890.123")
            .expressCustomerId("cus_1234567890abcdef1234567890abcdef")
            .reportMetadata(StudyReportMetadata.builder()
                .scanDate("2026-08-13")
                .patientName("Jane Doe")
                .dateOfBirth("1980-01-15")
                .facilityName("South Tampa Imaging")
                .build())
            .build();
        StudyCreateResponse study = client.autoScribe().studies().create(params);
    }
}

C#

using Avara;
using Avara.Models.AutoScribe;
using Avara.Models.AutoScribe.Studies;

var client = new AvaraClient();

var study = await client.AutoScribe.Studies.Create(new StudyCreateParams
{
    Severity = StudyCreateParams.Severity.Normal,
    StudyDescription = "Brain MRI with Contrast",
    StudyInstanceUid = "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
    ExpressCustomerId = "cus_1234567890abcdef1234567890abcdef",
    ReportMetadata = new StudyReportMetadata
    {
        ScanDate = "2026-08-13",
        PatientName = "Jane Doe",
        DateOfBirth = "1980-01-15",
        FacilityName = "South Tampa Imaging",
    },
});

Viewer

TypeScript

import Avara from "avara";

const client = new Avara({
  apiKey: process.env.AVARA_API_KEY,
});

const study = await client.viewer.studies.create({
  studyInstanceUid: "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  studyDescription: "Brain MRI with Contrast",
  severity: "normal",
  expressCustomerId: "cus_1234567890abcdef1234567890abcdef",
});

Python

import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),
)
study = client.viewer.studies.create(
    study_instance_uid="1.2.840.113619.2.55.3.604688119.868.1234567890.123",
    study_description="Brain MRI with Contrast",
    severity="normal",
    express_customer_id="cus_1234567890abcdef1234567890abcdef",
)

Java

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.viewer.studies.StudyCreateParams;
import com.avara.models.viewer.studies.StudyCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AvaraClient client = AvaraOkHttpClient.fromEnv();

        StudyCreateParams params = StudyCreateParams.builder()
            .severity(StudyCreateParams.Severity.NORMAL)
            .studyDescription("Brain MRI with Contrast")
            .studyInstanceUid("1.2.840.113619.2.55.3.604688119.868.1234567890.123")
            .expressCustomerId("cus_1234567890abcdef1234567890abcdef")
            .build();
        StudyCreateResponse study = client.viewer().studies().create(params);
    }
}

C#

using Avara;
using Avara.Models.Viewer.Studies;

var client = new AvaraClient();

var study = await client.Viewer.Studies.Create(new StudyCreateParams
{
    Severity = StudyCreateParams.Severity.Normal,
    StudyDescription = "Brain MRI with Contrast",
    StudyInstanceUid = "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
    ExpressCustomerId = "cus_1234567890abcdef1234567890abcdef",
});

For every field on create, see the API Reference.