Update a study

patch/v1/autoScribe/studies/{studyId}

Updates a study's properties including description, severity, assignment, organization, metadata, and report metadata. All fields are optional - only provided fields will be updated.

Path ParametersExpand Collapse

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

Body ParametersExpand Collapse

assignedTo: optional string

User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars}

metadata: optional map[string]

orgId: optional string

Organization ID for the study, or null to remove. Format: org_{32-hex-chars}

priorReportTexts: optional array of string

priorStudyIds: optional array of string

reportMetadata: optional object { age, dateOfBirth, facilityName, 9 more }

age: optional string

dateOfBirth: optional string

facilityName: optional string

height: optional object { unit, value }

unit: "in" or "cm"

Accepts one of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

patientName: optional string

referringPhysicianName: optional string

scanDate: optional string

scanTime: optional string

scanType: optional string

sex: optional "male" or "female" or "other"

Accepts one of the following:

"male"

"female"

"other"

weight: optional object { unit, value }

unit: "lbs" or "kg"

Accepts one of the following:

"lbs"

"kg"

value: number

minimum0

severity: optional "normal" or "high" or "stat"

Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

Accepts one of the following:

"normal"

"high"

"stat"

studyDescription: optional string

Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')

minLength1

ReturnsExpand Collapse

cancelledAt: string

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

createdAt: string

Timestamp when the study was created

formatdate-time

isCancelled: boolean

Whether the study has been cancelled

reportMetadata: StudyReportMetadata { age, dateOfBirth, facilityName, 9 more }

Patient demographics and scan information for report generation

age: optional string

Patient's age at time of scan (e.g., '34.5 years', '2 months')

dateOfBirth: optional string

Patient's date of birth. Format: YYYY-MM-DD (e.g., '1990-05-20')

facilityName: optional string

Name of the medical facility where the scan was performed

height: optional object { unit, value }

Patient's height with unit (e.g., {value: 70, unit: 'inches'} or {value: 178, unit: 'cm'})

unit: "in" or "cm"

Accepts one of the following:

"in"

"cm"

value: number

minimum0

mrn: optional string

Medical Record Number - unique patient identifier

patientName: optional string

Full name of the patient

referringPhysicianName: optional string

Name of the physician who referred the patient for this scan

scanDate: optional string

Date the scan was performed. Format: YYYY-MM-DD (e.g., '2024-01-15')

scanTime: optional string

Time the scan was performed. Format: HH:MM (e.g., '14:30')

scanType: optional string

Type of scan or imaging modality (e.g., 'MRI', 'CT', 'X-Ray', 'Ultrasound')

sex: optional "male" or "female" or "other"

Patient's biological sex. Options: 'male', 'female', 'other'

Accepts one of the following:

"male"

"female"

"other"

weight: optional object { unit, value }

Patient's weight with unit (e.g., {value: 150, unit: 'lbs'} or {value: 68, unit: 'kg'})

unit: "lbs" or "kg"

Accepts one of the following:

"lbs"

"kg"

value: number

minimum0

severity: "normal" or "high" or "stat"

Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

Accepts one of the following:

"normal"

"high"

"stat"

studyDescription: string

Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')

minLength1

studyId: string

Unique study identifier. Format: stu_{32-hex-chars}

studyInstanceUid: string

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

studyReportStatus: "unassigned" or "assigned" or "in_progress" or 2 more

Report workflow status. 'unassigned' = no radiologist assigned, 'assigned' = assigned but not started, 'in_progress' = actively being dictated, 'completed' = report signed, 'addendum_active' = addendum in progress

Accepts one of the following:

"unassigned"

"assigned"

"in_progress"

"completed"

"addendum_active"

updatedAt: string

Timestamp when the study was last updated

formatdate-time

assignedTo: optional object { email, userId, firstName, 4 more }

Reference to the assigned radiologist, null if unassigned

email: string

User's email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User's first name

lastName: optional string

User's last name

middleName: optional string

User's middle name

suffix1: optional string

