Update a study
auto_scribe.studies.update(strstudy_id, StudyUpdateParams**kwargs) -> StudyUpdateResponse
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.
Parameters
study_id: str
Unique study identifier. Format: stu_{32-hex-chars}
assigned_to: Optional[str]
User ID to assign the study to, or null to unassign. Format: usr_{32-hex-chars}
clinical_history: Optional[str]
Relevant clinical history for the patient/study. Null clears.
clinical_indication: Optional[str]
Clinical indication for the study. Null clears.
express_customer_id: Optional[str]
Express Customer ID for the study, or null to remove. Format: cus_{32-hex-chars}
external_patient_id: Optional[str]
Integrator-provided stable patient identifier used to link studies for the same patient. Null clears.
metadata: Optional[Dict[str, str]]
modality: Optional[str]
Imaging modality for the study (free text). Null clears.
study_description: Optional[str]
Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')
minLength1
technologist_notes: Optional[SequenceNotStr[str]]
Technologist notes for the study. Null clears; an array replaces the existing set. Maximum 50 items, each up to 1000 characters
technologist_technique: Optional[str]
Imaging technique description provided by the technologist. Null clears.
Returns
Update a study
import os
from avara import Avara
client = Avara(
api_key=os.environ.get("AVARA_API_KEY"), # This is the default and can be omitted
)
study = client.auto_scribe.studies.update(
study_id="stu_1234567890abcdef1234567890abcdef",
)
print(study.study_instance_uid){
"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",
"procedure": "MRI Brain with Contrast",
"referringPhysicianName": "Dr. Michael Chen",
"sex": "female",
"studyDate": "2024-03-15",
"studyTime": "14:30",
"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"
},
"clinicalHistory": "clinicalHistory",
"clinicalIndication": "clinicalIndication",
"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"
},
"expressCustomer": {
"expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
"expressCustomerName": "City Medical Center"
},
"externalPatientId": "externalPatientId",
"isCritical": true,
"metadata": {
"department": "radiology",
"priority": "routine"
},
"modality": "modality",
"priorReports": [
{
"reportText": "IMPRESSION: No acute cardiopulmonary process.",
"externalStudyId": "EXT-2024-001",
"modality": "CT",
"studyDate": "2024-01-15",
"studyDescription": "CT Chest without contrast"
}
],
"reportIds": [
{
"isCritical": null,
"reportId": "rep_1234567890abcdef1234567890abcdef",
"status": "in_progress"
}
],
"technologistNotes": [
"x"
],
"technologistTechnique": "technologistTechnique"
}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",
"procedure": "MRI Brain with Contrast",
"referringPhysicianName": "Dr. Michael Chen",
"sex": "female",
"studyDate": "2024-03-15",
"studyTime": "14:30",
"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"
},
"clinicalHistory": "clinicalHistory",
"clinicalIndication": "clinicalIndication",
"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"
},
"expressCustomer": {
"expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
"expressCustomerName": "City Medical Center"
},
"externalPatientId": "externalPatientId",
"isCritical": true,
"metadata": {
"department": "radiology",
"priority": "routine"
},
"modality": "modality",
"priorReports": [
{
"reportText": "IMPRESSION: No acute cardiopulmonary process.",
"externalStudyId": "EXT-2024-001",
"modality": "CT",
"studyDate": "2024-01-15",
"studyDescription": "CT Chest without contrast"
}
],
"reportIds": [
{
"isCritical": null,
"reportId": "rep_1234567890abcdef1234567890abcdef",
"status": "in_progress"
}
],
"technologistNotes": [
"x"
],
"technologistTechnique": "technologistTechnique"
}