@rinse-dental/open-dental 0.0.6 → 0.1.1

package/src/types/appointmentType.ts

@@ -0,0 +1,249 @@
+/**
+ * Represents an appointment in the Open Dental system.
+ * Used in multiple appointment-related endpoints.
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+export interface Appointment {
+    serverDateTime?: string; // Server timestamp of the appointment; returned by some endpoints
+    AptNum?: number; // Unique identifier for the appointment
+    PatNum?: number; // Unique identifier for the patient
+    AptStatus?: AptStatus; // Status of the appointment (Scheduled, Complete, etc.)
+    Pattern?: string; // Time pattern in 5-minute increments, e.g., "/XX/" for 20 minutes
+    Confirmed?: number; // Confirmation status code
+    confirmed?: string; // Description of the confirmation status
+    TimeLocked?: "true" | "false"; // Indicates if the appointment time is locked
+    Op?: number; // Operatory number
+    Note?: string; // Notes for the appointment
+    ProvNum?: number; // Provider number associated with the appointment
+    provAbbr?: string; // Abbreviation of the provider's name
+    ProvHyg?: number; // Hygienist provider number
+    AptDateTime?: string; // Appointment start time in "yyyy-MM-dd HH:mm:ss" format
+    NextAptNum?: number; // Appointment number of the next scheduled appointment
+    UnschedStatus?: number; // Status of an unscheduled appointment
+    unschedStatus?: string; // Description of the unscheduled status
+    IsNewPatient?: "true" | "false"; // Indicates if the appointment is for a new patient
+    ProcDescript?: string; // Description of procedures linked to the appointment
+    ClinicNum?: number; // Clinic number, optional if not using clinics
+    IsHygiene?: "true" | "false"; // Indicates if the appointment is for hygiene
+    DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
+    DateTimeArrived?: string; // Time the patient arrived, if available
+    DateTimeSeated?: string; // Time the patient was seated, if available
+    DateTimeDismissed?: string; // Time the patient was dismissed, if available
+    InsPlan1?: number; // Primary insurance plan number
+    InsPlan2?: number; // Secondary insurance plan number
+    DateTimeAskedToArrive?: string; // Requested arrival time in "yyyy-MM-dd HH:mm:ss" format
+    colorOverride?: string; // Custom color in "R,G,B" format
+    AppointmentTypeNum?: number; // Appointment type number
+    eServiceLogType?: string; //Used only for GET WebSched; eServiceLogType field as either "Recall", "NewPat", "ExistingPat", or "ASAP"
+    SecDateTEntry?: string; // Secondary date entry timestamp
+    Priority?: Priority; // Priority of the appointment (Normal, ASAP)
+    PatternSecondary?: string; // Secondary time pattern in 5-minute increments
+    ItemOrderPlanned?: number; // Order of the item in planned appointments
+  }
+
+  /**
+   * Parameters for GET Appointments.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface GetAppointmentParams {
+    PatNum?: number; // Filter by patient number
+    AptStatus?: AptStatus; // Filter by appointment status
+    Op?: number; // Filter by operatory number
+    date?: string; // Search for a specific day in "yyyy-MM-dd" format
+    dateStart?: string; // Start date for date range in "yyyy-MM-dd" format
+    dateEnd?: string; // End date for date range in "yyyy-MM-dd" format
+    ClinicNum?: number; // Filter by clinic number
+    DateTStamp?: string; // Return only appointments updated after this timestamp
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for GET ASAP Appointments.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+    export interface GetASAPParams {
+        ClinicNum?: number; // Required if clinics are enabled
+        ProvNum?: number; // Optional provider number
+      }
+
+  /**
+   * Parameters for GET Slots.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface GetSlotsParams {
+    date?: string; // Search for a specific day in "yyyy-MM-dd" format
+    dateStart?: string; // Start date for date range in "yyyy-MM-dd" format
+    dateEnd?: string; // End date for date range in "yyyy-MM-dd" format
+    lengthMinutes?: number; // Minimum length of the slot in minutes
+    ProvNum?: number; // Provider number
+    OpNum?: number; // Operatory number
+  }
+
+  /**
+   * Parameters for GET SlotsWebSched.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface GetSlotsWebSchedParams {
+    date?: string; // Search for a specific day in "yyyy-MM-dd" format
+    dateStart?: string; // Start date for date range in "yyyy-MM-dd" format
+    dateEnd?: string; // End date for date range in "yyyy-MM-dd" format
+    ClinicNum: number; // Required if clinics are enabled
+    defNumApptType?: number; // Appointment type definition number
+    isNewPatient?: 'true' | 'false'; // Indicate if the appointment is for a new patient
+  }
+  
+  /**
+   * Represents an appointment slot object, used to return GET Slots and GET SlotsWebSched.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface AppointmentSlot {
+    DateTimeStart?: string; // Start time of the slot in "yyyy-MM-dd HH:mm:ss" format
+    DateTimeEnd?: string; // End time of the slot in "yyyy-MM-dd HH:mm:ss" format
+    ProvNum?: number; // Provider number associated with the slot
+    OpNum?: number; // Operatory number associated with the slot
+  }
+  
+  /**
+   * Parameters for GET WebSched Appointments. Returns an abridged appointment object.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface GetWebSchedAppointmentsParams {
+    date?: string; // Search for a specific day in "yyyy-MM-dd" format
+    dateStart?: string; // Start date for date range in "yyyy-MM-dd" format
+    dateEnd?: string; // End date for date range in "yyyy-MM-dd" format
+    DateTStamp?: string; // Return only appointments updated after this timestamp
+    ClinicNum?: number; // Filter by clinic number
+  }
+  
+  /**
+   * Parameters for creating a new appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface CreateNewAppointmentParams {
+    PatNum: number; // Required: Patient number
+    Op: number; // Required: Operatory number
+    AptDateTime: string; // Required: Appointment start time in "yyyy-MM-dd HH:mm:ss" format
+    AptStatus?: AptStatus; // Optional: Appointment status
+    Pattern?: string; // Optional: Time pattern
+    Confirmed?: number; // Optional: Confirmation status
+    Note?: string; // Optional: Notes for the appointment
+    ProvNum?: number; // Optional: Provider number
+    ProvHyg?: number; // Optional: Hygienist provider number
+    ClinicNum?: number; // Optional: Clinic number
+    IsHygiene?: 'true' | 'false'; // Optional: Indicates a hygiene appointment. Default false.
+    IsNewPatient?: 'true' | 'false'; // Optional: Indicates a new patient appointment. Default false.
+    Priority?: Priority; // Optional: Appointment priority. Default "Normal".
+    AppointmentTypeNum?: number; // Optional: Appointment type number
+    colorOverride?: string; // Optional: Custom color in "R,G,B" format
+    PatternSecondary?: string; // Optional: Secondary time pattern
+  }
+  
+  /**
+   * Parameters for creating a planned appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface CreatePlannedAppointmentParams {
+    PatNum: number; // Required: Patient number
+    AppointmentTypeNum?: number; // Optional: Appointment type number
+    procNums?: number[]; // Optional: Array of procedure numbers
+    Pattern?: string; // Optional: Time pattern
+    Confirmed?: number; // Optional: Confirmation status
+    Note?: string; // Optional: Notes for the appointment
+    ProvNum?: number; // Optional: Provider number
+    ProvHyg?: number; // Optional: Hygienist provider number
+    ClinicNum?: number; // Optional: Clinic number
+    IsHygiene?: 'true' | 'false'; // Optional: Indicates a hygiene appointment
+    IsNewPatient?: 'true' | 'false'; // Optional: Indicates a new patient appointment
+    Priority?: Priority; // Optional: Appointment priority
+    PatternSecondary?: string; // Optional: Secondary time pattern
+  }
+  
+  /**
+   * Parameters for scheduling a planned appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface SchedulePlannedAppointmentParams {
+    AptNum: number; // Required: Appointment number with Planned status
+    AptDateTime: string; // Required: Appointment start time in "yyyy-MM-dd HH:mm:ss" format
+    ProvNum: number; // Required: Provider number
+    Op: number; // Required: Operatory number
+    Confirmed?: number; // Optional: Confirmation status
+    Note?: string; // Optional: Notes for the appointment
+  }
+  
+  /**
+   * Parameters for scheduling a WebSched appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface ScheduleWebSchedAppointmentParams {
+    PatNum: number; // Required: Patient number
+    DateTimeStart: string; // Required: Start time of the appointment
+    DateTimeEnd: string; // Required: End time of the appointment
+    ProvNum: number; // Required: Provider number
+    OpNum: number; // Required: Operatory number
+    defNumApptType: number; // Required: Appointment type definition number
+  }
+  
+  /**
+   * Parameters for updating an appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface UpdateAppointmentParams {
+    AptNum: number; //Required in the URL.
+    AptStatus?: AptStatus; // Optional: Updated appointment status
+    Pattern?: string; // Optional: Updated time pattern
+    Confirmed?: number; // Optional: Updated confirmation status
+    Op?: number; // Optional: Updated operatory number
+    Note?: string; // Optional: Updated notes
+    ProvNum?: number; // Optional: Updated provider number
+    ProvHyg?: number; // Optional: Updated hygienist provider number
+    AptDateTime?: string; // Optional: Updated start time
+    ClinicNum?: number; // Optional: Updated clinic number
+    IsHygiene?: 'true' | 'false'; // Optional: Indicates a hygiene appointment
+    IsNewPatient?: 'true' | 'false'; // Optional: Indicates a new patient appointment
+    Priority?: Priority; // Optional: Updated priority
+    AppointmentTypeNum?: number; // Optional: Updated appointment type number
+    UnschedStatus?: number; // Optional: Unscheduled status
+    colorOverride?: string; // Optional: Updated custom color in "R,G,B" format
+    PatternSecondary?: string; // Optional: Updated secondary time pattern
+  }
+  
+  /**
+   * Breaks an appointment. Only appointments with an AptStatus of Scheduled can be broken. Creates a CommLog entry if the office has that preference turned on. To reschedule a broken appointment, use Appointments PUT (update) to update the Status, AptDateTime, and Op of the broken appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface BreakAppointmentParams {
+    AptNum: number; //Required in the URL.
+    sendToUnscheduledList: 'true' | 'false'; // Required: Indicates if the appointment should go to the unscheduled list
+    breakType?: 'Missed' | 'Cancelled'; // Optional: Reason for breaking the appointment
+  }
+  
+  /**
+   * Parameters for confirming an appointment.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export interface ConfirmAppointmentParams {
+    AptNum: number; //Required in the URL.
+    confirmVal?: 'None' | 'Sent' | 'Confirmed' | 'Not Accepted' | 'Failed'; // Optional: Confirmation value
+    defNum?: number; // Optional: Confirmation definition number
+  }
+  
+  /**
+   * Appointment status options.
+   * @see https://www.opendental.com/site/apiappointments.html
+   */
+  export type AptStatus =
+    | "Scheduled"
+    | "Complete"
+    | "UnschedList"
+    | "ASAP"
+    | "Broken"
+    | "Planned"
+    | "PtNote"
+    | "PtNoteCompleted";
+  
+  /**
+   * Appointment priority options.
+   */
+  export type Priority = "Normal" | "ASAP";
+  

