Create and invite a new user

UserInviteResponse autoScribe().users().invite(, )

post/v1/autoScribe/users

Creates a new user in the AutoScribe system and sends them an invitation email. The user will have the specified permissions including report creation and study management capabilities. NPI number is required for users who can create reports.

ParametersExpand Collapse

UserInviteParams params

boolean canCreateReports

boolean canManageStudies

ClinicRole clinicRole

User's clinical or organizational role

RADIOLOGIST("Radiologist")

CARDIOLOGIST("Cardiologist")

NEUROLOGIST("Neurologist")

UROLOGIST("Urologist")

GYNECOLOGIST("Gynecologist")

ENDOCRINOLOGIST("Endocrinologist")

DOCTOR("Doctor")

SURGEON("Surgeon")

PHYSICIAN("Physician")

PHYSICIAN_ASSISTANT("Physician Assistant")

NURSE_PRACTITIONER("Nurse Practitioner")

REGISTERED_NURSE("Registered Nurse")

PATIENT_CARE_COORDINATOR("Patient Care Coordinator")

FRONT_DESK_OPERATOR("Front Desk Operator")

IMAGING_TECHNOLOGIST("Imaging Technologist")

PACS_ADMINISTRATOR("PACS Administrator")

SOFTWARE_ENGINEER("Software Engineer")

REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")

ADMINISTRATIVE_DIRECTOR("Administrative Director")

ADMINISTRATIVE_ASSISTANT("Administrative Assistant")

OTHER("Other")

String email

User's email address for login and notifications

String firstName

User's first name

minLength1

boolean hasDashboardAccess

String lastName

User's last name

minLength1

Level level

ADMIN("admin")

MEMBER("member")

Optional<String> middleName

User's middle name (optional)

minLength1

Optional<String> npiNumber

minLength10

maxLength10

Optional<String> phoneNumber

User's phone number (10-15 digits, optional)

Optional<String> suffix1

Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional

minLength1

Optional<String> suffix2

Additional name suffix (optional)

minLength1

ReturnsExpand Collapse

class UserInviteResponse:

Response for inviting a user to AutoScribe. Level is restricted to admin/member since owners cannot be invited via API.

boolean canCreateReports

Whether the user can generate and sign radiology reports. Requires NPI number

boolean canManageStudies

Whether the user has permission to create, update, and manage studies

ClinicRole clinicRole

User's clinical or organizational role

Accepts one of the following:

RADIOLOGIST("Radiologist")

CARDIOLOGIST("Cardiologist")

NEUROLOGIST("Neurologist")

UROLOGIST("Urologist")

GYNECOLOGIST("Gynecologist")

ENDOCRINOLOGIST("Endocrinologist")

DOCTOR("Doctor")

SURGEON("Surgeon")

PHYSICIAN("Physician")

PHYSICIAN_ASSISTANT("Physician Assistant")

NURSE_PRACTITIONER("Nurse Practitioner")

REGISTERED_NURSE("Registered Nurse")

PATIENT_CARE_COORDINATOR("Patient Care Coordinator")

FRONT_DESK_OPERATOR("Front Desk Operator")

IMAGING_TECHNOLOGIST("Imaging Technologist")

PACS_ADMINISTRATOR("PACS Administrator")

SOFTWARE_ENGINEER("Software Engineer")

REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")

ADMINISTRATIVE_DIRECTOR("Administrative Director")

ADMINISTRATIVE_ASSISTANT("Administrative Assistant")

OTHER("Other")

Optional<LocalDateTime> createdAt

Timestamp when the user was created

formatdate-time

String email

User's email address for login and notifications

String firstName

User's first name

minLength1

boolean hasDashboardAccess

Whether the user can access the dashboard interface. Required for admin users

InvitedSource invitedSource

How the user was invited - via dashboard UI or API

Accepts one of the following:

DASHBOARD("dashboard")

API("api")

Optional<LocalDateTime> lastLoginAt

Timestamp of user's last login, null if never logged in

formatdate-time

String lastName

User's last name

minLength1

Level level

User access level. 'admin' can manage users/settings, 'member' has standard access

Accepts one of the following:

ADMIN("admin")

MEMBER("member")

String userId

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

Optional<String> middleName

User's middle name (optional)

minLength1

Optional<String> npiNumber

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10

maxLength10

Optional<String> phoneNumber

User's phone number (10-15 digits, optional)

Optional<String> suffix1

Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional

minLength1

Optional<String> suffix2

Additional name suffix (optional)

minLength1

Create and invite a new user

package com.avara.example;

import com.avara.client.AvaraClient;
import com.avara.client.okhttp.AvaraOkHttpClient;
import com.avara.models.autoscribe.users.UserInviteParams;
import com.avara.models.autoscribe.users.UserInviteResponse;

public final class Main {
    private Main() {}

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

        UserInviteParams params = UserInviteParams.builder()
            .canCreateReports(true)
            .canManageStudies(true)
            .clinicRole(UserInviteParams.ClinicRole.RADIOLOGIST)
            .email("dr.johnson@hospital.org")
            .firstName("Sarah")
            .hasDashboardAccess(true)
            .lastName("Johnson")
            .level(UserInviteParams.Level.MEMBER)
            .build();
        UserInviteResponse response = client.autoScribe().users().invite(params);
    }
}

{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}

Returns Examples

{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}