@rinse-dental/open-dental 1.1.0 → 1.2.0

package/dist/api/refAttaches.d.ts

@@ -0,0 +1,57 @@
+import HttpClient from "../utils/httpClient";
+import { RefAttach, GetRefAttachesParams, CreateRefAttachParams, UpdateRefAttachParams } from "../types/refAttachTypes";
+export default class RefAttaches {
+    private httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+      * Fetch multiple refattaches with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<RefAttach[]>} - A list of inssubs.
+      */
+    getRefAttaches({ PatNum, Offset, }?: GetRefAttachesParams): Promise<RefAttach[]>;
+    /**
+     * Attach a referral to a patient.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    createRefAttach({ PatNum, ReferralNum, referralName, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }: CreateRefAttachParams): Promise<RefAttach>;
+    /**
+     * Update a refattach.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    updateRefAttach({ RefAttachNum, ReferralNum, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }: UpdateRefAttachParams): Promise<RefAttach>;
+    /**
+     * Delete a refattach.
+     * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+     */
+    deleteInsSub(RefAttachNum: number): Promise<void>;
+}
+//# sourceMappingURL=refAttaches.d.ts.map

package/dist/api/refAttaches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refAttaches.d.ts","sourceRoot":"","sources":["../../src/api/refAttaches.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,SAAS,EACT,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,yBAAyB,CAAA;AAEhC,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;QAMI;IACS,cAAc,CAAC,EAC1B,MAAM,EACN,MAAM,GACP,GAAE,oBAAyB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IASnD;;;;;;;;;;;;;;;;OAgBG;IACU,eAAe,CAAC,EAC3B,MAAM,EACN,WAAW,EACX,YAAY,EACZ,OAAO,EACP,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,OAAO,EACP,gBAAgB,EAChB,OAAO,GACR,EAAG,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB9C;;;;;;;;;;;;;;;OAeG;IACU,eAAe,CAAC,EAC3B,YAAY,EACZ,WAAW,EACX,OAAO,EACP,YAAY,EACZ,WAAW,EACX,IAAI,EACJ,kBAAkB,EAClB,OAAO,EACP,gBAAgB,EAChB,OAAO,GACR,EAAG,qBAAqB,GAAG,OAAO,CAAC,SAAS,CAAC;IAkB9C;;;;;OAKG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO/D"}

package/dist/api/refAttaches.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class RefAttaches {
+    httpClient;
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+      * Fetch multiple refattaches with optional filtering and pagination.
+      * @param {Object} params - The parameters for filtering and pagination.
+      * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+      * @param {number} [params.Offset] - Pagination offset for results.
+      * @returns {Promise<RefAttach[]>} - A list of inssubs.
+      */
+    async getRefAttaches({ PatNum, Offset, } = {}) {
+        const params = {
+            PatNum,
+            Offset,
+        };
+        return this.httpClient.get("/refattaches", params);
+    }
+    /**
+     * Attach a referral to a patient.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.PatNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async createRefAttach({ PatNum, ReferralNum, referralName, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }) {
+        if (!PatNum || (!ReferralNum && !referralName)) {
+            throw new Error("Invalid data: PatNum and either ReferralNum or referralName are required.");
+        }
+        return this.httpClient.post("/refattaches", {
+            PatNum,
+            ReferralNum,
+            referralName,
+            RefDate,
+            ReferralType,
+            RefToStatus,
+            Note,
+            IsTransitionOfCare,
+            ProcNum,
+            DateProcComplete,
+            ProvNum,
+        });
+    }
+    /**
+     * Update a refattach.
+     * @param {Object} data - The details of RefAttach to create.
+     * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+     * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+     * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+     * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+     * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+     * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+     * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+     * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+     * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+     * @returns {Promise<RefAttach>} - The created refattaches.
+     * @throws {Error} - If required fields are missing or the API returns an error.
+     */
+    async updateRefAttach({ RefAttachNum, ReferralNum, RefDate, ReferralType, RefToStatus, Note, IsTransitionOfCare, ProcNum, DateProcComplete, ProvNum, }) {
+        if (!RefAttachNum) {
+            throw new Error("Invalid data: RefAttachNum is required.");
+        }
+        return this.httpClient.put(`/refattaches/${RefAttachNum}`, {
+            ReferralNum,
+            RefDate,
+            ReferralType,
+            RefToStatus,
+            Note,
+            IsTransitionOfCare,
+            ProcNum,
+            DateProcComplete,
+            ProvNum,
+        });
+    }
+    /**
+     * Delete a refattach.
+     * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+     * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+     * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+     */
+    async deleteInsSub(RefAttachNum) {
+        if (!RefAttachNum || typeof RefAttachNum !== "number") {
+            throw new Error("Invalid parameter: RefAttachNum must be a valid number.");
+        }
+        return this.httpClient.delete(`/refattaches/${RefAttachNum}`);
+    }
+}
+exports.default = RefAttaches;