package/src/types/commlogType.ts

@@ -0,0 +1,28 @@
+/**
+ * Represents a communication log in the Open Dental system.
+ * @see https://www.opendental.com/site/apicommlogs.html
+ */
+export interface CommLog {
+    CommLogNum?: number; // Unique identifier for the communication log
+    PatNum?: number; // Unique identifier for the patient
+    CommDateTime?: string; // Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format
+    Mode_?: "None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"; // Mode of communication
+    Note?: string; // Detailed note about the communication
+    CommType?: number; // Type of communication: definition.DefNum where definition.Category=25
+    commType?: string; // Optional: Human-readable description of the communication type
+    SentOrReceived?: "Sent" | "Received" | "Neither"; // Optional: Direction of communication
+  }
+  
+/**
+ * Parameters for creating a new communication log.
+ * @see https://www.opendental.com/site/apicommlogs.html
+ */
+export interface CreateCommLogParams {
+    PatNum: number; // Required: Unique identifier for the patient
+    CommDateTime: string; // Required: Date and time of the communication in "yyyy-MM-dd HH:mm:ss" format
+    Mode_: "None" | "Email" | "Mail" | "Phone" | "In Person" | "Text" | "Email and Text" | "Phone and Text"; // Required: Mode of communication
+    Note: string; // Required: Detailed note about the communication
+    CommType?: number; // Optional: Type of communication: definition.DefNum where definition.Category=25
+    commType?: string; // Optional: Human-readable description of the communication type
+    SentOrReceived?: "Sent" | "Received" | "Neither"; // Optional: Direction of communication
+}