Name suffix (e.g., 'MD', 'Jr.')

suffix2: optional string

Additional name suffix

createdByApiKey: optional object { apiKeyId, description, isViewerEnabled }

Reference to the API key used to create this study

apiKeyId: string

Unique API key identifier (UUIDv4 format)

formatuuid

description: string

Human-readable description of the API key

minLength1

isViewerEnabled: optional boolean

Whether this API key has access to the Viewer product

createdByUser: optional object { email, userId, firstName, 4 more }

Reference to the user who created this study via dashboard

email: string

User's email address

userId: string

Unique user identifier. Format: usr_{32-hex-chars}

firstName: optional string

User's first name

lastName: optional string

User's last name

middleName: optional string

User's middle name

suffix1: optional string

Name suffix (e.g., 'MD', 'Jr.')

suffix2: optional string

Additional name suffix

metadata: optional map[string]

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

org: optional object { orgId, orgName }

Reference to the organization this study belongs to

orgId: string

Unique organization identifier. Format: org_{32-hex-chars}

orgName: string

Name of the organization

minLength1

priorReportTexts: optional array of string

Array of prior report texts to provide clinical context

priorStudyIds: optional array of string

Array of prior study IDs for comparison context (format: stu_{32-hex-chars})

reportIds: optional array of ReportIDWithStatus { reportId, status }

Array of report IDs associated with this study, including addendums

reportId: string

Unique report identifier. Format: rep_{32-hex-chars}

status: "in_progress" or "completed"

Current status of the report

Accepts one of the following:

"in_progress"

"completed"

Update a study

curl https://api.avarasoftware.com/v1/autoScribe/studies/$STUDY_ID \
    -X PATCH \
    -H "Authorization: Bearer $AVARA_API_KEY"

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "reportMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "severity": "normal",
  "studyDescription": "Brain MRI with Contrast",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyReportStatus": "in_progress",
  "updatedAt": "2024-03-15T14:20:00Z",
  "assignedTo": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "createdByApiKey": {
    "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "Production API Key",
    "isViewerEnabled": true
  },
  "createdByUser": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}

Returns Examples

{
  "cancelledAt": null,
  "createdAt": "2024-03-15T10:30:00Z",
  "isCancelled": false,
  "reportMetadata": {
    "age": "38 years",
    "dateOfBirth": "1985-07-20",
    "facilityName": "City Medical Center",
    "height": {
      "unit": "cm",
      "value": 165
    },
    "mrn": "MRN-2024-001234",
    "patientName": "Jane Doe",
    "referringPhysicianName": "Dr. Michael Chen",
    "scanDate": "2024-03-15",
    "scanTime": "14:30",
    "scanType": "MRI Brain with Contrast",
    "sex": "female",
    "weight": {
      "unit": "kg",
      "value": 62
    }
  },
  "severity": "normal",
  "studyDescription": "Brain MRI with Contrast",
  "studyId": "stu_1234567890abcdef1234567890abcdef",
  "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
  "studyReportStatus": "in_progress",
  "updatedAt": "2024-03-15T14:20:00Z",
  "assignedTo": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "createdByApiKey": {
    "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
    "description": "Production API Key",
    "isViewerEnabled": true
  },
  "createdByUser": {
    "email": "dr.smith@radiology.com",
    "userId": "usr_1234567890abcdef1234567890abcdef",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "Robert",
    "suffix1": "MD",
    "suffix2": "FACR"
  },
  "metadata": {
    "department": "radiology",
    "priority": "routine"
  },
  "org": {
    "orgId": "org_1234567890abcdef1234567890abcdef",
    "orgName": "City Medical Center"
  },
  "priorReportTexts": [
    "Previous imaging shows stable findings."
  ],
  "priorStudyIds": [
    "stu_abcdef1234567890abcdef1234567890"
  ],
  "reportIds": [
    {
      "reportId": "rep_1234567890abcdef1234567890abcdef",
      "status": "in_progress"
    }
  ]
}