package/dist/api/referrals.d.ts

@@ -0,0 +1,84 @@
+import HttpClient from "../utils/httpClient";
+import { Referral, GetReferralsParams, CreateReferralParams, UpdateReferralParams } from "../types/referralTypes";
+export default class Referrals {
+    private httpClient;
+    constructor(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.
+     */
+    getReferral(ReferralNum: number): Promise<Referral>;
+    /**
+      * 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.
+      */
+    getReferrals({ IsHidden, NotPerson, IsDoctor, IsPreferred, isPatient, BusinessName, Offset, }?: GetReferralsParams): Promise<Referral[]>;
+    /**
+     * 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.
+     */
+    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>;
+    /**
+     * 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.
+     */
+    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>;
+}
+//# sourceMappingURL=referrals.d.ts.map

package/dist/api/referrals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referrals.d.ts","sourceRoot":"","sources":["../../src/api/referrals.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;OAKG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOhE;;;;;;;;;;;QAWI;IACS,YAAY,CAAC,EACxB,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,SAAS,EACT,YAAY,EACZ,MAAM,GACP,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAchD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,cAAc,CAAC,EAC1B,KAAK,EACL,MAAM,EACN,KAAK,EACL,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,EACT,SAAS,EACT,EAAE,EACF,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IA+B5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,cAAc,CAAC,EAC1B,WAAW,EACX,KAAK,EACL,KAAK,EACL,KAAK,EACL,GAAG,EACH,QAAQ,EACR,SAAS,EACT,EAAE,EACF,SAAS,EACT,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,MAAM,EACN,SAAS,EACT,KAAK,EACL,KAAK,EACL,QAAQ,EACR,YAAY,EACZ,WAAW,GACZ,EAAG,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;CA4B7C"}

package/dist/api/referrals.js

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Referrals {
+    httpClient;
+    constructor(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.
+     */
+    async getReferral(ReferralNum) {
+        if (!ReferralNum || typeof ReferralNum !== "number") {
+            throw new Error("Invalid data: ReferralNum is required.");
+        }
+        return this.httpClient.get(`/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.
+      */
+    async getReferrals({ IsHidden, NotPerson, IsDoctor, IsPreferred, isPatient, BusinessName, Offset, } = {}) {
+        const params = {
+            IsHidden,
+            NotPerson,
+            IsDoctor,
+            IsPreferred,
+            isPatient,
+            BusinessName,
+            Offset,
+        };
+        return this.httpClient.get("/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.
+     */
+    async createReferral({ LName, PatNum, FName, MName, SSN, UsingTIN, Specialty, specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }) {
+        if (!LName) {
+            throw new Error("Invalid data: LName is required.");
+        }
+        return this.httpClient.post("/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.
+     */
+    async updateReferral({ ReferralNum, LName, FName, MName, SSN, UsingTIN, Specialty, ST, Telephone, Address, Address2, City, Zip, Note, Phone2, NotPerson, Title, EMail, IsDoctor, BusinessName, DisplayNote, }) {
+        if (!ReferralNum || typeof ReferralNum !== "number") {
+            throw new Error("Invalid data: ReferralNum is required.");
+        }
+        return this.httpClient.put(`/referrals/${ReferralNum}`, {
+            LName,
+            FName,
+            MName,
+            SSN,
+            UsingTIN,
+            Specialty,
+            ST,
+            Telephone,
+            Address,
+            Address2,
+            City,
+            Zip,
+            Note,
+            Phone2,
+            NotPerson,
+            Title,
+            EMail,
+            IsDoctor,
+            BusinessName,
+            DisplayNote,
+        });
+    }
+}
+exports.default = Referrals;

package/dist/openDental.d.ts

@@ -15,6 +15,9 @@ import DiscountPlanSubs from "./api/discountPlanSubs";
 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";
 declare class OpenDental {
     private static httpClient;
     /**
@@ -92,7 +95,15 @@ declare class OpenDental {
     /**
      * Create a new instance of the LabCases API.
      */
-    static LabCases(): PatPlans;
+    static LabCases(): LabCases;
+    /**
+     * Create a new instance of the Referrals API.
+     */
+    static Referrals(): Referrals;
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static RefAttaches(): RefAttaches;
 }
 export { OpenDental };
 //# sourceMappingURL=openDental.d.ts.map

package/dist/openDental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;CAMvB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"openDental.d.ts","sourceRoot":"","sources":["../src/openDental.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAEtC;;OAEG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAWlE;;OAEG;WACa,YAAY;IAQ5B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,YAAY;IAO1B;;SAEK;WACS,SAAS;IAOvB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,cAAc;IAO5B;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,SAAS;IAOzB;;OAEG;WACa,WAAW;IAO3B;;OAEG;WACa,QAAQ;IAOxB;;OAEG;WACW,WAAW;IAOzB;;OAEG;WACW,gBAAgB;IAO9B;;OAEG;WACW,aAAa;IAO3B;;OAEG;WACW,OAAO;IAOrB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,QAAQ;IAOtB;;OAEG;WACW,SAAS;IAOvB;;OAEG;WACW,WAAW;CAM1B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/openDental.js

@@ -22,6 +22,9 @@ const discountPlanSubs_1 = __importDefault(require("./api/discountPlanSubs"));
 const familyModules_1 = __importDefault(require("./api/familyModules"));
 const insSubs_1 = __importDefault(require("./api/insSubs"));
 const patPlans_1 = __importDefault(require("./api/patPlans"));
+const labCases_1 = __importDefault(require("./api/labCases"));
+const referrals_1 = __importDefault(require("./api/referrals"));
+const refAttaches_1 = __importDefault(require("./api/refAttaches"));
 class OpenDental {
     static httpClient;
     /**
@@ -195,7 +198,25 @@ class OpenDental {
         if (!this.httpClient) {
             throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
         }
-        return new patPlans_1.default(this.httpClient);
+        return new labCases_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the Referrals API.
+     */
+    static Referrals() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new referrals_1.default(this.httpClient);
+    }
+    /**
+     * Create a new instance of the LabCases API.
+     */
+    static RefAttaches() {
+        if (!this.httpClient) {
+            throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
+        }
+        return new refAttaches_1.default(this.httpClient);
     }
 }
 exports.OpenDental = OpenDental;

package/dist/types/refAttachTypes.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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;
+    ReferralNum?: number;
+    referralName?: string;
+    PatNum?: number;
+    ItemOrder?: number;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+    DateTStamp?: string;
+}
+export interface GetRefAttachesParams {
+    PatNum?: number;
+    Offset?: number;
+}
+/**
+ * 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;
+    ReferralNum?: number;
+    referralName?: string;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+}
+/**
+ * Updates an existing refattach.
+ */
+export interface UpdateRefAttachParams {
+    RefAttachNum: number;
+    ReferralNum?: number;
+    RefDate?: string;
+    ReferralType?: "RefTo" | "RefFrom" | "RefCustom";
+    RefToStatus?: "None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete";
+    Note?: string;
+    IsTransitionOfCare?: "true" | "false";
+    ProcNum?: number;
+    DateProcComplete?: string;
+    ProvNum?: number;
+}
+//# sourceMappingURL=refAttachTypes.d.ts.map

package/dist/types/refAttachTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refAttachTypes.d.ts","sourceRoot":"","sources":["../../src/types/refAttachTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;IAC3F,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/refAttachTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/referralTypes.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    IsHidden?: "true" | "false";
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    PatNum?: string;
+    IsDoctor?: "true" | "false";
+    DateTStamp?: string;
+    IsPreferred?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+    isPatient?: "true" | "false";
+}
+export interface GetReferralsParams {
+    IsHidden?: "true" | "false";
+    NotPerson?: "true" | "false";
+    IsDoctor?: "true" | "false";
+    IsPreferred?: "true" | "false";
+    isPatient?: "true" | "false";
+    BusinessName?: string;
+    Offset?: number;
+}
+/**
+ * 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;
+    PatNum?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    specialty?: string;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: string;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+/**
+ * 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;
+    LName?: string;
+    FName?: string;
+    MName?: string;
+    SSN?: string;
+    UsingTIN?: "true" | "false";
+    Specialty?: number;
+    ST?: string;
+    Telephone?: string;
+    Address?: string;
+    Address2?: string;
+    City?: number;
+    Zip?: string;
+    Note?: string;
+    Phone2?: string;
+    NotPerson?: string;
+    Title?: string;
+    EMail?: string;
+    IsDoctor?: "true" | "false";
+    BusinessName?: string;
+    DisplayNote?: string;
+}
+//# sourceMappingURL=referralTypes.d.ts.map

package/dist/types/referralTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referralTypes.d.ts","sourceRoot":"","sources":["../../src/types/referralTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B;AAGD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types/referralTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rinse-dental/open-dental",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "A TypeScript library for easily accessing Open Dental APIs.",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/src/api/refAttaches.ts

@@ -0,0 +1,142 @@
+import HttpClient from "../utils/httpClient";
+import {
+  RefAttach,
+  GetRefAttachesParams,
+  CreateRefAttachParams,
+  UpdateRefAttachParams,
+} from "../types/refAttachTypes"
+
+export default class RefAttaches {
+  private httpClient: HttpClient;
+
+  constructor(httpClient: HttpClient) {
+    this.httpClient = httpClient;
+  }
+
+  /**
+    * Fetch multiple refattaches with optional filtering and pagination.
+    * @param {Object} params - The parameters for filtering and pagination.
+    * @param {number} [params.PatNum] - The PatNum of the RefAttaches.
+    * @param {number} [params.Offset] - Pagination offset for results.
+    * @returns {Promise<RefAttach[]>} - A list of inssubs.
+    */
+  public async getRefAttaches({
+    PatNum,
+    Offset,
+  }: GetRefAttachesParams = {}): Promise<RefAttach[]> {
+    const params = {
+      PatNum,
+      Offset,
+    };
+  
+    return this.httpClient.get<RefAttach[]>("/refattaches", params);
+  }
+
+  /**
+   * Attach a referral to a patient.
+   * @param {Object} data - The details of RefAttach to create.
+   * @param {number} data.PatNum - Required. FK to patient.PatNum.
+   * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} [data.referralName] - Required. Number assigned by insurance company.
+   * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+   * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+   * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+   * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+   * @returns {Promise<RefAttach>} - The created refattaches.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async createRefAttach({
+    PatNum,
+    ReferralNum,
+    referralName,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : CreateRefAttachParams): Promise<RefAttach> {
+    if (!PatNum || (!ReferralNum && !referralName)) {
+      throw new Error("Invalid data: PatNum and either ReferralNum or referralName are required.");
+    }
+
+    return this.httpClient.post<RefAttach>("/refattaches", {
+      PatNum,
+      ReferralNum,
+      referralName,
+      RefDate,
+      ReferralType,
+      RefToStatus,
+      Note,
+      IsTransitionOfCare,
+      ProcNum,
+      DateProcComplete,
+      ProvNum,
+    });
+  }
+
+  /**
+   * Update a refattach.
+   * @param {Object} data - The details of RefAttach to create.
+   * @param {number} data.RefAttachNum - Required. FK to patient.PatNum.
+   * @param {number} [data.ReferralNum] - Required. The PatNum of the patient who is subscribed to this plan.
+   * @param {string} [data.RefDate] - Optional. The date this InsPlan became effective.
+   * @param {"RefTo" | "RefFrom" | "RefCustom"} [data.ReferralType] - Optional. Not usually used. The date this InsPlan was terminated.
+   * @param {"None" | "Declined" | "Scheduled" | "Consulted" | "InTreatment" | "Complete"} [data.RefToStatus] - Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
+   * @param {string} [data.Note] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {"true" | "false"} [data.IsTransitionOfCare] - Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
+   * @param {number} [data.ProcNum] - Optional. Use to store any other info that affects coverage.
+   * @param {string} [data.DateProcComplete] - Optional. Use to store any other info that affects coverage.
+   * @param {number} [data.ProvNum] - Optional. Use to store any other info that affects coverage.
+   * @returns {Promise<RefAttach>} - The created refattaches.
+   * @throws {Error} - If required fields are missing or the API returns an error.
+   */
+  public async updateRefAttach({
+    RefAttachNum,
+    ReferralNum,
+    RefDate,
+    ReferralType,
+    RefToStatus,
+    Note,
+    IsTransitionOfCare,
+    ProcNum,
+    DateProcComplete,
+    ProvNum,
+  } : UpdateRefAttachParams): Promise<RefAttach> {
+    if (!RefAttachNum) {
+      throw new Error("Invalid data: RefAttachNum is required.");
+    }
+
+    return this.httpClient.put<RefAttach>(`/refattaches/${RefAttachNum}`, {
+      ReferralNum,
+      RefDate,
+      ReferralType,
+      RefToStatus,
+      Note,
+      IsTransitionOfCare,
+      ProcNum,
+      DateProcComplete,
+      ProvNum,
+    });
+  }
+
+  /**
+   * Delete a refattach.
+   * @param {number} RefAttachNum - Required: The unique identifier of the RefAttach to delete.
+   * @returns {Promise<void>} - Resolves when the discount plan sub is deleted.
+   * @throws {Error} - If `RefAttachNum` is not valid or the API returns an error.
+   */
+  public async deleteInsSub(RefAttachNum: number): Promise<void> {
+    if (!RefAttachNum || typeof RefAttachNum !== "number") {
+      throw new Error("Invalid parameter: RefAttachNum must be a valid number.");
+    }
+
+    return this.httpClient.delete<void>(`/refattaches/${RefAttachNum}`);
+  }
+}

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,8 @@ 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";
 
 class OpenDental {
   private static httpClient: HttpClient;
@@ -213,7 +215,27 @@ 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);
   }
 }
 

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.
+  }
+