package/src/types/patientTypes.ts

@@ -0,0 +1,209 @@
+/**
+ * Parameters for fetching multiple patients.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface GetPatientsParams {
+    LName?: string; //Supports partial string matching and is case-insensitive.
+    FName?: string; //Supports partial string matching and is case-insensitive.
+    Phone?: string; // phone number
+    Address?: string; // Primary address
+    hideInactive?: 'true' | 'false'; 
+    City?: string; // City
+    State?: string; // State
+    SSN?: string; // Social Security Number
+    ChartNumber?: string; // Chart number
+    guarOnly?: 'true' | 'false'; 
+    showArchived?: 'true' | 'false'; 
+    Birthdate?: string; //In "yyyy-mm-dd" format.
+    SiteNum?: number; 
+    SubscriberId?: string; 
+    Email?: string; // Email address
+    Country?: string; 
+    ClinicNum?: number; //comma separated list
+    clinicAbbr?: string; // Clinic abbreviation
+    invoiceNumber?: string; 
+    Offset?: number; // Pagination offset
+  }
+
+/**
+ * Parameters for fetching comprehensive patient data.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface GetPatientsSimpleParams extends GetPatientsParams {
+    LName?: string; //Supports partial string matching and is case-insensitive.
+    FName?: string; //Supports partial string matching and is case-insensitive.
+    Birthdate?: string; //In "yyyy-mm-dd" format.
+    ClinicNum?: number; //A single ClinicNum. Leave blank if not using clinics or want results for all clinics.
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
+    DateTStamp?: string; //In "yyyy-mm-dd HH:mm:ss" format.
+    PriProv?: number; // Primary provider ID
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
+    Guarantor?: number; // Guarantor's PatNum
+    SuperFamily?: number; // Super family number
+    Offset?: number; // Pagination offset
+  }
+
+/**
+ * Parameters for creating a new patient.
+ * Required fields depend on Open Dental's configuration.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface CreatePatientParams {
+    LName: string; // Last name
+    FName: string; // First name
+    MiddleI?: string; // Middle initial
+    Preferred?: string; // Preferred name
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status, Default is Patient.
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
+    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
+    SSN?: string; // In the USA, 9 digits, no dashes. Any punctuation or format for other countries.
+    Address?: string; // Primary address
+    Address2?: string; // Secondary address
+    City?: string; // City
+    State?: string; // State
+    Zip?: string; // Postal code. Must be in format 12345, 12345-1234, or 123456789 (US) or A0A 0A0 (Canada, added in version 23.2.5).
+    HmPhone?: string; // Home phone number including any punctuation.
+    WkPhone?: string; // Work phone number including any punctuation.
+    WirelessPhone?: string; // Mobile phone number including any punctuation.
+    Guarantor?: number; // Head of household's PatNum. Only this or SuperFamily in a single request. Default is patient's PatNum.
+    Email?: string; // Email address
+    PriProv?: number; // Primary provider number
+    SecProv?: number; // Secondary provider number
+    BillingType?: string; // Billing type description
+    FamFinUrgNote?: string; // Family financial urgent note
+    ChartNumber?: string; // Chart number
+    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
+    ClinicNum?: number; // Clinic number
+    Ward?: string; // Ward, hospital feature must be enabled
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
+    Language?: string; // Language code (ISO 639-2 format)
+    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format, hospital feature must be enabled
+    SuperFamily?: number; // Head of SuperFamily's PatNum. Default is 0. Only this or Guarantor in a single request. Creates a new SuperFamily if one does not exist. Does not honor any Super Family preferences.
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
+  }
+
+  export interface UpdatePatientParams {
+    LName?: string; // Last name
+    FName?: string; // First name
+    MiddleI?: string; // Middle initial
+    Preferred?: string; // Preferred name
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status, Default is Patient.
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
+    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
+    SSN?: string; // In the USA, 9 digits, no dashes. Any punctuation or format for other countries.
+    Address?: string; // Primary address
+    Address2?: string; // Secondary address
+    City?: string; // City
+    State?: string; // State
+    Zip?: string; // Postal code. Must be in format 12345, 12345-1234, or 123456789 (US) or A0A 0A0 (Canada, added in version 23.2.5).
+    HmPhone?: string; // Home phone number including any punctuation.
+    WkPhone?: string; // Work phone number including any punctuation.
+    WirelessPhone?: string; // Mobile phone number including any punctuation.
+    Guarantor?: number; // Head of household's PatNum. Only this or SuperFamily in a single request. Default is patient's PatNum.
+    Email?: string; // Email address
+    PriProv?: number; // Primary provider number
+    SecProv?: number; // Secondary provider number
+    BillingType?: string; // Billing type description
+    FamFinUrgNote?: string; // Family financial urgent note
+    ChartNumber?: string; // Chart number
+    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
+    ClinicNum?: number; // Clinic number
+    Ward?: string; // Ward, hospital feature must be enabled
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
+    Language?: string; // Language code (ISO 639-2 format)
+    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format, hospital feature must be enabled
+    SuperFamily?: number; // Head of SuperFamily's PatNum. Default is 0. Only this or Guarantor in a single request. Creates a new SuperFamily if one does not exist. Does not honor any Super Family preferences.
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
+  }
+
+/**
+ * Represents a patient in the Open Dental system.
+ * @see https://www.opendental.com/site/apipatients.html
+ */
+export interface Patient {
+    serverDateTime?: string; // Server datetime of API return
+    PatNum?: number; // Unique patient identifier
+    LName?: string; // Last name
+    FName?: string; // First name
+    MiddleI?: string; // Middle initial
+    Preferred?: string; // Preferred name
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
+    Position?: 'Single' | 'Married' | 'Child' | 'Widowed' | 'Divorced'; // Marital status
+    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
+    SSN?: string; // Social Security Number
+    Address?: string; // Primary address
+    Address2?: string; // Secondary address
+    City?: string; // City
+    State?: string; // State
+    Zip?: string; // ZIP code
+    HmPhone?: string; // Home phone number
+    WkPhone?: string; // Work phone number
+    WirelessPhone?: string; // Mobile phone number
+    Guarantor?: number; // Guarantor's PatNum
+    Email?: string; // Email address
+    EstBalance?: number; // Estimated balance
+    PriProv?: number; // Primary provider number
+    priProvAbbr?: string; // Primary provider abbreviation
+    SecProv?: number; // Secondary provider number
+    secProvAbbr?: string; // Secondary provider abbreviation
+    BillingType?: string; // Billing type description
+    ImageFolder?: string; // Image folder name
+    FamFinUrgNote?: string; // Family financial urgent note
+    ChartNumber?: string; // Chart number
+    MedicaidID?: string; // Medicaid ID
+    BalTotal?: number; // Total balance
+    DateFirstVisit?: string; // Date of first visit in 'yyyy-MM-dd' format
+    ClinicNum?: number; // Clinic number
+    clinicAbbr?: string; // Clinic abbreviation
+    Ward?: string; // Ward
+    PreferConfirmMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall'; // Preferred confirmation method
+    PreferContactMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred contact method
+    PreferRecallMethod?: 'None' | 'Email' | 'TextMessage' | 'PhoneCall' | 'Mail'; // Preferred recall method
+    Language?: string; // Language code (ISO 639-2 format)
+    AdmitDate?: string; // Admission date in 'yyyy-MM-dd' format
+    siteDesc?: string; // Site description
+    DateTStamp?: string; // Timestamp of the last update in 'yyyy-MM-dd HH:mm:ss' format
+    SuperFamily?: number; // Super family number
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
+    SecDateEntry?: string; // Secondary date entry in 'yyyy-MM-dd' format
+  }  
+
+  /**
+   * Simplified representation of a patient in the Open Dental system.
+   * @see https://www.opendental.com/site/apipatients.html
+   */
+  export interface PatientSummary {
+    PatNum?: number; // Unique patient identifier
+    LName?: string; // Last name
+    FName?: string; // First name
+    MiddleI?: string; // Middle initial
+    Preferred?: string; // Preferred name
+    PatStatus?: 'Patient' | 'NonPatient' | 'Inactive' | 'Archived' | 'Deceased' | 'Prospective'; // Patient status
+    Gender?: 'Male' | 'Female' | 'Unknown' | 'Other'; // Gender
+    Birthdate?: string; // Date of birth in 'yyyy-MM-dd' format
+    SSN?: string; // Social Security Number
+    Address?: string; // Primary address
+    Address2?: string; // Secondary address
+    City?: string; // City
+    State?: string; // State
+    Zip?: string; // ZIP code
+    HmPhone?: string; // Home phone number
+    WkPhone?: string; // Work phone number
+    WirelessPhone?: string; // Mobile phone number
+    Email?: string; // Email address
+    priProvAbbr?: string; // Primary provider abbreviation
+    secProvAbbr?: string; // Secondary provider abbreviation
+    BillingType?: string; // Billing type description
+    ChartNumber?: string; // Chart number
+    ClinicNum?: number; // Clinic number
+    clinicAbbr?: string; // Clinic abbreviation
+    TxtMsgOk?: 'Unknown' | 'Yes' | 'No'; // Text message consent
+  }

