@rinse-dental/open-dental 1.1.0 → 1.3.0

package/src/api/referrals.ts

@@ -0,0 +1,222 @@
+import HttpClient from "../utils/httpClient";
+import {
+  Referral,
+  GetReferralsParams,
+  CreateReferralParams,
+  UpdateReferralParams,
+} from "../types/referralTypes";
+
+export default class Referrals {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Fetch a single referral by its ID.
+   * @param {number} ReferralNum - The unique identifier for the referal.
+   * @returns {Promise<Referral>} - The referral object.
+   * @throws {Error} - If `ReferralNum` is not provided.
+   */
+  public async getReferral(ReferralNum: number): Promise<Referral> {
+    if (!ReferralNum || typeof ReferralNum !== "number") {
+      throw new Error("Invalid data: ReferralNum is required.");
+    }
+    return this.httpClient.get<Referral>(`/referrals/${ReferralNum}`);
+  }
+
+  /**
+    * Fetch multiple referrals with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {"true" | "false"} [data.IsHidden] - Optional. 
+    * @param {"true" | "false"} [data.NotPerson] - Optional. 
+    * @param {"true" | "false"} [data.IsDoctor] - Optional. 
+    * @param {"true" | "false"} [data.IsPreferred] - Optional. 
+    * @param {"true" | "false"} [data.isPatient] - Optional. 
+    * @param {string} [data.BusinessName] - Optional. Filter referrals by business name. Supports partial string matching.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<Referral[]>} - A list of referrals.
+    */
+  public async getReferrals({
+    IsHidden,
+    NotPerson,
+    IsDoctor,
+    IsPreferred,
+    isPatient,
+    BusinessName,
+    Offset,
+  }: GetReferralsParams = {}): Promise<Referral[]> {
+    const params = {
+      IsHidden,
+      NotPerson,
+      IsDoctor,
+      IsPreferred,
+      isPatient,
+      BusinessName,
+      Offset,
+    };
+  
+    return this.httpClient.get<Referral[]>("/referrals", params);
+  }
+
+  /**
+   * Create a new referral.
+   * @param {Object} data - The details of referral to create.
+   * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+   * @param {number} [data.PatNum] - Optional. Only set this if the referral source is a patient. The provided LName must match the patient for whom the PatNum is given. This automatically populates the rest of the referral based on the given patient. If this is set, IsDoctor and NotPerson are set to "false", while isPatient will be true.
+   * @param {string} [data.FName] - Optional. The referral source's first name.
+   * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+   * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+   * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+   * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+   * @param {string} [data.specialty] - Optional. Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
+   * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+   * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+   * @param {string} [data.Address] - Optional. The referral source's mailing address.
+   * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+   * @param {string} [data.City] - Optional. The referral source's city.
+   * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+   * @param {string} [data.Note] - Optional.
+   * @param {string} [data.Phone2] - Optional. Additional phone.
+   * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+   * @param {string} [data.Title] - Optional. The referral source's title.
+   * @param {string} [data.EMail] - Optional. The email address for the referral.
+   * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+   * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+   * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+   * @returns {Promise<Referral>} - The created referral.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createReferral({
+    LName,
+    PatNum,
+    FName,
+    MName,
+    SSN,
+    UsingTIN,
+    Specialty,
+    specialty,
+    ST,
+    Telephone,
+    Address,
+    Address2,
+    City,
+    Zip,
+    Note,
+    Phone2,
+    NotPerson,
+    Title,
+    EMail,
+    IsDoctor,
+    BusinessName,
+    DisplayNote,
+  } : CreateReferralParams): Promise<Referral> {
+    if (!LName) {
+      throw new Error("Invalid data: LName is required.");
+    }
+
+    return this.httpClient.post<Referral>("/referrals", {
+      LName,
+      PatNum,
+      FName,
+      MName,
+      SSN,
+      UsingTIN,
+      Specialty,
+      specialty,
+      ST,
+      Telephone,
+      Address,
+      Address2,
+      City,
+      Zip,
+      Note,
+      Phone2,
+      NotPerson,
+      Title,
+      EMail,
+      IsDoctor,
+      BusinessName,
+      DisplayNote,
+    });
+  }
+
+  /**
+   * Update a referral.
+   * @param {Object} data - The details of referral to update.
+   * @param {number} data.ReferralNum - Required. PK of the referral to update.
+   * @param {string} data.LName - Required. The last name of a referral source or referral source description.
+   * @param {string} [data.FName] - Optional. The referral source's first name.
+   * @param {string} [data.MName] - Optional. The referral source's middle name or initial.
+   * @param {string} [data.SSN] - Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+   * @param {"true" | "false"} [data.UsingTIN] - Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+   * @param {number} [data.Specialty] - Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+   * @param {string} [data.ST] - Optional. The referral source's state. Two characters maximum.
+   * @param {string} [data.Telephone] - Optional. The referral source's phone number. Must be ten digits.
+   * @param {string} [data.Address] - Optional. The referral source's mailing address.
+   * @param {string} [data.Address2] - Optional. Additional info regarding the referral source's mailing address.
+   * @param {string} [data.City] - Optional. The referral source's city.
+   * @param {string} [data.Zip] - Optional. The referral source's ZIP code.
+   * @param {string} [data.Note] - Optional.
+   * @param {string} [data.Phone2] - Optional. Additional phone.
+   * @param {"true" | "false"} [data.NotPerson] - Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+   * @param {string} [data.Title] - Optional. The referral source's title.
+   * @param {string} [data.EMail] - Optional. The email address for the referral.
+   * @param {"true" | "false"} [data.IsDoctor] - Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+   * @param {string} [data.BusinessName] - Optional. Name of the business that the referral works for.
+   * @param {string} [data.DisplayNote] - Optional. Shows in the Family Module's Patient Info grid.
+   * @returns {Promise<Referral>} - The updated referral.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateReferral({
+    ReferralNum,
+    LName,
+    FName,
+    MName,
+    SSN,
+    UsingTIN,
+    Specialty,
+    ST,
+    Telephone,
+    Address,
+    Address2,
+    City,
+    Zip,
+    Note,
+    Phone2,
+    NotPerson,
+    Title,
+    EMail,
+    IsDoctor,
+    BusinessName,
+    DisplayNote,
+  } : UpdateReferralParams): Promise<Referral> {
+    if (!ReferralNum || typeof ReferralNum !== "number") {
+      throw new Error("Invalid data: ReferralNum is required.");
+    }
+
+    return this.httpClient.put<Referral>(`/referrals/${ReferralNum}`, {
+      LName,
+      FName,
+      MName,
+      SSN,
+      UsingTIN,
+      Specialty,
+      ST,
+      Telephone,
+      Address,
+      Address2,
+      City,
+      Zip,
+      Note,
+      Phone2,
+      NotPerson,
+      Title,
+      EMail,
+      IsDoctor,
+      BusinessName,
+      DisplayNote,
+    });
+  }
+}

package/src/openDental.ts

@@ -17,6 +17,10 @@ import FamilyModules from "./api/familyModules";
 import InsSubs from "./api/insSubs";
 import PatPlans from "./api/patPlans";
 import LabCases from "./api/labCases";
+import Referrals from "./api/referrals";
+import RefAttaches from "./api/refAttaches";
+import InsPlans from "./api/insPlans";
+import Benefits from "./api/benefits";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -213,7 +217,47 @@ class OpenDental {
     if (!this.httpClient) {
       throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
     }
-    return new PatPlans(this.httpClient);
+    return new LabCases(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the Referrals API.
+   */
+  public static Referrals() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Referrals(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static RefAttaches() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new RefAttaches(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static InsPlans() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new InsPlans(this.httpClient);
+  }
+
+  /**
+   * Create a new instance of the LabCases API.
+   */
+  public static Benefits() {
+    if (!this.httpClient) {
+      throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+    }
+    return new Benefits(this.httpClient);
   }
 }
 

package/src/types/benefitTypes.ts

@@ -0,0 +1,70 @@
+/**
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface Benefit {
+  BenefitNum?: number; // Primary Key
+  PlanNum?: number; // FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // FK to PatPlan.PlanNum.
+  CovCatNum?: number; // FK to covcat.CovCatNum.
+  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  Percent?: number; // Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+  procCode?: string; // FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CoverageLevel?: "None" | "Individual" | "Family"; // Either "None", "Individual", or "Family".
+  SecDateTEntry?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+  CodeGroupNum?: number; // (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+}
+
+/**
+ * Gets a list of PatPlans that meet a set of search criteria.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface GetBenefitsParams {
+  PlanNum?: number; // FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // FK to PatPlan.PatPlanNum.
+  Offset?: number; // Pagination offset for results
+}
+
+/**
+ * Parameters for creating a new insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface CreateBenefitParams {
+  PlanNum?: number; // This or PatPlanNum is required. FK to InsPlan.PlanNum.
+  PatPlanNum?: number; // This or PlanNum is required. FK to PatPlan.PlanNum.
+  BenefitType: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Required. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  CoverageLevel: "None" | "Individual" | "Family"; // Required. Either "None", "Individual", or "Family".
+  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
+  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified. Default 0.
+  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CodeGroupNum?: number; // Optional. (Added in version 23.2.62) FK to codegroup.CodeGroupNum. The group of procedure codes that apply to this Frequency Limitation benefit.
+}
+
+/**
+ * Parameters to update an insplan.
+ * @see https://www.opendental.com/site/apibenefits.html
+ */
+export interface UpdateBenefitParams {
+  BenefitNum: number; // Required in URL. Primary Key. 
+  CovCatNum?: number; // Optional. FK to covcat.CovCatNum.
+  BenefitType?: "ActiveCoverage" | "CoInsurance" | "Deductible" | "CoPayment" | "Exclusions" | "Limitations" | "WaitingPeriod"; // Optional. Either "ActiveCoverage", "CoInsurance", "Deductible", "CoPayment", "Exclusions", "Limitations", or "WaitingPeriod".
+  Percent?: number; // Optional. Only allowed if BenefitType is "CoInsurance". Must be a value between 0 and 100. Default -1 (Indicating empty).
+  MonetaryAmt?: number; // Optional. Only used if BenefitType is "CoPayment", "Limitations", or "Deductible". Default -1.0 (Indicating empty).
+  TimePeriod?: "None" | "ServiceYear" | "CalendarYear" | "Lifetime" | "Years" | "NumberInLast12Months"; // Optional. Either "None", "ServiceYear", "CalendarYear", "Lifetime", "Years", or "NumberInLast12Months". Default "CalendarYear".
+  QuantityQualifier?: "None" | "NumberOfServices" | "AgeLimit" | "Visits" | "Years" | "Months"; // Optional. Either "None", "NumberOfServices", "AgeLimit", "Visits", "Years", or "Months". Default "None". Must be "Months" or "Years" if BenefitType is "WaitingPeriod".
+  Quantity?: number; // Optional. Must be a value between 0 and 100. Default 0. Must be a value greater than 0 if QuantityQualifier is "AgeLimit".
+  CodeNum?: number; // Optional. FK to procedurecode.CodeNum. Only allowed if CovCatNum is 0. Will be used over procCode if both are specified.
+  procCode?: string; // Optional. FK to procedurecode.ProcCode. Only allowed if CovCatNum is 0. Default empty string.
+  CoverageLevel?: "None" | "Individual" | "Family"; // Optional. Either "None", "Individual", or "Family".
+}
+  

package/src/types/insPlanTypes.ts

@@ -0,0 +1,72 @@
+/**
+ * @see https://www.opendental.com/site/apiinsplans.html
+ */
+export interface InsPlan {
+    PlanNum?: number; // PK
+    GroupName?: string; // Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // 
+    PlanNote?: string; // Note for this plan. Same for all subscribers.
+    FeeSched?: number; // FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c".
+    ClaimFormNum?: number; // A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
+    CopayFeeSched?: number; // FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // FK to employer.EmployerNum. Default 0.
+    CarrierNum?: number; // FK to carrier.CarrierNum.
+    CodeSubstNone?: "true" | "false"; // Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Either "true" or "false". Default "false".
+    MonthRenew?: number; // The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    SecUserNumEntry?: number; //
+    SecDateEntry?: string; // String in "yyyy-MM-dd" format
+    SecDateTEdit?: string; // String in "yyyy-MM-dd HH:mm:ss" format
+    IsBlueBookEnabled?: "true" | "false"; // Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+
+  /**
+   * Gets a list of PatPlans that meet a set of search criteria.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface GetInsPlansParams {
+    PlanType?: "percentage" | "p" | "f" | "c"; // Must be one of the following: "percentage" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c" (Capitation). Percentage PlanTypes are stored as blank in the database.
+    CarrierNum?: number; // FK to carrier.CarrierNum.
+    Offset?: number; // Pagination offset for results
+  }
+
+  /**
+   * Parameters for creating a new insplan.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface CreateInsPlanParams {
+    CarrierNum: number; // Required. FK to carrier.CarrierNum.
+    GroupName?: string; // Optional. Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // Optional. The carrier assigned identifier, unique for each plan.
+    PlanNote?: string; // Optional. Note for this plan. Same for all subscribers.
+    FeeSched?: number; // Optional. FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+    CopayFeeSched?: number; // Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // Optional. FK to employer.EmployerNum. Default 0.
+    CodeSubstNone?: "true" | "false"; // Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+    MonthRenew?: number; // Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    IsBlueBookEnabled?: "true" | "false"; // Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+  
+  /**
+   * Parameters to update an insplan.
+   * @see https://www.opendental.com/site/apiinsplans.html
+   */
+  export interface UpdateInsPlanParams {
+    PlanNum: number; // Required. PK
+    GroupName?: string; // Optional. Typically the same as the employer. Used to identify difference in plans.
+    GroupNum?: string; // Optional. The carrier assigned identifier, unique for each plan.
+    PlanNote?: string; // Optional. Note for this plan. Same for all subscribers.
+    FeeSched?: number; // Optional. FK to feesched.FeeSchedNum. Default 0.
+    PlanType?: "" | "p" | "f" | "c"; // Optional. Either "" (Percentage), "p" (PPO Percentage), "f" (Flat Copay), or "c". Default is "" (Percentage).
+    CopayFeeSched?: number; // Optional. FK to feesched.FeeSchedNum when FeeSchedType is CoPay. Typically only used for capitation or copay plans. Default 0.
+    EmployerNum?: number; // Optional. FK to employer.EmployerNum. Default 0.
+    CarrierNum: number; // Optional. FK to carrier.CarrierNum.
+    CodeSubstNone?: "true" | "false"; // Optional. Either "true" or "false". Set "true" if this Insurance Plan should ignore any Substitution Codes. Default "false".
+    IsHidden?: "true" | "false"; // Optional. Either "true" or "false". Default "false".
+    MonthRenew?: number; // Optional. The month, 1-12, when the insurance plan renews. It will renew on the first of the month. Default 0 to indicate calendar year.
+    IsBlueBookEnabled?: "true" | "false"; // Optional. Determines if the plan utilizes BlueBook or not. Cannot be set to true if PlanType is set to anything other than "" (Percentage). Defaults to true if AllowedFeeSchedsAutomate is set to BlueBook, otherwise defaults to false.
+  }
+  

package/src/types/refAttachTypes.ts

@@ -0,0 +1,63 @@
+/**
+ * Represents an RefAttaches in the Open Dental system. Attaches a patient to a referral source.
+ * @see https://www.opendental.com/site/apirefattaches.html
+ */
+export interface RefAttach {
+    RefAttachNum?: number; //PK
+    ReferralNum?: number; //This or referralName is required. FK to referral.ReferralNum.
+    referralName?: string; //This or ReferralNum is required.
+    PatNum?: number; //FK to patient.PatNum.
+    ItemOrder?: number; //
+    RefDate?: string; //String in "yyyy-MM-dd" format.
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom"; //Either "RefTo", "RefFrom", or "RefCustom". Default "RefFrom".
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"; //Typically only used with outgoing referrals. Either "None", "Declined", "Scheduled", "Consulted", "InTreatment", or "Complete". Default "None".
+    Note?: string; //Referral note specific to this patient.
+    IsTransitionOfCare?: "true" | "false"; //Either "true" or "false". Used to track EHR events. Default "false".
+    ProcNum?: number; //FK to procedurelog.ProcNum. Default 0.
+    DateProcComplete?: string; //String in "yyyy-MM-dd HH:mm:ss" format
+    ProvNum?: number; //FK to provider.ProvNum. Can only be specified when ReferralType is "RefTo". Default 0.
+    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format
+  }
+
+  
+  export interface GetRefAttachesParams {
+    PatNum?: number; // Optional. FK to patient.
+    Offset?: number; // Pagination offset for results.
+  }
+
+  /**
+   * Attaches a patient to a referral source. The referral source must be specified by either ReferralNum or referralName. 
+   * Before calling this method, use Referrals GET to find the ReferralNum of an existing referral source. 
+   * Alternatively, specify a referralName to search the LName of existing referrals for an exact match. 
+   * If a match is not found, a new referral with that name is created and used.
+   */
+  export interface CreateRefAttachParams {
+    PatNum: number; //Required. FK to patient.PatNum.
+    ReferralNum?: number; //This or referralName is required. FK to referral.ReferralNum.
+    referralName?: string; //This or ReferralNum is required.
+    RefDate?: string; //Optional. String in "yyyy-MM-dd" format. The date the referral source is attached to the patient. Default to today's date.
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom"; //Optional. Either "RefTo", "RefFrom", or "RefCustom". Default "RefFrom".
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"; //Optional. Typically only used with outgoing referrals. Either "None", "Declined", "Scheduled", "Consulted", "InTreatment", or "Complete". Default "None".
+    Note?: string; //Optional. Referral note specific to this patient.
+    IsTransitionOfCare?: "true" | "false"; //Optional. Either "true" or "false". Used to track EHR events. Default "false".
+    ProcNum?: number; //Optional. FK to procedurelog.ProcNum. Default 0.
+    DateProcComplete?: string; //Optional. String in "yyyy-MM-dd HH:mm:ss" format
+    ProvNum?: number; //Optional. FK to provider.ProvNum. Can only be specified when ReferralType is "RefTo". Default 0.
+  }
+  
+  /**
+   * Updates an existing refattach.
+   */
+  export interface UpdateRefAttachParams {
+    RefAttachNum: number; //PK
+    ReferralNum?: number; //This or referralName is required. FK to referral.ReferralNum.
+    RefDate?: string; //Optional. String in "yyyy-MM-dd" format. The date the referral source is attached to the patient. Default to today's date.
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom"; //Optional. Either "RefTo", "RefFrom", or "RefCustom". Default "RefFrom".
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"; //Optional. Typically only used with outgoing referrals. Either "None", "Declined", "Scheduled", "Consulted", "InTreatment", or "Complete". Default "None".
+    Note?: string; //Optional. Referral note specific to this patient.
+    IsTransitionOfCare?: "true" | "false"; //Optional. Either "true" or "false". Used to track EHR events. Default "false".
+    ProcNum?: number; //Optional. FK to procedurelog.ProcNum. Default 0.
+    DateProcComplete?: string; //Optional. String in "yyyy-MM-dd HH:mm:ss" format
+    ProvNum?: number; //Optional. FK to provider.ProvNum. Can only be specified when ReferralType is "RefTo". Default 0.
+  }
+  

package/src/types/referralTypes.ts

@@ -0,0 +1,102 @@
+/**
+ * Represents an Referral in the Open Dental system. These can be either a provider, patient, or non-person. The description of non-patient sources is stored in the LName field.
+ * @see https://www.opendental.com/site/apireferrals.html
+ */
+export interface Referral {
+    ReferralNum?: number; //PK
+    LName?: string; //
+    FName?: string; //
+    MName?: string; //
+    SSN?: string; //
+    UsingTIN?: "true" | "false"; //Either "true" or "false". 
+    Specialty?: number; //definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+    specialty?: string; //Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
+    ST?: string; // 2 char max
+    Telephone?: string; // must be 10 digits
+    Address?: string; //
+    Address2?: string; //
+    City?: number; //
+    Zip?: string; //
+    Note?: string; //
+    Phone2?: string; //
+    IsHidden?: "true" | "false"; //Either "true" or "false". 
+    NotPerson?: string; //
+    Title?: string; //
+    EMail?: string; //
+    PatNum?: string; //
+    IsDoctor?: "true" | "false"; //Either "true" or "false". 
+    DateTStamp?: string; //String in "yyyy-MM-dd HH:mm:ss" format
+    IsPreferred?: "true" | "false"; //Either "true" or "false". 
+    BusinessName?: string; //
+    DisplayNote?: string; //
+    isPatient?: "true" | "false"; //Either "true" or "false". 
+  }
+
+  
+  export interface GetReferralsParams {
+    IsHidden?: "true" | "false"; //Optional. Filter hidden responses. Either "true" or "false"
+    NotPerson?: "true" | "false"; //Optional. Filter referrals that are marked NotPerson. Either "true" or "false".
+    IsDoctor?: "true" | "false"; //Optional. Filter referrals that are marked IsDoctor. Either "true" or "false".
+    IsPreferred?: "true" | "false"; //Optional. Filter referrals that are marked IsPreferred. Either "true" or "false".
+    isPatient?: "true" | "false"; //Optional. Filter referrals that are marked isPatient. Either "true" or "false".
+    BusinessName?: string; //Optional. Filter referrals by business name. Supports partial string matching.
+    Offset?: number; // Pagination offset for results.
+  }
+
+  /**
+   * Creates a new Referral. Referrals can be for patients (provide PatNum), providers (provide specialty) or non-persons (provide neither PatNum or specialty). 
+   * In the last case, isPatient and IsDoctor will be set false automatically while NotPerson will be set to true. 
+   * If you wish to create an associated RefAttach please see RefAttaches POST.
+   */
+  export interface CreateReferralParams {
+    LName?: string; //Required. The last name of a referral source or referral source description.
+    PatNum?: string; //Optional. Only set this if the referral source is a patient. The provided LName must match the patient for whom the PatNum is given. This automatically populates the rest of the referral based on the given patient. If this is set, IsDoctor and NotPerson are set to "false", while isPatient will be true.
+    FName?: string; //Optional. The referral source's first name.
+    MName?: string; //Optional. The referral source's middle name or initial.
+    SSN?: string; //Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+    UsingTIN?: "true" | "false"; //Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+    Specialty?: number; //Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+    specialty?: string; //Optional. Only set this if the Referral source is a Provider. This is a definition.ItemName where the DefCat is ProviderSpecialty(35). If this is set, IsDoctor will default to "true", NotPerson will default to "false", and isPatient will be false.
+    ST?: string; //Optional. The referral source's state. Two characters maximum.
+    Telephone?: string; //Optional. The referral source's phone number. Must be ten digits.
+    Address?: string; //Optional. The referral source's mailing address.
+    Address2?: string; //Optional. Additional info regarding the referral source's mailing address.
+    City?: string; //Optional. The referral source's city.
+    Zip?: string; //Optional. The referral source's ZIP code.
+    Note?: string; //Optional.
+    Phone2?: string; //Optional. Additional phone.
+    NotPerson?: string; //Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+    Title?: string; //Optional. The referral source's title.
+    EMail?: string; //Optional. The email address for the referral.
+    IsDoctor?: "true" | "false"; //Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+    BusinessName?: string; //Optional. Name of the business that the referral works for.
+    DisplayNote?: string; //Optional. Shows in the Family Module's Patient Info grid.
+  }
+  
+  /**
+   * Updates an existing Referral. All fields are optional. Referrals for a patient can only have the Note and DisplayNote fields modified.
+   */
+  export interface UpdateReferralParams {
+    ReferralNum?: number; //PK of the referral
+    LName?: string; //Required. The last name of a referral source or referral source description.
+    FName?: string; //Optional. The referral source's first name.
+    MName?: string; //Optional. The referral source's middle name or initial.
+    SSN?: string; //Optional. SSN, or TIN if UsingTIN is true. No punctuation.
+    UsingTIN?: "true" | "false"; //Optional. Either "true" or "false". Dictates whether SSN contains an SSN or TIN. Default "false".
+    Specialty?: number; //Optional. definition.DefNum where definition.Category=35 (ProviderSpecialty). If set, NotPerson will default to "false", IsDoctor will default to "true", and isPatient will be false.
+    ST?: string; //Optional. The referral source's state. Two characters maximum.
+    Telephone?: string; //Optional. The referral source's phone number. Must be ten digits.
+    Address?: string; //Optional. The referral source's mailing address.
+    Address2?: string; //Optional. Additional info regarding the referral source's mailing address.
+    City?: number; //Optional. The referral source's city.
+    Zip?: string; //Optional. The referral source's ZIP code.
+    Note?: string; //Optional.
+    Phone2?: string; //Optional. Additional phone.
+    NotPerson?: string; //Optional. Either "true" or "false". Default "false", unless neither PatNum nor Specialty were supplied.
+    Title?: string; //Optional. The referral source's title.
+    EMail?: string; //Optional. The email address for the referral.
+    IsDoctor?: "true" | "false"; //Optional. Either "true" or "false". Default "false", unless a Specialty was supplied.
+    BusinessName?: string; //Optional. Name of the business that the referral works for.
+    DisplayNote?: string; //Optional. Shows in the Family Module's Patient Info grid.
+  }
+