Create studies

This is the most important API call for a PACS company — or any platform that is the DICOM archive of record and is not using Avara PACS. Your system already has the study; AutoScribe will not see it until you create it here. Without this call, there is nothing to dictate, view, or deliver a report against.

If you (or your customer) use Avara PACS, skip this page. Studies are seeded when the PACS node receives C-STORE. Use What webhooks should I configure (EHR/RIS with Avara-managed PACS) instead.

You need an API key (AVARA_API_KEY) from API Config. Manual create in the dashboard still works for testing.

If you already generate a clinical-history summary, pass it on create (for example priorReportTexts) and you can skip the Clinical Context Enrichment webhook. See What webhooks should I configure.

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",
  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",
    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")
            .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",
    ReportMetadata = new StudyReportMetadata
    {
        ScanDate = "2026-08-13",
        PatientName = "Jane Doe",
        DateOfBirth = "1980-01-15",
        FacilityName = "South Tampa Imaging",
    },
});

For every field on create, including reportMetadata and priorReportTexts, see the API Reference.