package/src/types/procedurelogTypes.ts

@@ -0,0 +1,119 @@
+//NEED TO COMPLETE FOR PUT/POST/DELETE GROUP NOTES AND INSURANCE HISTORY
+
+/**
+ * Represents a procedure log entry in the Open Dental system.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface ProcedureLog {
+    ProcNum?: number; // Unique procedure identifier
+    PatNum?: number; // Unique patient identifier
+    AptNum?: number; // Associated appointment number
+    ProcDate?: string; // Procedure date in "yyyy-MM-dd" format
+    ProcFee?: number; // Fee for the procedure
+    Surf?: Surf; // Tooth surface
+    ToothNum?: string; // Tooth number
+    ToothRange?: string; // Tooth range
+    Priority?: number; // Priority code
+    priority?: string; // Priority description
+    ProcStatus?: 'TP' | 'C' | 'EO' | 'R' | 'D' | 'E'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
+    ProvNum?: number; 
+    provAbbr?: string; 
+    Dx?: string; // Diagnosis code
+    dxName?: string; // Diagnosis name
+    PlannedAptNum?: number; // Planned appointment number
+    Prosthesis?: string; // Type of prosthesis
+    DateOriginalProsth?: string //Date in yyyy-MM-dd format
+    ClinicNum?: number; // Clinic number
+    CodeNum?: number; // Procedure code number
+    procCode?: string; // D code
+    descript?: string; // Procedure code description
+    ProcTime?: string; // Time taken for the procedure
+    UnitQty?: number; // Quantity of units
+    DateTStamp?: string; // Timestamp of the last update in "yyyy-MM-dd HH:mm:ss" format
+    IsDateProsthEst?: 'true' | 'false' ; // 
+    serverDateTime?: string;
+  }
+
+/**
+ * Create procedure log parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface createProcedureLogParams {
+    PatNum: number; // Unique patient identifier
+    ProcDate: string; // Procedure date in "yyyy-MM-dd" format
+    ProcStatus: 'TP' | 'C' | 'EO'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
+    procCode: string; // D code
+    AptNum?: number; // Associated appointment number
+    ProcFee?: number; // Fee for the procedure
+    Surf?: Surf; // Tooth surface
+    ToothNum?: string; // Tooth number
+    ToothRange?: string; // Tooth range
+    Priority?: number; //Optional. Definition.DefNum where definition.Category=20. Default is the first definition in that Category. If Priority is used, then priority will be set automatically.
+    priority?: string; // Priority description
+    ProvNum?: number; 
+    Dx?: string; // Optional. Definition.DefNum where definition.Category=16. Default is the first definition in that Category. If Dx is used, then dxName will be set automatically.
+    dxName?: string; // Diagnosis name
+    PlannedAptNum?: number; // Planned appointment number
+    ClinicNum?: number; // Clinic number
+  }
+
+/**
+ * Update procedure log parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface updateProcedureLogParams {
+    ProcNum: number; 
+    AptNum?: number; // Associated appointment number
+    ProcDate?: string; // Procedure date in "yyyy-MM-dd" format
+    ProcFee?: number; // Fee for the procedure
+    Priority?: number; //Optional. Definition.DefNum where definition.Category=20. Default is the first definition in that Category. If Priority is used, then priority will be set automatically.
+    ProcStatus?: 'TP' | 'C' | 'EO'; // Procedure status?: Treatment Planned (TP), Complete (C), etc.
+    ProvNum?: number; 
+    Dx?: string; // Optional. Definition.DefNum where definition.Category=16. Default is the first definition in that Category. If Dx is used, then dxName will be set automatically.
+    PlannedAptNum?: number; // Planned appointment number
+    ClinicNum?: number; // Clinic number
+    procCode?: string; // D code
+    ToothNum?: string; // Tooth number
+    Surf?: Surf; // Tooth surface
+    ToothRange?: string; // Tooth rang
+  }
+
+/**
+ * Insurance History object in Open Dental.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface InsuranceHistory {
+    insHistPrefName?: string; 
+    procDate?: string; // in "yyyy-MM-dd" format
+    ProcNum?: number; //FK to procedurelog entry
+  }
+
+/**
+ * get Insurance History parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface getInsuranceHistoryParams {
+    PatNum: number; //Required. FK to patient.PatNum.
+    InsSubNum: number; // Required. FK to inssub.InsSubNum.
+  }
+
+/**
+ * post Insurance History parameters.
+ * @see https://www.opendental.com/site/apiprocedurelogs.html
+ */
+export interface postInsuranceHistoryParams {
+    PatNum: number; //Required. FK to patient.PatNum.
+    InsSubNum: number; // Required. FK to inssub.InsSubNum.
+    insHistPrefName: "InsHistBWCodes" | "InsHistPanoCodes" | "InsHistExamCodes" | "InsHistProphyCodes" | "InsHistPerioURCodes" | "InsHistPerioULCodes" | "InsHistPerioLRCodes" | "InsHistPerioLLCodes" | "InsHistPerioMaintCodes" | "InsHistDebridementCodes"; // Required. String. The PrefName of the Insurance History category. Either "InsHistBWCodes", "InsHistPanoCodes", "InsHistExamCodes", "InsHistProphyCodes", "InsHistPerioURCodes", "InsHistPerioULCodes", "InsHistPerioLRCodes", "InsHistPerioLLCodes", "InsHistPerioMaintCodes", or "InsHistDebridementCodes". Case sensitive.
+    ProcDate: string; //String in "yyyy-MM-dd" format. The date the procedure was completed.
+  }
+
+/**
+ * Surf: Required for the treatment areas of some procCodes. Can be tooth Surfaces (B/F,V,M,O/I,D,L), mouth Quadrants (UL,UR,LR,LL), Sextants (1,2,3,4,5,6), or Arches (U or L).
+ * @see https://www.opendental.com/site/apiappointments.html
+ */
+  export type Surf = 
+  "B/F" | "V" | "M" | "O/I" | "D" | "L" | 
+  "UL" | "UR" | "LR" | "LL" | 
+  "1" | "2" | "3" | "4" | "5" | "6" | 
+  "U" | "L";