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; Viewer will not see it until you create it here. Without this call, there is nothing to open in the viewer.

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 PACS and Avara Viewer) instead.

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

Viewer create takes studyInstanceUid, studyDescription, and severity. There is no reportMetadata or priorReportTexts — those belong to AutoScribe.

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",
});

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",
)

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")
            .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",
});

For every field on create, see the API Reference.