Shared

ModelsExpand Collapse

class ApiKeyReference:

A reference to an API key with basic identifying information

String apiKeyId

Unique API key identifier (UUIDv4 format)

formatuuid

String description

Human-readable description of the API key

minLength1

Optional<Boolean> isClinicalContextEnrichmentEnabled

Whether this API key has a clinical-context enrichment webhook configured

Optional<Boolean> isViewerEnabled

Whether this API key has access to the Viewer product

enum AssignableUserLevel:

User access level assignable via the API. ‘admin’ can manage users/settings, ‘member’ has standard access. ‘owner’ is dashboard-only and cannot be assigned via the API.

ADMIN("admin")

MEMBER("member")

enum ClinicRole:

A user’s clinical or organizational role within the clinic.

DOCTOR("Doctor")

PHYSICIAN("Physician")

SURGEON("Surgeon")

RADIOLOGIST("Radiologist")

CARDIOLOGIST("Cardiologist")

NEUROLOGIST("Neurologist")

UROLOGIST("Urologist")

GYNECOLOGIST("Gynecologist")

ENDOCRINOLOGIST("Endocrinologist")

ONCOLOGIST("Oncologist")

RADIATION_ONCOLOGIST("Radiation Oncologist")

HEMATOLOGIST("Hematologist")

GASTROENTEROLOGIST("Gastroenterologist")

PULMONOLOGIST("Pulmonologist")

NEPHROLOGIST("Nephrologist")

RHEUMATOLOGIST("Rheumatologist")

DERMATOLOGIST("Dermatologist")

OPHTHALMOLOGIST("Ophthalmologist")

OTOLARYNGOLOGIST("Otolaryngologist")

PEDIATRICIAN("Pediatrician")

OBSTETRICIAN("Obstetrician")

PSYCHIATRIST("Psychiatrist")

ANESTHESIOLOGIST("Anesthesiologist")

EMERGENCY_MEDICINE_PHYSICIAN("Emergency Medicine Physician")

FAMILY_MEDICINE_PHYSICIAN("Family Medicine Physician")

INTERNAL_MEDICINE_PHYSICIAN("Internal Medicine Physician")

PATHOLOGIST("Pathologist")

NUCLEAR_MEDICINE_PHYSICIAN("Nuclear Medicine Physician")

PAIN_MANAGEMENT_SPECIALIST("Pain Management Specialist")

INFECTIOUS_DISEASE_SPECIALIST("Infectious Disease Specialist")

IMMUNOLOGIST("Immunologist")

PHYSICIAN_ASSISTANT("Physician Assistant")

NURSE_PRACTITIONER("Nurse Practitioner")

CERTIFIED_REGISTERED_NURSE_ANESTHETIST("Certified Registered Nurse Anesthetist")

PSYCHOLOGIST("Psychologist")

MEDICAL_ASSISTANT("Medical Assistant")

SCRIBE("Scribe")

REGISTERED_NURSE("Registered Nurse")

NURSE_MANAGER("Nurse Manager")

PATIENT_CARE_COORDINATOR("Patient Care Coordinator")

IMAGING_TECHNOLOGIST("Imaging Technologist")

LABORATORY_TECHNICIAN("Laboratory Technician")

MEDICAL_LABORATORY_SCIENTIST("Medical Laboratory Scientist")

PATHOLOGISTS_ASSISTANT("Pathologists' Assistant")

PHLEBOTOMIST("Phlebotomist")

PHARMACIST("Pharmacist")

PHARMACY_TECHNICIAN("Pharmacy Technician")

PHYSICAL_THERAPIST("Physical Therapist")

OCCUPATIONAL_THERAPIST("Occupational Therapist")

SPEECH_LANGUAGE_PATHOLOGIST("Speech-Language Pathologist")

RESPIRATORY_THERAPIST("Respiratory Therapist")

NUTRITIONIST("Nutritionist")

FRONT_DESK_OPERATOR("Front Desk Operator")

REVENUE_CYCLE_MANAGER("Revenue Cycle Manager")

ADMINISTRATIVE_DIRECTOR("Administrative Director")

ADMINISTRATIVE_ASSISTANT("Administrative Assistant")

LEGAL_ADMINISTRATOR("Legal Administrator")

IT_ADMINISTRATOR("IT Administrator")

IT_SUPPORT("IT Support")

SOFTWARE_ENGINEER("Software Engineer")

OTHER("Other")

class EphemeralHangingProtocol:

Optional single-monitor hanging protocol applied when the ephemeral viewer loads. Omitted = no protocol. Invalid shape is rejected.

ViewerLayout layout

Viewport grid layout for an ephemeral hanging protocol. Wire values match first-party viewer layouts (‘1x1’ through ‘4x4’).

One of the following:

ONE_BY_ONE("1x1")

ONE_BY_TWO("1x2")

ONE_BY_THREE("1x3")

ONE_BY_FOUR("1x4")

TWO_BY_ONE("2x1")

TWO_BY_TWO("2x2")

TWO_BY_THREE("2x3")

TWO_BY_FOUR("2x4")

THREE_BY_ONE("3x1")

THREE_BY_TWO("3x2")

THREE_BY_THREE("3x3")

THREE_BY_FOUR("3x4")

FOUR_BY_ONE("4x1")

FOUR_BY_TWO("4x2")

FOUR_BY_THREE("4x3")

FOUR_BY_FOUR("4x4")

List<String> viewportAssignments

class ExpressCustomerReference:

A reference to an Express customer with basic identifying information

String expressCustomerId

Unique Express customer identifier. Format: cus_{32-hex-chars}

String expressCustomerName

Name of the Express customer

minLength1

enum InvitationExpiredFilter:

Filter by expiration status

ALL("all")

EXPIRED("expired")

NOT_EXPIRED("not-expired")

enum InvitationStatus:

Lifecycle status of an invitation: ‘sent’, ‘accepted’, ‘rejected’, or ‘revoked’.

SENT("sent")

ACCEPTED("accepted")

REJECTED("rejected")

REVOKED("revoked")

enum InvitedSource:

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

DASHBOARD("dashboard")

API("api")

enum Severity:

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

NORMAL("normal")

HIGH("high")

STAT("stat")

enum UserLevel:

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

OWNER("owner")

ADMIN("admin")

MEMBER("member")

class UserReference:

A reference to a user with basic identifying information

String email

User’s email address

String userId

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

Optional<String> firstName

User’s first name

Optional<String> lastName

User’s last name

Optional<String> middleName

User’s middle name

Optional<String> suffix1

Name suffix (e.g., ‘MD’, ‘Jr.’)

Optional<String> suffix2

Additional name suffix

enum ViewerLayout: