@rinse-dental/open-dental 3.4.2 → 4.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +388 -16
- package/dist/api/accountModules.d.ts +23 -3
- package/dist/api/accountModules.d.ts.map +1 -1
- package/dist/api/accountModules.js +17 -6
- package/dist/api/adjustments.d.ts +5 -2
- package/dist/api/adjustments.d.ts.map +1 -1
- package/dist/api/adjustments.js +11 -5
- package/dist/api/allergies.d.ts +5 -2
- package/dist/api/allergies.d.ts.map +1 -1
- package/dist/api/allergies.js +11 -5
- package/dist/api/allergydefs.d.ts +27 -0
- package/dist/api/allergydefs.d.ts.map +1 -0
- package/dist/api/allergydefs.js +40 -0
- package/dist/api/appointmentTypes.d.ts +12 -2
- package/dist/api/appointmentTypes.d.ts.map +1 -1
- package/dist/api/appointmentTypes.js +12 -2
- package/dist/api/appointments.d.ts +5 -2
- package/dist/api/appointments.d.ts.map +1 -1
- package/dist/api/appointments.js +19 -13
- package/dist/api/apptFieldDefs.d.ts +54 -0
- package/dist/api/apptFieldDefs.d.ts.map +1 -0
- package/dist/api/apptFieldDefs.js +79 -0
- package/dist/api/apptFields.d.ts +60 -0
- package/dist/api/apptFields.d.ts.map +1 -0
- package/dist/api/apptFields.js +102 -0
- package/dist/api/asapComms.d.ts +44 -0
- package/dist/api/asapComms.d.ts.map +1 -0
- package/dist/api/asapComms.js +64 -0
- package/dist/api/autoNoteControls.d.ts +48 -0
- package/dist/api/autoNoteControls.d.ts.map +1 -0
- package/dist/api/autoNoteControls.js +74 -0
- package/dist/api/autoNotes.d.ts +42 -0
- package/dist/api/autoNotes.d.ts.map +1 -0
- package/dist/api/autoNotes.js +70 -0
- package/dist/api/benefits.d.ts +14 -3
- package/dist/api/benefits.d.ts.map +1 -1
- package/dist/api/benefits.js +24 -5
- package/dist/api/carriers.d.ts +68 -0
- package/dist/api/carriers.d.ts.map +1 -0
- package/dist/api/carriers.js +107 -0
- package/dist/api/chartModules.d.ts +1 -1
- package/dist/api/chartModules.d.ts.map +1 -1
- package/dist/api/chartModules.js +4 -4
- package/dist/api/claimPayments.d.ts +93 -0
- package/dist/api/claimPayments.d.ts.map +1 -0
- package/dist/api/claimPayments.js +163 -0
- package/dist/api/claimProcs.d.ts +42 -2
- package/dist/api/claimProcs.d.ts.map +1 -1
- package/dist/api/claimProcs.js +65 -2
- package/dist/api/claimTrackings.d.ts +44 -0
- package/dist/api/claimTrackings.d.ts.map +1 -0
- package/dist/api/claimTrackings.js +70 -0
- package/dist/api/claims.d.ts +33 -0
- package/dist/api/claims.d.ts.map +1 -1
- package/dist/api/claims.js +60 -6
- package/dist/api/clinics.d.ts +47 -0
- package/dist/api/clinics.d.ts.map +1 -0
- package/dist/api/clinics.js +70 -0
- package/dist/api/clockEvents.d.ts +33 -0
- package/dist/api/clockEvents.d.ts.map +1 -0
- package/dist/api/clockEvents.js +42 -0
- package/dist/api/codeGroups.d.ts +64 -0
- package/dist/api/codeGroups.d.ts.map +1 -0
- package/dist/api/codeGroups.js +84 -0
- package/dist/api/commlogs.d.ts +14 -2
- package/dist/api/commlogs.d.ts.map +1 -1
- package/dist/api/commlogs.js +11 -4
- package/dist/api/computers.d.ts +25 -0
- package/dist/api/computers.d.ts.map +1 -0
- package/dist/api/computers.js +29 -0
- package/dist/api/covCats.d.ts +58 -0
- package/dist/api/covCats.d.ts.map +1 -0
- package/dist/api/covCats.js +78 -0
- package/dist/api/covSpans.d.ts +60 -0
- package/dist/api/covSpans.d.ts.map +1 -0
- package/dist/api/covSpans.js +91 -0
- package/dist/api/definitions.d.ts +19 -3
- package/dist/api/definitions.d.ts.map +1 -1
- package/dist/api/definitions.js +26 -2
- package/dist/api/discountPlanSubs.js +3 -3
- package/dist/api/discountPlans.d.ts +4 -1
- package/dist/api/discountPlans.d.ts.map +1 -1
- package/dist/api/discountPlans.js +9 -3
- package/dist/api/diseaseDefs.d.ts +35 -0
- package/dist/api/diseaseDefs.d.ts.map +1 -0
- package/dist/api/diseaseDefs.js +49 -0
- package/dist/api/diseases.d.ts +4 -1
- package/dist/api/diseases.d.ts.map +1 -1
- package/dist/api/diseases.js +6 -3
- package/dist/api/documents.d.ts +137 -0
- package/dist/api/documents.d.ts.map +1 -0
- package/dist/api/documents.js +235 -0
- package/dist/api/eTrans.d.ts +20 -0
- package/dist/api/eTrans.d.ts.map +1 -0
- package/dist/api/eTrans.js +36 -0
- package/dist/api/eTransMessageTexts.d.ts +15 -0
- package/dist/api/eTransMessageTexts.d.ts.map +1 -0
- package/dist/api/eTransMessageTexts.js +22 -0
- package/dist/api/eTranss.d.ts +22 -0
- package/dist/api/eTranss.d.ts.map +1 -0
- package/dist/api/eTranss.js +29 -0
- package/dist/api/ehrPatients.d.ts +29 -0
- package/dist/api/ehrPatients.d.ts.map +1 -0
- package/dist/api/ehrPatients.js +42 -0
- package/dist/api/employees.d.ts +66 -0
- package/dist/api/employees.d.ts.map +1 -0
- package/dist/api/employees.js +86 -0
- package/dist/api/employers.d.ts +53 -0
- package/dist/api/employers.d.ts.map +1 -0
- package/dist/api/employers.js +81 -0
- package/dist/api/eobAttaches.d.ts +56 -0
- package/dist/api/eobAttaches.d.ts.map +1 -0
- package/dist/api/eobAttaches.js +96 -0
- package/dist/api/events.d.ts +26 -0
- package/dist/api/events.d.ts.map +1 -0
- package/dist/api/events.js +26 -0
- package/dist/api/familyModules.d.ts +12 -2
- package/dist/api/familyModules.d.ts.map +1 -1
- package/dist/api/familyModules.js +9 -4
- package/dist/api/feeScheds.d.ts +8 -2
- package/dist/api/feeScheds.d.ts.map +1 -1
- package/dist/api/feeScheds.js +14 -2
- package/dist/api/fees.d.ts +41 -3
- package/dist/api/fees.d.ts.map +1 -1
- package/dist/api/fees.js +58 -2
- package/dist/api/histAppointments.d.ts +29 -0
- package/dist/api/histAppointments.d.ts.map +1 -0
- package/dist/api/histAppointments.js +33 -0
- package/dist/api/index.d.ts +89 -13
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +180 -28
- package/dist/api/insPlans.d.ts +11 -4
- package/dist/api/insPlans.d.ts.map +1 -1
- package/dist/api/insPlans.js +17 -7
- package/dist/api/insSubs.d.ts +13 -5
- package/dist/api/insSubs.d.ts.map +1 -1
- package/dist/api/insSubs.js +19 -8
- package/dist/api/insVerifies.d.ts +9 -6
- package/dist/api/insVerifies.d.ts.map +1 -1
- package/dist/api/insVerifies.js +15 -9
- package/dist/api/labCases.d.ts +22 -7
- package/dist/api/labCases.d.ts.map +1 -1
- package/dist/api/labCases.js +34 -11
- package/dist/api/labTurnarounds.d.ts +52 -0
- package/dist/api/labTurnarounds.d.ts.map +1 -0
- package/dist/api/labTurnarounds.js +78 -0
- package/dist/api/laboratories.d.ts +71 -0
- package/dist/api/laboratories.d.ts.map +1 -0
- package/dist/api/laboratories.js +91 -0
- package/dist/api/medicationPats.d.ts +5 -2
- package/dist/api/medicationPats.d.ts.map +1 -1
- package/dist/api/medicationPats.js +11 -5
- package/dist/api/medications.d.ts +37 -0
- package/dist/api/medications.d.ts.map +1 -0
- package/dist/api/medications.js +46 -0
- package/dist/api/operatories.d.ts +4 -3
- package/dist/api/operatories.d.ts.map +1 -1
- package/dist/api/operatories.js +8 -4
- package/dist/api/patFieldDefs.d.ts +57 -0
- package/dist/api/patFieldDefs.d.ts.map +1 -0
- package/dist/api/patFieldDefs.js +83 -0
- package/dist/api/patFields.d.ts +11 -6
- package/dist/api/patFields.d.ts.map +1 -1
- package/dist/api/patFields.js +23 -14
- package/dist/api/patPlans.d.ts +13 -6
- package/dist/api/patPlans.d.ts.map +1 -1
- package/dist/api/patPlans.js +18 -8
- package/dist/api/patientNotes.d.ts +48 -0
- package/dist/api/patientNotes.d.ts.map +1 -0
- package/dist/api/patientNotes.js +70 -0
- package/dist/api/patientRaces.d.ts +21 -0
- package/dist/api/patientRaces.d.ts.map +1 -0
- package/dist/api/patientRaces.js +28 -0
- package/dist/api/patients.d.ts +6 -3
- package/dist/api/patients.d.ts.map +1 -1
- package/dist/api/patients.js +15 -6
- package/dist/api/payPlanCharges.d.ts +4 -0
- package/dist/api/payPlanCharges.d.ts.map +1 -1
- package/dist/api/payPlanCharges.js +4 -0
- package/dist/api/payPlans.d.ts +10 -1
- package/dist/api/payPlans.d.ts.map +1 -1
- package/dist/api/payPlans.js +17 -18
- package/dist/api/paySplits.d.ts +12 -7
- package/dist/api/paySplits.d.ts.map +1 -1
- package/dist/api/paySplits.js +14 -6
- package/dist/api/payments.d.ts +18 -3
- package/dist/api/payments.d.ts.map +1 -1
- package/dist/api/payments.js +30 -4
- package/dist/api/perioExams.d.ts +67 -0
- package/dist/api/perioExams.d.ts.map +1 -0
- package/dist/api/perioExams.js +104 -0
- package/dist/api/perioMeasures.d.ts +74 -0
- package/dist/api/perioMeasures.d.ts.map +1 -0
- package/dist/api/perioMeasures.js +118 -0
- package/dist/api/pharmacies.d.ts +29 -0
- package/dist/api/pharmacies.d.ts.map +1 -0
- package/dist/api/pharmacies.js +38 -0
- package/dist/api/popups.d.ts +42 -0
- package/dist/api/popups.d.ts.map +1 -0
- package/dist/api/popups.js +71 -0
- package/dist/api/preferences.d.ts +31 -0
- package/dist/api/preferences.d.ts.map +1 -0
- package/dist/api/preferences.js +46 -0
- package/dist/api/procNotes.d.ts +5 -2
- package/dist/api/procNotes.d.ts.map +1 -1
- package/dist/api/procNotes.js +9 -3
- package/dist/api/procTPs.d.ts +6 -3
- package/dist/api/procTPs.d.ts.map +1 -1
- package/dist/api/procTPs.js +10 -4
- package/dist/api/procedureCodes.d.ts +9 -7
- package/dist/api/procedureCodes.d.ts.map +1 -1
- package/dist/api/procedureCodes.js +13 -8
- package/dist/api/procedureLog.d.ts +5 -2
- package/dist/api/procedureLog.d.ts.map +1 -1
- package/dist/api/procedureLog.js +15 -6
- package/dist/api/providers.d.ts +4 -1
- package/dist/api/providers.d.ts.map +1 -1
- package/dist/api/providers.js +10 -4
- package/dist/api/queries.d.ts +24 -1
- package/dist/api/queries.d.ts.map +1 -1
- package/dist/api/queries.js +35 -0
- package/dist/api/quickPasteCats.d.ts +24 -0
- package/dist/api/quickPasteCats.d.ts.map +1 -0
- package/dist/api/quickPasteCats.js +33 -0
- package/dist/api/quickPasteNotes.d.ts +27 -0
- package/dist/api/quickPasteNotes.d.ts.map +1 -0
- package/dist/api/quickPasteNotes.js +36 -0
- package/dist/api/recallTypes.d.ts +31 -0
- package/dist/api/recallTypes.d.ts.map +1 -0
- package/dist/api/recallTypes.js +40 -0
- package/dist/api/recalls.d.ts +20 -4
- package/dist/api/recalls.d.ts.map +1 -1
- package/dist/api/recalls.js +26 -14
- package/dist/api/refAttaches.d.ts +6 -3
- package/dist/api/refAttaches.d.ts.map +1 -1
- package/dist/api/refAttaches.js +11 -5
- package/dist/api/referrals.d.ts +4 -1
- package/dist/api/referrals.d.ts.map +1 -1
- package/dist/api/referrals.js +10 -4
- package/dist/api/reports.d.ts +34 -0
- package/dist/api/reports.d.ts.map +1 -0
- package/dist/api/reports.js +40 -0
- package/dist/api/rxPats.d.ts +27 -0
- package/dist/api/rxPats.d.ts.map +1 -0
- package/dist/api/rxPats.js +41 -0
- package/dist/api/scheduleOps.d.ts +20 -0
- package/dist/api/scheduleOps.d.ts.map +1 -0
- package/dist/api/scheduleOps.js +30 -0
- package/dist/api/schedules.d.ts +23 -2
- package/dist/api/schedules.d.ts.map +1 -1
- package/dist/api/schedules.js +31 -2
- package/dist/api/security.d.ts +25 -0
- package/dist/api/security.d.ts.map +1 -0
- package/dist/api/security.js +29 -0
- package/dist/api/securityLogs.d.ts +5 -2
- package/dist/api/securityLogs.d.ts.map +1 -1
- package/dist/api/securityLogs.js +8 -2
- package/dist/api/sheetDefs.d.ts +27 -0
- package/dist/api/sheetDefs.d.ts.map +1 -0
- package/dist/api/sheetDefs.js +36 -0
- package/dist/api/sheetFields.d.ts +38 -0
- package/dist/api/sheetFields.d.ts.map +1 -0
- package/dist/api/sheetFields.js +53 -0
- package/dist/api/sheets.d.ts +47 -0
- package/dist/api/sheets.d.ts.map +1 -0
- package/dist/api/sheets.js +64 -0
- package/dist/api/signalODs.d.ts +23 -0
- package/dist/api/signalODs.d.ts.map +1 -0
- package/dist/api/signalODs.js +30 -0
- package/dist/api/statements.d.ts +48 -0
- package/dist/api/statements.d.ts.map +1 -0
- package/dist/api/statements.js +72 -0
- package/dist/api/subscriptions.d.ts +67 -0
- package/dist/api/subscriptions.d.ts.map +1 -0
- package/dist/api/subscriptions.js +93 -0
- package/dist/api/substitutionLinks.d.ts +51 -0
- package/dist/api/substitutionLinks.d.ts.map +1 -0
- package/dist/api/substitutionLinks.js +74 -0
- package/dist/api/taskLists.d.ts +20 -0
- package/dist/api/taskLists.d.ts.map +1 -0
- package/dist/api/taskLists.js +24 -0
- package/dist/api/taskNotes.d.ts +50 -0
- package/dist/api/taskNotes.d.ts.map +1 -0
- package/dist/api/taskNotes.js +81 -0
- package/dist/api/tasks.d.ts +69 -0
- package/dist/api/tasks.d.ts.map +1 -0
- package/dist/api/tasks.js +89 -0
- package/dist/api/toothInitials.d.ts +39 -0
- package/dist/api/toothInitials.d.ts.map +1 -0
- package/dist/api/toothInitials.js +64 -0
- package/dist/api/treatplanattaches.d.ts +5 -2
- package/dist/api/treatplanattaches.d.ts.map +1 -1
- package/dist/api/treatplanattaches.js +10 -4
- package/dist/api/treatplans.d.ts +15 -1
- package/dist/api/treatplans.d.ts.map +1 -1
- package/dist/api/treatplans.js +26 -4
- package/dist/api/userGroupAttaches.d.ts +20 -0
- package/dist/api/userGroupAttaches.d.ts.map +1 -0
- package/dist/api/userGroupAttaches.js +30 -0
- package/dist/api/userGroups.d.ts +20 -0
- package/dist/api/userGroups.d.ts.map +1 -0
- package/dist/api/userGroups.js +29 -0
- package/dist/api/userODs.d.ts +49 -0
- package/dist/api/userODs.d.ts.map +1 -0
- package/dist/api/userODs.js +64 -0
- package/dist/openDental.d.ts +624 -115
- package/dist/openDental.d.ts.map +1 -1
- package/dist/openDental.js +800 -291
- package/dist/types/DiscountPlanTypes.d.ts +3 -0
- package/dist/types/DiscountPlanTypes.d.ts.map +1 -1
- package/dist/types/adjustmentTypes.d.ts +3 -0
- package/dist/types/adjustmentTypes.d.ts.map +1 -1
- package/dist/types/allergyDefTypes.d.ts +25 -0
- package/dist/types/allergyDefTypes.d.ts.map +1 -0
- package/dist/types/allergyTypes.d.ts +3 -0
- package/dist/types/allergyTypes.d.ts.map +1 -1
- package/dist/types/{appoinmentTypesType.d.ts → appointmentTypeTypes.d.ts} +1 -1
- package/dist/types/appointmentTypeTypes.d.ts.map +1 -0
- package/dist/types/appointmentTypeTypes.js +2 -0
- package/dist/types/appointmentTypes.d.ts +19 -0
- package/dist/types/appointmentTypes.d.ts.map +1 -1
- package/dist/types/apptFieldDefTypes.d.ts +25 -0
- package/dist/types/apptFieldDefTypes.d.ts.map +1 -0
- package/dist/types/apptFieldDefTypes.js +2 -0
- package/dist/types/apptFieldTypes.d.ts +34 -0
- package/dist/types/apptFieldTypes.d.ts.map +1 -0
- package/dist/types/apptFieldTypes.js +2 -0
- package/dist/types/asapCommTypes.d.ts +63 -0
- package/dist/types/asapCommTypes.d.ts.map +1 -0
- package/dist/types/asapCommTypes.js +2 -0
- package/dist/types/autoNoteControlTypes.d.ts +27 -0
- package/dist/types/autoNoteControlTypes.d.ts.map +1 -0
- package/dist/types/autoNoteControlTypes.js +2 -0
- package/dist/types/autoNoteTypes.d.ts +33 -0
- package/dist/types/autoNoteTypes.d.ts.map +1 -0
- package/dist/types/autoNoteTypes.js +2 -0
- package/dist/types/benefitTypes.d.ts +6 -0
- package/dist/types/benefitTypes.d.ts.map +1 -1
- package/dist/types/carrierTypes.d.ts +45 -0
- package/dist/types/carrierTypes.d.ts.map +1 -0
- package/dist/types/carrierTypes.js +2 -0
- package/dist/types/claimPaymentTypes.d.ts +72 -0
- package/dist/types/claimPaymentTypes.d.ts.map +1 -0
- package/dist/types/claimPaymentTypes.js +2 -0
- package/dist/types/claimProcTypes.d.ts +3 -0
- package/dist/types/claimProcTypes.d.ts.map +1 -1
- package/dist/types/claimTrackingTypes.d.ts +37 -0
- package/dist/types/claimTrackingTypes.d.ts.map +1 -0
- package/dist/types/claimTrackingTypes.js +2 -0
- package/dist/types/claimTypes.d.ts +3 -0
- package/dist/types/claimTypes.d.ts.map +1 -1
- package/dist/types/clinicTypes.d.ts +45 -0
- package/dist/types/clinicTypes.d.ts.map +1 -0
- package/dist/types/clinicTypes.js +2 -0
- package/dist/types/clockEventTypes.d.ts +52 -0
- package/dist/types/clockEventTypes.d.ts.map +1 -0
- package/dist/types/clockEventTypes.js +2 -0
- package/dist/types/codeGroupTypes.d.ts +67 -0
- package/dist/types/codeGroupTypes.d.ts.map +1 -0
- package/dist/types/codeGroupTypes.js +2 -0
- package/dist/types/computerTypes.d.ts +10 -0
- package/dist/types/computerTypes.d.ts.map +1 -0
- package/dist/types/computerTypes.js +2 -0
- package/dist/types/covCatTypes.d.ts +53 -0
- package/dist/types/covCatTypes.d.ts.map +1 -0
- package/dist/types/covCatTypes.js +2 -0
- package/dist/types/covSpanTypes.d.ts +52 -0
- package/dist/types/covSpanTypes.d.ts.map +1 -0
- package/dist/types/covSpanTypes.js +2 -0
- package/dist/types/definitionTypes.d.ts +12 -0
- package/dist/types/definitionTypes.d.ts.map +1 -1
- package/dist/types/discountPlanSubTypes.d.ts +5 -1
- package/dist/types/discountPlanSubTypes.d.ts.map +1 -1
- package/dist/types/diseaseDefTypes.d.ts +33 -0
- package/dist/types/diseaseDefTypes.d.ts.map +1 -0
- package/dist/types/diseaseDefTypes.js +2 -0
- package/dist/types/diseaseTypes.d.ts +3 -0
- package/dist/types/diseaseTypes.d.ts.map +1 -1
- package/dist/types/documentTypes.d.ts +191 -0
- package/dist/types/documentTypes.d.ts.map +1 -0
- package/dist/types/documentTypes.js +2 -0
- package/dist/types/eTransMessageTextTypes.d.ts +9 -0
- package/dist/types/eTransMessageTextTypes.d.ts.map +1 -0
- package/dist/types/eTransMessageTextTypes.js +2 -0
- package/dist/types/eTransTypes.d.ts +15 -0
- package/dist/types/eTransTypes.d.ts.map +1 -0
- package/dist/types/eTransTypes.js +2 -0
- package/dist/types/eTranssTypes.d.ts +46 -0
- package/dist/types/eTranssTypes.d.ts.map +1 -0
- package/dist/types/eTranssTypes.js +2 -0
- package/dist/types/ehrPatientTypes.d.ts +34 -0
- package/dist/types/ehrPatientTypes.d.ts.map +1 -0
- package/dist/types/ehrPatientTypes.js +2 -0
- package/dist/types/employeeTypes.d.ts +88 -0
- package/dist/types/employeeTypes.d.ts.map +1 -0
- package/dist/types/employeeTypes.js +2 -0
- package/dist/types/employerTypes.d.ts +38 -0
- package/dist/types/employerTypes.d.ts.map +1 -0
- package/dist/types/employerTypes.js +2 -0
- package/dist/types/eobAttachTypes.d.ts +62 -0
- package/dist/types/eobAttachTypes.d.ts.map +1 -0
- package/dist/types/eobAttachTypes.js +2 -0
- package/dist/types/eventTypes.d.ts +52 -0
- package/dist/types/eventTypes.d.ts.map +1 -0
- package/dist/types/eventTypes.js +2 -0
- package/dist/types/feeTypes.d.ts +3 -0
- package/dist/types/feeTypes.d.ts.map +1 -1
- package/dist/types/histAppointmentTypes.d.ts +77 -0
- package/dist/types/histAppointmentTypes.d.ts.map +1 -0
- package/dist/types/histAppointmentTypes.js +2 -0
- package/dist/types/insPlanTypes.d.ts +4 -1
- package/dist/types/insPlanTypes.d.ts.map +1 -1
- package/dist/types/insSubTypes.d.ts +4 -1
- package/dist/types/insSubTypes.d.ts.map +1 -1
- package/dist/types/insVerifiesTypes.d.ts +3 -0
- package/dist/types/insVerifiesTypes.d.ts.map +1 -1
- package/dist/types/labCaseTypes.d.ts +4 -0
- package/dist/types/labCaseTypes.d.ts.map +1 -1
- package/dist/types/labTurnaroundTypes.d.ts +55 -0
- package/dist/types/labTurnaroundTypes.d.ts.map +1 -0
- package/dist/types/labTurnaroundTypes.js +2 -0
- package/dist/types/laboratoryTypes.d.ts +80 -0
- package/dist/types/laboratoryTypes.d.ts.map +1 -0
- package/dist/types/laboratoryTypes.js +2 -0
- package/dist/types/medicationPatTypes.d.ts +3 -0
- package/dist/types/medicationPatTypes.d.ts.map +1 -1
- package/dist/types/medicationTypes.d.ts +28 -0
- package/dist/types/medicationTypes.d.ts.map +1 -0
- package/dist/types/medicationTypes.js +2 -0
- package/dist/types/operatoryTypes.d.ts +5 -2
- package/dist/types/operatoryTypes.d.ts.map +1 -1
- package/dist/types/patFieldDefTypes.d.ts +64 -0
- package/dist/types/patFieldDefTypes.d.ts.map +1 -0
- package/dist/types/patFieldDefTypes.js +2 -0
- package/dist/types/patFieldTypes.d.ts +4 -0
- package/dist/types/patFieldTypes.d.ts.map +1 -1
- package/dist/types/patPlanTypes.d.ts +3 -0
- package/dist/types/patPlanTypes.d.ts.map +1 -1
- package/dist/types/patientNoteTypes.d.ts +32 -0
- package/dist/types/patientNoteTypes.d.ts.map +1 -0
- package/dist/types/patientNoteTypes.js +2 -0
- package/dist/types/patientRaceTypes.d.ts +25 -0
- package/dist/types/patientRaceTypes.d.ts.map +1 -0
- package/dist/types/patientRaceTypes.js +2 -0
- package/dist/types/patientTypes.d.ts +7 -1
- package/dist/types/patientTypes.d.ts.map +1 -1
- package/dist/types/payPlanChargeTypes.d.ts +4 -0
- package/dist/types/payPlanChargeTypes.d.ts.map +1 -1
- package/dist/types/paySplitTypes.d.ts +3 -0
- package/dist/types/paySplitTypes.d.ts.map +1 -1
- package/dist/types/paymentTypes.d.ts +11 -0
- package/dist/types/paymentTypes.d.ts.map +1 -1
- package/dist/types/perioExamTypes.d.ts +54 -0
- package/dist/types/perioExamTypes.d.ts.map +1 -0
- package/dist/types/perioExamTypes.js +2 -0
- package/dist/types/perioMeasureTypes.d.ts +80 -0
- package/dist/types/perioMeasureTypes.d.ts.map +1 -0
- package/dist/types/perioMeasureTypes.js +2 -0
- package/dist/types/pharmacyTypes.d.ts +18 -0
- package/dist/types/pharmacyTypes.d.ts.map +1 -0
- package/dist/types/pharmacyTypes.js +2 -0
- package/dist/types/popupTypes.d.ts +55 -0
- package/dist/types/popupTypes.d.ts.map +1 -0
- package/dist/types/popupTypes.js +2 -0
- package/dist/types/preferenceTypes.d.ts +32 -0
- package/dist/types/preferenceTypes.d.ts.map +1 -0
- package/dist/types/preferenceTypes.js +2 -0
- package/dist/types/procNoteTypes.d.ts +3 -0
- package/dist/types/procNoteTypes.d.ts.map +1 -1
- package/dist/types/procTPTypes.d.ts +3 -0
- package/dist/types/procTPTypes.d.ts.map +1 -1
- package/dist/types/procedureCodeTypes.d.ts +3 -0
- package/dist/types/procedureCodeTypes.d.ts.map +1 -1
- package/dist/types/procedurelogTypes.d.ts +7 -0
- package/dist/types/procedurelogTypes.d.ts.map +1 -1
- package/dist/types/providerTypes.d.ts +3 -0
- package/dist/types/providerTypes.d.ts.map +1 -1
- package/dist/types/queryTypes.d.ts +10 -0
- package/dist/types/queryTypes.d.ts.map +1 -1
- package/dist/types/quickPasteCatTypes.d.ts +23 -0
- package/dist/types/quickPasteCatTypes.d.ts.map +1 -0
- package/dist/types/quickPasteCatTypes.js +2 -0
- package/dist/types/quickPasteNoteTypes.d.ts +26 -0
- package/dist/types/quickPasteNoteTypes.d.ts.map +1 -0
- package/dist/types/quickPasteNoteTypes.js +2 -0
- package/dist/types/recallTypeTypes.d.ts +13 -0
- package/dist/types/recallTypeTypes.d.ts.map +1 -0
- package/dist/types/recallTypeTypes.js +2 -0
- package/dist/types/recallTypes.d.ts +6 -3
- package/dist/types/recallTypes.d.ts.map +1 -1
- package/dist/types/refAttachTypes.d.ts +3 -0
- package/dist/types/refAttachTypes.d.ts.map +1 -1
- package/dist/types/referralTypes.d.ts +7 -4
- package/dist/types/referralTypes.d.ts.map +1 -1
- package/dist/types/reportTypes.d.ts +56 -0
- package/dist/types/reportTypes.d.ts.map +1 -0
- package/dist/types/reportTypes.js +2 -0
- package/dist/types/rxPatTypes.d.ts +43 -0
- package/dist/types/rxPatTypes.d.ts.map +1 -0
- package/dist/types/rxPatTypes.js +2 -0
- package/dist/types/scheduleOpTypes.d.ts +22 -0
- package/dist/types/scheduleOpTypes.d.ts.map +1 -0
- package/dist/types/scheduleOpTypes.js +2 -0
- package/dist/types/scheduleTypes.d.ts +17 -0
- package/dist/types/scheduleTypes.d.ts.map +1 -1
- package/dist/types/securityLogTypes.d.ts +3 -0
- package/dist/types/securityLogTypes.d.ts.map +1 -1
- package/dist/types/securityTypes.d.ts +13 -0
- package/dist/types/securityTypes.d.ts.map +1 -0
- package/dist/types/securityTypes.js +2 -0
- package/dist/types/sheetDefTypes.d.ts +22 -0
- package/dist/types/sheetDefTypes.d.ts.map +1 -0
- package/dist/types/sheetDefTypes.js +2 -0
- package/dist/types/sheetFieldTypes.d.ts +48 -0
- package/dist/types/sheetFieldTypes.d.ts.map +1 -0
- package/dist/types/sheetFieldTypes.js +2 -0
- package/dist/types/sheetTypes.d.ts +62 -0
- package/dist/types/sheetTypes.d.ts.map +1 -0
- package/dist/types/sheetTypes.js +2 -0
- package/dist/types/signalODTypes.d.ts +48 -0
- package/dist/types/signalODTypes.d.ts.map +1 -0
- package/dist/types/signalODTypes.js +2 -0
- package/dist/types/statementTypes.d.ts +60 -0
- package/dist/types/statementTypes.d.ts.map +1 -0
- package/dist/types/statementTypes.js +2 -0
- package/dist/types/subscriptionTypes.d.ts +99 -0
- package/dist/types/subscriptionTypes.d.ts.map +1 -0
- package/dist/types/subscriptionTypes.js +2 -0
- package/dist/types/substitutionLinkTypes.d.ts +46 -0
- package/dist/types/substitutionLinkTypes.d.ts.map +1 -0
- package/dist/types/substitutionLinkTypes.js +2 -0
- package/dist/types/taskListTypes.d.ts +67 -0
- package/dist/types/taskListTypes.d.ts.map +1 -0
- package/dist/types/taskListTypes.js +2 -0
- package/dist/types/taskNoteTypes.d.ts +42 -0
- package/dist/types/taskNoteTypes.d.ts.map +1 -0
- package/dist/types/taskNoteTypes.js +2 -0
- package/dist/types/taskTypes.d.ts +153 -0
- package/dist/types/taskTypes.d.ts.map +1 -0
- package/dist/types/taskTypes.js +2 -0
- package/dist/types/toothInitialTypes.d.ts +44 -0
- package/dist/types/toothInitialTypes.d.ts.map +1 -0
- package/dist/types/toothInitialTypes.js +2 -0
- package/dist/types/treatPlanAttachTypes.d.ts +3 -0
- package/dist/types/treatPlanAttachTypes.d.ts.map +1 -1
- package/dist/types/treatPlanTypes.d.ts +4 -0
- package/dist/types/treatPlanTypes.d.ts.map +1 -1
- package/dist/types/userGroupAttachTypes.d.ts +22 -0
- package/dist/types/userGroupAttachTypes.d.ts.map +1 -0
- package/dist/types/userGroupAttachTypes.js +2 -0
- package/dist/types/userGroupTypes.d.ts +21 -0
- package/dist/types/userGroupTypes.d.ts.map +1 -0
- package/dist/types/userGroupTypes.js +2 -0
- package/dist/types/userODTypes.d.ts +97 -0
- package/dist/types/userODTypes.d.ts.map +1 -0
- package/dist/types/userODTypes.js +2 -0
- package/dist/utils/errorHandler.d.ts +5 -0
- package/dist/utils/errorHandler.d.ts.map +1 -1
- package/dist/utils/errorHandler.js +11 -0
- package/dist/utils/httpClient.d.ts +24 -6
- package/dist/utils/httpClient.d.ts.map +1 -1
- package/dist/utils/httpClient.js +28 -24
- package/docs/Open Dental 2026-04-22/api-url-list.md +110 -0
- package/docs/Open Dental 2026-04-22/apiaccountmodules.md +116 -0
- package/docs/Open Dental 2026-04-22/apiadjustments.md +133 -0
- package/docs/Open Dental 2026-04-22/apiallergies.md +132 -0
- package/docs/Open Dental 2026-04-22/apiallergydefs.md +74 -0
- package/docs/Open Dental 2026-04-22/apiappointments.md +510 -0
- package/docs/Open Dental 2026-04-22/apiappointmenttypes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiapptfielddefs.md +130 -0
- package/docs/Open Dental 2026-04-22/apiapptfields.md +147 -0
- package/docs/Open Dental 2026-04-22/apiasapcomms.md +141 -0
- package/docs/Open Dental 2026-04-22/apiautonotecontrols.md +111 -0
- package/docs/Open Dental 2026-04-22/apiautonotes.md +103 -0
- package/docs/Open Dental 2026-04-22/apibenefits.md +515 -0
- package/docs/Open Dental 2026-04-22/apicarriers.md +150 -0
- package/docs/Open Dental 2026-04-22/apichartmodules.md +135 -0
- package/docs/Open Dental 2026-04-22/apiclaimpayments.md +206 -0
- package/docs/Open Dental 2026-04-22/apiclaimprocs.md +256 -0
- package/docs/Open Dental 2026-04-22/apiclaims.md +339 -0
- package/docs/Open Dental 2026-04-22/apiclaimtrackings.md +110 -0
- package/docs/Open Dental 2026-04-22/apiclinics.md +95 -0
- package/docs/Open Dental 2026-04-22/apiclockevents.md +98 -0
- package/docs/Open Dental 2026-04-22/apicodegroups.md +140 -0
- package/docs/Open Dental 2026-04-22/apicommlogs.md +161 -0
- package/docs/Open Dental 2026-04-22/apicomputers.md +39 -0
- package/docs/Open Dental 2026-04-22/apicovcats.md +139 -0
- package/docs/Open Dental 2026-04-22/apicovspans.md +140 -0
- package/docs/Open Dental 2026-04-22/apidefinitions.md +90 -0
- package/docs/Open Dental 2026-04-22/apidiscountplans.md +154 -0
- package/docs/Open Dental 2026-04-22/apidiscountplansubs.md +125 -0
- package/docs/Open Dental 2026-04-22/apidiseasedefs.md +88 -0
- package/docs/Open Dental 2026-04-22/apidiseases.md +168 -0
- package/docs/Open Dental 2026-04-22/apidocuments.md +319 -0
- package/docs/Open Dental 2026-04-22/apiehrpatients.md +87 -0
- package/docs/Open Dental 2026-04-22/apiemployees.md +145 -0
- package/docs/Open Dental 2026-04-22/apiemployers.md +129 -0
- package/docs/Open Dental 2026-04-22/apieobattaches.md +132 -0
- package/docs/Open Dental 2026-04-22/apietrans.md +44 -0
- package/docs/Open Dental 2026-04-22/apietransmessagetexts.md +56 -0
- package/docs/Open Dental 2026-04-22/apietranss.md +79 -0
- package/docs/Open Dental 2026-04-22/apievents.md +96 -0
- package/docs/Open Dental 2026-04-22/apifamilymodules.md +108 -0
- package/docs/Open Dental 2026-04-22/apifees.md +146 -0
- package/docs/Open Dental 2026-04-22/apifeescheds.md +116 -0
- package/docs/Open Dental 2026-04-22/apihistappointments.md +121 -0
- package/docs/Open Dental 2026-04-22/apiimplementation.md +128 -0
- package/docs/Open Dental 2026-04-22/apiinsplans.md +236 -0
- package/docs/Open Dental 2026-04-22/apiinssubs.md +171 -0
- package/docs/Open Dental 2026-04-22/apiinsverifies.md +123 -0
- package/docs/Open Dental 2026-04-22/apilabcases.md +174 -0
- package/docs/Open Dental 2026-04-22/apilaboratories.md +147 -0
- package/docs/Open Dental 2026-04-22/apilabturnarounds.md +128 -0
- package/docs/Open Dental 2026-04-22/apimedicationpats.md +170 -0
- package/docs/Open Dental 2026-04-22/apimedications.md +74 -0
- package/docs/Open Dental 2026-04-22/apioperatories.md +78 -0
- package/docs/Open Dental 2026-04-22/apipatfielddefs.md +139 -0
- package/docs/Open Dental 2026-04-22/apipatfields.md +166 -0
- package/docs/Open Dental 2026-04-22/apipatientnotes.md +102 -0
- package/docs/Open Dental 2026-04-22/apipatientraces.md +51 -0
- package/docs/Open Dental 2026-04-22/apipatients.md +346 -0
- package/docs/Open Dental 2026-04-22/apipatplans.md +147 -0
- package/docs/Open Dental 2026-04-22/apipayments.md +236 -0
- package/docs/Open Dental 2026-04-22/apipayplancharges.md +59 -0
- package/docs/Open Dental 2026-04-22/apipayplans.md +256 -0
- package/docs/Open Dental 2026-04-22/apipaysplits.md +112 -0
- package/docs/Open Dental 2026-04-22/apiperioexams.md +155 -0
- package/docs/Open Dental 2026-04-22/apiperiomeasures.md +162 -0
- package/docs/Open Dental 2026-04-22/apipharmacies.md +78 -0
- package/docs/Open Dental 2026-04-22/apipopups.md +127 -0
- package/docs/Open Dental 2026-04-22/apipreferences.md +47 -0
- package/docs/Open Dental 2026-04-22/apiprocedurecodes.md +260 -0
- package/docs/Open Dental 2026-04-22/apiprocedurelogs.md +477 -0
- package/docs/Open Dental 2026-04-22/apiprocnotes.md +86 -0
- package/docs/Open Dental 2026-04-22/apiproctps.md +141 -0
- package/docs/Open Dental 2026-04-22/apiproviders.md +189 -0
- package/docs/Open Dental 2026-04-22/apiqueries.md +74 -0
- package/docs/Open Dental 2026-04-22/apiquickpastecats.md +130 -0
- package/docs/Open Dental 2026-04-22/apiquickpastenotes.md +75 -0
- package/docs/Open Dental 2026-04-22/apirecalls.md +239 -0
- package/docs/Open Dental 2026-04-22/apirecalltypes.md +65 -0
- package/docs/Open Dental 2026-04-22/apirefattaches.md +179 -0
- package/docs/Open Dental 2026-04-22/apireferrals.md +198 -0
- package/docs/Open Dental 2026-04-22/apireports.md +85 -0
- package/docs/Open Dental 2026-04-22/apirxpats.md +113 -0
- package/docs/Open Dental 2026-04-22/apischeduleops.md +58 -0
- package/docs/Open Dental 2026-04-22/apischedules.md +106 -0
- package/docs/Open Dental 2026-04-22/apisecurity.md +53 -0
- package/docs/Open Dental 2026-04-22/apisecuritylogs.md +59 -0
- package/docs/Open Dental 2026-04-22/apisheetdefs.md +118 -0
- package/docs/Open Dental 2026-04-22/apisheetfields.md +140 -0
- package/docs/Open Dental 2026-04-22/apisheets.md +156 -0
- package/docs/Open Dental 2026-04-22/apisignalods.md +118 -0
- package/docs/Open Dental 2026-04-22/apispecification.md +47 -0
- package/docs/Open Dental 2026-04-22/apistatements.md +160 -0
- package/docs/Open Dental 2026-04-22/apisubscriptions.md +133 -0
- package/docs/Open Dental 2026-04-22/apisubstitutionlinks.md +143 -0
- package/docs/Open Dental 2026-04-22/apitasklists.md +89 -0
- package/docs/Open Dental 2026-04-22/apitasknotes.md +130 -0
- package/docs/Open Dental 2026-04-22/apitasks.md +192 -0
- package/docs/Open Dental 2026-04-22/apitoothinitials.md +119 -0
- package/docs/Open Dental 2026-04-22/apitreatplanattaches.md +111 -0
- package/docs/Open Dental 2026-04-22/apitreatplans.md +201 -0
- package/docs/Open Dental 2026-04-22/apiusergroupattaches.md +57 -0
- package/docs/Open Dental 2026-04-22/apiusergroups.md +56 -0
- package/docs/Open Dental 2026-04-22/apiuserods.md +128 -0
- package/docs/Open Dental 2026-04-22/context/Open Dental _ Benefits Guide.md +294 -0
- package/docs/Open Dental 2026-04-22/context/OpenDental_DB_Documentation_v26-1.xml +20118 -0
- package/docs/Open Dental 2026-04-22/context/sitemap.xml +4617 -0
- package/package.json +8 -7
- package/release.sh +3 -5
- package/tsconfig.test.json +8 -0
- package/__tests__/example.test.ts +0 -6
- package/dist/types/appoinmentTypesType.d.ts.map +0 -1
- package/src/api/accountModules.ts +0 -61
- package/src/api/adjustments.ts +0 -126
- package/src/api/allergies.ts +0 -114
- package/src/api/appointmentTypes.ts +0 -21
- package/src/api/appointments.ts +0 -343
- package/src/api/benefits.ts +0 -155
- package/src/api/chartModules.ts +0 -53
- package/src/api/claimProcs.ts +0 -117
- package/src/api/claims.ts +0 -173
- package/src/api/commlogs.ts +0 -63
- package/src/api/definitions.ts +0 -35
- package/src/api/discountPlanSubs.ts +0 -106
- package/src/api/discountPlans.ts +0 -159
- package/src/api/diseases.ts +0 -130
- package/src/api/familyModules.ts +0 -29
- package/src/api/feeScheds.ts +0 -30
- package/src/api/fees.ts +0 -43
- package/src/api/index.ts +0 -25
- package/src/api/insPlans.ts +0 -158
- package/src/api/insSubs.ts +0 -155
- package/src/api/insVerifies.ts +0 -85
- package/src/api/labCases.ts +0 -183
- package/src/api/medicationPats.ts +0 -120
- package/src/api/operatories.ts +0 -46
- package/src/api/patFields.ts +0 -112
- package/src/api/patPlans.ts +0 -113
- package/src/api/patients.ts +0 -254
- package/src/api/payPlanCharges.ts +0 -49
- package/src/api/payPlans.ts +0 -274
- package/src/api/paySplits.ts +0 -56
- package/src/api/payments.ts +0 -86
- package/src/api/procNotes.ts +0 -67
- package/src/api/procTPs.ts +0 -112
- package/src/api/procedureCodes.ts +0 -45
- package/src/api/procedureLog.ts +0 -377
- package/src/api/providers.ts +0 -175
- package/src/api/queries.ts +0 -43
- package/src/api/recalls.ts +0 -148
- package/src/api/refAttaches.ts +0 -142
- package/src/api/referrals.ts +0 -222
- package/src/api/schedules.ts +0 -64
- package/src/api/securityLogs.ts +0 -32
- package/src/api/treatplanattaches.ts +0 -67
- package/src/api/treatplans.ts +0 -96
- package/src/index.ts +0 -2
- package/src/openDental.ts +0 -506
- package/src/transformerTypes/visitTypes.ts +0 -87
- package/src/transformers/index.ts +0 -4
- package/src/transformers/visit.ts +0 -83
- package/src/types/DiscountPlanTypes.ts +0 -70
- package/src/types/accountModuleTypes.ts +0 -46
- package/src/types/adjustmentTypes.ts +0 -63
- package/src/types/allergyTypes.ts +0 -48
- package/src/types/appoinmentTypesType.ts +0 -16
- package/src/types/appointmentTypes.ts +0 -256
- package/src/types/benefitTypes.ts +0 -70
- package/src/types/chartModuleTypes.ts +0 -65
- package/src/types/claimProcTypes.ts +0 -99
- package/src/types/claimTypes.ts +0 -227
- package/src/types/commlogTypes.ts +0 -28
- package/src/types/definitionTypes.ts +0 -24
- package/src/types/discountPlanSubTypes.ts +0 -45
- package/src/types/diseaseTypes.ts +0 -50
- package/src/types/familyModuleTypes.ts +0 -33
- package/src/types/feeSchedsTypes.ts +0 -38
- package/src/types/feeTypes.ts +0 -49
- package/src/types/insPlanTypes.ts +0 -72
- package/src/types/insSubTypes.ts +0 -65
- package/src/types/insVerifiesTypes.ts +0 -38
- package/src/types/labCaseTypes.ts +0 -71
- package/src/types/medicationPatTypes.ts +0 -50
- package/src/types/operatoryTypes.ts +0 -24
- package/src/types/patFieldTypes.ts +0 -24
- package/src/types/patPlanTypes.ts +0 -55
- package/src/types/patientTypes.ts +0 -236
- package/src/types/payPlanChargeTypes.ts +0 -77
- package/src/types/payPlanTypes.ts +0 -171
- package/src/types/paySplitTypes.ts +0 -44
- package/src/types/paymentTypes.ts +0 -69
- package/src/types/procNoteTypes.ts +0 -38
- package/src/types/procTPTypes.ts +0 -79
- package/src/types/procedureCodeTypes.ts +0 -48
- package/src/types/procedurelogTypes.ts +0 -184
- package/src/types/providerTypes.ts +0 -73
- package/src/types/queryTypes.ts +0 -17
- package/src/types/recallTypes.ts +0 -102
- package/src/types/refAttachTypes.ts +0 -63
- package/src/types/referralTypes.ts +0 -102
- package/src/types/scheduleTypes.ts +0 -32
- package/src/types/securityLogTypes.ts +0 -24
- package/src/types/treatPlanAttachTypes.ts +0 -39
- package/src/types/treatPlanTypes.ts +0 -75
- package/src/utils/errorHandler.ts +0 -0
- package/src/utils/httpClient.ts +0 -111
- package/tsconfig.json +0 -16
- /package/dist/types/{appoinmentTypesType.js → allergyDefTypes.js} +0 -0
package/dist/api/patFields.d.ts
CHANGED
|
@@ -7,19 +7,21 @@ export default class PatFields {
|
|
|
7
7
|
* Fetch a single patfield by its ID.
|
|
8
8
|
* @param {number} PatFieldNum - The ID of the patfield.
|
|
9
9
|
* @returns {Promise<PatField>} - The patfield data.
|
|
10
|
-
* @throws {Error} - If
|
|
10
|
+
* @throws {Error} - If PatFieldNum is not a valid number or the API returns an error.
|
|
11
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
11
12
|
*/
|
|
12
13
|
getPatField(PatFieldNum: number): Promise<PatField>;
|
|
13
14
|
/**
|
|
14
15
|
* Fetch multiple patfields with optional filtering and pagination.
|
|
15
16
|
* @param {Object} params - Filtering and pagination parameters.
|
|
16
|
-
* @param {
|
|
17
|
-
* @param {string} [params.FieldName] - Filter by
|
|
18
|
-
* @param {string} [params.SecDateTEdit] -
|
|
17
|
+
* @param {number} [params.PatNum] - Filter by patient number.
|
|
18
|
+
* @param {string} [params.FieldName] - Filter by field name. Case sensitive.
|
|
19
|
+
* @param {string} [params.SecDateTEdit] - Return only patfields edited on or after this date. String in "yyyy-MM-dd HH:mm:ss" format.
|
|
19
20
|
* @returns {Promise<PatField[]>} - A list of patfields.
|
|
20
21
|
* @throws {Error} - If the API returns an error.
|
|
22
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
21
23
|
*/
|
|
22
|
-
getPatFields({ PatNum, FieldName, SecDateTEdit, }?: GetPatFieldsParams): Promise<PatField[]>;
|
|
24
|
+
getPatFields({ PatNum, FieldName, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPatFieldsParams): Promise<PatField[]>;
|
|
23
25
|
/**
|
|
24
26
|
* Creates a patfield. Cannot create PatFields associated with hidden PatFieldDefs.
|
|
25
27
|
* @param {Object} data - The data for the new patfield.
|
|
@@ -28,6 +30,7 @@ export default class PatFields {
|
|
|
28
30
|
* @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
|
|
29
31
|
* @returns {Promise<PatField>} - The created PatField.
|
|
30
32
|
* @throws {Error} - If the data is invalid or the API returns an error.
|
|
33
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
31
34
|
*/
|
|
32
35
|
createPatField({ PatNum, FieldName, FieldValue, }: AddUpdatePatFieldParams): Promise<PatField>;
|
|
33
36
|
/**
|
|
@@ -38,13 +41,15 @@ export default class PatFields {
|
|
|
38
41
|
* @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
|
|
39
42
|
* @returns {Promise<PatField>} - The updated PatField.
|
|
40
43
|
* @throws {Error} - If the data is invalid or the API returns an error.
|
|
44
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
41
45
|
*/
|
|
42
46
|
editPatField({ PatNum, FieldName, FieldValue, }: AddUpdatePatFieldParams): Promise<PatField>;
|
|
43
47
|
/**
|
|
44
48
|
* Delete a single patfield by its ID.
|
|
45
49
|
* @param {number} PatFieldNum - The ID of the patField.
|
|
46
50
|
* @returns {Promise<{ status: number }>} - The API response containing the status code.
|
|
47
|
-
* @throws {Error} - If
|
|
51
|
+
* @throws {Error} - If PatFieldNum is not a valid number or the API returns an error.
|
|
52
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
48
53
|
*/
|
|
49
54
|
deletePatField(PatFieldNum: number): Promise<{
|
|
50
55
|
status: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"patFields.d.ts","sourceRoot":"","sources":["../../src/api/patFields.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,QAAQ,EACR,kBAAkB,EAClB,uBAAuB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"patFields.d.ts","sourceRoot":"","sources":["../../src/api/patFields.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACH,QAAQ,EACR,kBAAkB,EAClB,uBAAuB,EAC1B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;OAMG;IACU,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQhE;;;;;;;;;OASG;IACY,YAAY,CAAC,EACxB,MAAM,EACN,SAAS,EACT,YAAY,EACZ,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACzB,GAAE,kBAAuB,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAc5C;;;;;;;;;OASG;IACU,cAAc,CAAC,EACxB,MAAM,EACN,SAAS,EACT,UAAU,GACX,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWhD;;;;;;;;;OASG;IACU,YAAY,CAAC,EACtB,MAAM,EACN,SAAS,EACT,UAAU,GACX,EAAE,uBAAuB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWhD;;;;;;OAMG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAOhF"}
|
package/dist/api/patFields.js
CHANGED
|
@@ -9,28 +9,34 @@ class PatFields {
|
|
|
9
9
|
* Fetch a single patfield by its ID.
|
|
10
10
|
* @param {number} PatFieldNum - The ID of the patfield.
|
|
11
11
|
* @returns {Promise<PatField>} - The patfield data.
|
|
12
|
-
* @throws {Error} - If
|
|
12
|
+
* @throws {Error} - If PatFieldNum is not a valid number or the API returns an error.
|
|
13
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
13
14
|
*/
|
|
14
15
|
async getPatField(PatFieldNum) {
|
|
15
16
|
if (!PatFieldNum || typeof PatFieldNum !== "number") {
|
|
16
|
-
throw new Error("Invalid parameter:
|
|
17
|
+
throw new Error("Invalid parameter: PatFieldNum must be a valid number.");
|
|
17
18
|
}
|
|
18
|
-
return
|
|
19
|
+
return this.httpClient.get(`/patfields/${PatFieldNum}`);
|
|
19
20
|
}
|
|
20
21
|
/**
|
|
21
22
|
* Fetch multiple patfields with optional filtering and pagination.
|
|
22
23
|
* @param {Object} params - Filtering and pagination parameters.
|
|
23
|
-
* @param {
|
|
24
|
-
* @param {string} [params.FieldName] - Filter by
|
|
25
|
-
* @param {string} [params.SecDateTEdit] -
|
|
24
|
+
* @param {number} [params.PatNum] - Filter by patient number.
|
|
25
|
+
* @param {string} [params.FieldName] - Filter by field name. Case sensitive.
|
|
26
|
+
* @param {string} [params.SecDateTEdit] - Return only patfields edited on or after this date. String in "yyyy-MM-dd HH:mm:ss" format.
|
|
26
27
|
* @returns {Promise<PatField[]>} - A list of patfields.
|
|
27
28
|
* @throws {Error} - If the API returns an error.
|
|
29
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
28
30
|
*/
|
|
29
|
-
async getPatFields({ PatNum, FieldName, SecDateTEdit, } = {}) {
|
|
30
|
-
return
|
|
31
|
+
async getPatFields({ PatNum, FieldName, SecDateTEdit, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
32
|
+
return this.httpClient.get("/patfields", {
|
|
31
33
|
PatNum,
|
|
32
34
|
FieldName,
|
|
33
35
|
SecDateTEdit,
|
|
36
|
+
Offset,
|
|
37
|
+
Limit,
|
|
38
|
+
DateFormatString,
|
|
39
|
+
DateTimeFormatString,
|
|
34
40
|
});
|
|
35
41
|
}
|
|
36
42
|
/**
|
|
@@ -41,12 +47,13 @@ class PatFields {
|
|
|
41
47
|
* @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
|
|
42
48
|
* @returns {Promise<PatField>} - The created PatField.
|
|
43
49
|
* @throws {Error} - If the data is invalid or the API returns an error.
|
|
50
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
44
51
|
*/
|
|
45
52
|
async createPatField({ PatNum, FieldName, FieldValue, }) {
|
|
46
53
|
if (!PatNum || !FieldName || !FieldValue) {
|
|
47
|
-
throw new Error("Invalid
|
|
54
|
+
throw new Error("Invalid parameter: All fields are required.");
|
|
48
55
|
}
|
|
49
|
-
return
|
|
56
|
+
return this.httpClient.post("/patfields", {
|
|
50
57
|
PatNum,
|
|
51
58
|
FieldName,
|
|
52
59
|
FieldValue,
|
|
@@ -60,12 +67,13 @@ class PatFields {
|
|
|
60
67
|
* @param {string} data.FieldValue - Required: See the top of this page for more information. Relies on PatFieldDef.FieldType.
|
|
61
68
|
* @returns {Promise<PatField>} - The updated PatField.
|
|
62
69
|
* @throws {Error} - If the data is invalid or the API returns an error.
|
|
70
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
63
71
|
*/
|
|
64
72
|
async editPatField({ PatNum, FieldName, FieldValue, }) {
|
|
65
73
|
if (!PatNum || !FieldName || !FieldValue) {
|
|
66
|
-
throw new Error("Invalid
|
|
74
|
+
throw new Error("Invalid parameter: All fields are required.");
|
|
67
75
|
}
|
|
68
|
-
return
|
|
76
|
+
return this.httpClient.put("/patfields", {
|
|
69
77
|
PatNum,
|
|
70
78
|
FieldName,
|
|
71
79
|
FieldValue,
|
|
@@ -75,13 +83,14 @@ class PatFields {
|
|
|
75
83
|
* Delete a single patfield by its ID.
|
|
76
84
|
* @param {number} PatFieldNum - The ID of the patField.
|
|
77
85
|
* @returns {Promise<{ status: number }>} - The API response containing the status code.
|
|
78
|
-
* @throws {Error} - If
|
|
86
|
+
* @throws {Error} - If PatFieldNum is not a valid number or the API returns an error.
|
|
87
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
79
88
|
*/
|
|
80
89
|
async deletePatField(PatFieldNum) {
|
|
81
90
|
if (!PatFieldNum || typeof PatFieldNum !== "number") {
|
|
82
91
|
throw new Error("Invalid parameter: PatFieldNum must be a valid number.");
|
|
83
92
|
}
|
|
84
|
-
return
|
|
93
|
+
return this.httpClient.delete(`/patfields/${PatFieldNum}`);
|
|
85
94
|
}
|
|
86
95
|
}
|
|
87
96
|
exports.default = PatFields;
|
package/dist/api/patPlans.d.ts
CHANGED
|
@@ -8,20 +8,25 @@ export default class PatPlans {
|
|
|
8
8
|
* @param {Object} params - The parameters for filtering and pagination.
|
|
9
9
|
* @param {number} [params.PatNum] - FK to patient.PatNum.
|
|
10
10
|
* @param {number} [params.InsSubNum] - FK to inssub.InsSubNum
|
|
11
|
-
|
|
11
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
12
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
13
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
14
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
12
15
|
* @returns {Promise<PatPlan[]>} - A list of patplans.
|
|
16
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
13
17
|
*/
|
|
14
|
-
getPatPlans({ PatNum, InsSubNum, Offset, }?: GetPatPlansParams): Promise<PatPlan[]>;
|
|
18
|
+
getPatPlans({ PatNum, InsSubNum, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPatPlansParams): Promise<PatPlan[]>;
|
|
15
19
|
/**
|
|
16
|
-
*
|
|
20
|
+
* Create a new patient plan, linking a patient to an insurance subscriber record.
|
|
17
21
|
* @param {Object} data - The details of the patplan to create.
|
|
18
22
|
* @param {number} data.PatNum - Required. FK of patient
|
|
19
23
|
* @param {number} data.InsSubNum - Required. This requires that a valid InsSub is already in place. You can obtain the InsSubNum from FamilyModules GET Insurance, or you can obtain it from an InsSubs POST. If this plan is already linked to this InsSub, then response will be BadRequest.
|
|
20
24
|
* @param {string} [data.Ordinal] - Optional with a default of 1. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
|
|
21
25
|
* @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
|
|
22
26
|
* @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
|
|
23
|
-
|
|
27
|
+
* @returns {Promise<PatPlan>} - The created patplan.
|
|
24
28
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
29
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
25
30
|
*/
|
|
26
31
|
createPatPlan({ PatNum, InsSubNum, Ordinal, Relationship, PatID, }: CreatePatPlanParams): Promise<PatPlan>;
|
|
27
32
|
/**
|
|
@@ -32,8 +37,9 @@ export default class PatPlans {
|
|
|
32
37
|
* @param {string} [data.Ordinal] - Optional. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
|
|
33
38
|
* @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
|
|
34
39
|
* @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
|
|
35
|
-
|
|
40
|
+
* @returns {Promise<PatPlan>} - The updated patplan.
|
|
36
41
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
42
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
37
43
|
*/
|
|
38
44
|
updatePatPlan({ PatPlanNum, InsSubNum, Ordinal, Relationship, PatID, }: UpdatePatPlanParams): Promise<PatPlan>;
|
|
39
45
|
/**
|
|
@@ -41,7 +47,8 @@ export default class PatPlans {
|
|
|
41
47
|
* This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
|
|
42
48
|
* @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
|
|
43
49
|
* @returns {Promise<void>} - Resolves when the PatPlan is deleted.
|
|
44
|
-
* @throws {Error} - If
|
|
50
|
+
* @throws {Error} - If PatPlanNum is not a valid number or the API returns an error.
|
|
51
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
45
52
|
*/
|
|
46
53
|
deletePatPlan(PatPlanNum: number): Promise<void>;
|
|
47
54
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"patPlans.d.ts","sourceRoot":"","sources":["../../src/api/patPlans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"patPlans.d.ts","sourceRoot":"","sources":["../../src/api/patPlans.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;QAWI;IACS,WAAW,CAAC,EACvB,MAAM,EACN,SAAS,EACT,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAc5C;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,EACzB,MAAM,EACN,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,GACN,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAc1C;;;;;;;;;;;OAWG;IACU,aAAa,CAAC,EACzB,UAAU,EACV,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,GACN,EAAG,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAa1C;;;;;;;OAOG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO9D"}
|
package/dist/api/patPlans.js
CHANGED
|
@@ -10,31 +10,39 @@ class PatPlans {
|
|
|
10
10
|
* @param {Object} params - The parameters for filtering and pagination.
|
|
11
11
|
* @param {number} [params.PatNum] - FK to patient.PatNum.
|
|
12
12
|
* @param {number} [params.InsSubNum] - FK to inssub.InsSubNum
|
|
13
|
-
|
|
13
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
14
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
15
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
16
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
14
17
|
* @returns {Promise<PatPlan[]>} - A list of patplans.
|
|
18
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
15
19
|
*/
|
|
16
|
-
async getPatPlans({ PatNum, InsSubNum, Offset, } = {}) {
|
|
20
|
+
async getPatPlans({ PatNum, InsSubNum, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
17
21
|
const params = {
|
|
18
22
|
PatNum,
|
|
19
23
|
InsSubNum,
|
|
20
24
|
Offset,
|
|
25
|
+
Limit,
|
|
26
|
+
DateFormatString,
|
|
27
|
+
DateTimeFormatString,
|
|
21
28
|
};
|
|
22
29
|
return this.httpClient.get("/patplans", params);
|
|
23
30
|
}
|
|
24
31
|
/**
|
|
25
|
-
*
|
|
32
|
+
* Create a new patient plan, linking a patient to an insurance subscriber record.
|
|
26
33
|
* @param {Object} data - The details of the patplan to create.
|
|
27
34
|
* @param {number} data.PatNum - Required. FK of patient
|
|
28
35
|
* @param {number} data.InsSubNum - Required. This requires that a valid InsSub is already in place. You can obtain the InsSubNum from FamilyModules GET Insurance, or you can obtain it from an InsSubs POST. If this plan is already linked to this InsSub, then response will be BadRequest.
|
|
29
36
|
* @param {string} [data.Ordinal] - Optional with a default of 1. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
|
|
30
37
|
* @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
|
|
31
38
|
* @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
|
|
32
|
-
|
|
39
|
+
* @returns {Promise<PatPlan>} - The created patplan.
|
|
33
40
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
41
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
34
42
|
*/
|
|
35
43
|
async createPatPlan({ PatNum, InsSubNum, Ordinal, Relationship, PatID, }) {
|
|
36
44
|
if (!PatNum || !InsSubNum) {
|
|
37
|
-
throw new Error("Invalid
|
|
45
|
+
throw new Error("Invalid parameter: PatNum and InsSubNum are required.");
|
|
38
46
|
}
|
|
39
47
|
return this.httpClient.post("/patplans", {
|
|
40
48
|
PatNum,
|
|
@@ -52,12 +60,13 @@ class PatPlans {
|
|
|
52
60
|
* @param {string} [data.Ordinal] - Optional. This is a single digit numeric field (example: 1, 2, 3...). It represents the primary insurance, secondary insurance, etc. 0 is not used. If Ordinal is set to1, and there is already primary insurance, the other insurance will get bumped to Ordinal 2.
|
|
53
61
|
* @param {"Self" | "Spouse" | "Child" | "Employee" | "HandicapDep" | "SignifOther" | "InjuredPlantiff" | "LifePartner" | "Dependent"} [data.Relationship] - Optional. Default is Self. Values can be "Self", "Spouse", "Child", "Employee", "HandicapDep", "SignifOther", "InjuredPlantiff", "LifePartner" or "Dependent".
|
|
54
62
|
* @param {string} [data.PatID] - Optional. A patient ID which will override the subscriber ID on eclaims. Also used for Canada.
|
|
55
|
-
|
|
63
|
+
* @returns {Promise<PatPlan>} - The updated patplan.
|
|
56
64
|
* @throws {Error} - If required fields are missing or the API returns an error.
|
|
65
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
57
66
|
*/
|
|
58
67
|
async updatePatPlan({ PatPlanNum, InsSubNum, Ordinal, Relationship, PatID, }) {
|
|
59
68
|
if (!PatPlanNum || typeof PatPlanNum !== "number") {
|
|
60
|
-
throw new Error("Invalid
|
|
69
|
+
throw new Error("Invalid parameter: PatPlanNum must be a valid number.");
|
|
61
70
|
}
|
|
62
71
|
return this.httpClient.put(`/patplans/${PatPlanNum}`, {
|
|
63
72
|
InsSubNum,
|
|
@@ -71,7 +80,8 @@ class PatPlans {
|
|
|
71
80
|
* This is called "Drop" in the Open Dental UI. This removes a PatPlan row from the database, indicating no coverage, but does not affect the InsPlan itself.
|
|
72
81
|
* @param {number} PatPlanNum - Required: The unique identifier of the inssub to delete.
|
|
73
82
|
* @returns {Promise<void>} - Resolves when the PatPlan is deleted.
|
|
74
|
-
* @throws {Error} - If
|
|
83
|
+
* @throws {Error} - If PatPlanNum is not a valid number or the API returns an error.
|
|
84
|
+
* @see https://www.opendental.com/site/apipatplans.html
|
|
75
85
|
*/
|
|
76
86
|
async deletePatPlan(PatPlanNum) {
|
|
77
87
|
if (!PatPlanNum || typeof PatPlanNum !== "number") {
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import HttpClient from "../utils/httpClient";
|
|
2
|
+
import { PatientNote, UpdatePatientNoteParams } from "../types/patientNoteTypes";
|
|
3
|
+
export default class PatientNotes {
|
|
4
|
+
private httpClient;
|
|
5
|
+
constructor(httpClient: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a single patient note record by patient number.
|
|
8
|
+
* @param {number} PatNum - Required. FK to patient.PatNum; also the primary key of patientnote.
|
|
9
|
+
* @param {Object} [params] - Optional pagination and format parameters.
|
|
10
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
11
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
12
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
13
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
14
|
+
* @returns {Promise<PatientNote>} - The patient note record.
|
|
15
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
16
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
17
|
+
*/
|
|
18
|
+
getPatientNote(PatNum: number): Promise<PatientNote>;
|
|
19
|
+
/**
|
|
20
|
+
* Retrieves a list of all patient note records.
|
|
21
|
+
* @returns {Promise<PatientNote[]>} - A list of patient note records.
|
|
22
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
23
|
+
*/
|
|
24
|
+
getPatientNotes({ Offset, Limit, DateFormatString, DateTimeFormatString, }?: {
|
|
25
|
+
Offset?: number;
|
|
26
|
+
Limit?: number;
|
|
27
|
+
DateFormatString?: string;
|
|
28
|
+
DateTimeFormatString?: string;
|
|
29
|
+
}): Promise<PatientNote[]>;
|
|
30
|
+
/**
|
|
31
|
+
* Updates an existing patient note. Fields not provided are left unchanged.
|
|
32
|
+
* To append text rather than replace, retrieve the existing note first, concatenate, then PUT the combined value.
|
|
33
|
+
* @param {Object} data - The details of the patient note to update.
|
|
34
|
+
* @param {number} data.PatNum - Required. FK to patient.PatNum.
|
|
35
|
+
* @param {string} [data.FamFinancial] - Optional. Family financial note (v25.2.14+).
|
|
36
|
+
* @param {string} [data.Medical] - Optional. Medical history/summary (v25.2.14+).
|
|
37
|
+
* @param {string} [data.Service] - Optional. Service note (v21.4+).
|
|
38
|
+
* @param {string} [data.MedicalComp] - Optional. Complete medical history (v25.2.14+).
|
|
39
|
+
* @param {string} [data.Treatment] - Optional. Treatment/odontogram notes (v25.2.14+).
|
|
40
|
+
* @param {string} [data.ICEName] - Optional. Emergency contact name.
|
|
41
|
+
* @param {string} [data.ICEPhone] - Optional. Emergency contact phone.
|
|
42
|
+
* @returns {Promise<PatientNote>} - The updated patient note record.
|
|
43
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
44
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
45
|
+
*/
|
|
46
|
+
updatePatientNote({ PatNum, FamFinancial, Medical, Service, MedicalComp, Treatment, ICEName, ICEPhone, }: UpdatePatientNoteParams): Promise<PatientNote>;
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=patientNotes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"patientNotes.d.ts","sourceRoot":"","sources":["../../src/api/patientNotes.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,WAAW,EACX,uBAAuB,EACxB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAQjE;;;;OAIG;IACU,eAAe,CAAC,EAC3B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACrB,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAS/B;;;;;;;;;;;;;;;OAeG;IACU,iBAAiB,CAAC,EAC7B,MAAM,EACN,YAAY,EACZ,OAAO,EACP,OAAO,EACP,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GACT,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;CAelD"}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
class PatientNotes {
|
|
4
|
+
httpClient;
|
|
5
|
+
constructor(httpClient) {
|
|
6
|
+
this.httpClient = httpClient;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves a single patient note record by patient number.
|
|
10
|
+
* @param {number} PatNum - Required. FK to patient.PatNum; also the primary key of patientnote.
|
|
11
|
+
* @param {Object} [params] - Optional pagination and format parameters.
|
|
12
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
13
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
14
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
15
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
16
|
+
* @returns {Promise<PatientNote>} - The patient note record.
|
|
17
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
18
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
19
|
+
*/
|
|
20
|
+
async getPatientNote(PatNum) {
|
|
21
|
+
if (!PatNum || typeof PatNum !== "number") {
|
|
22
|
+
throw new Error("Invalid parameter: A valid PatNum is required.");
|
|
23
|
+
}
|
|
24
|
+
return this.httpClient.get(`/patientnotes/${PatNum}`);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Retrieves a list of all patient note records.
|
|
28
|
+
* @returns {Promise<PatientNote[]>} - A list of patient note records.
|
|
29
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
30
|
+
*/
|
|
31
|
+
async getPatientNotes({ Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
32
|
+
return this.httpClient.get("/patientnotes", {
|
|
33
|
+
Offset,
|
|
34
|
+
Limit,
|
|
35
|
+
DateFormatString,
|
|
36
|
+
DateTimeFormatString,
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Updates an existing patient note. Fields not provided are left unchanged.
|
|
41
|
+
* To append text rather than replace, retrieve the existing note first, concatenate, then PUT the combined value.
|
|
42
|
+
* @param {Object} data - The details of the patient note to update.
|
|
43
|
+
* @param {number} data.PatNum - Required. FK to patient.PatNum.
|
|
44
|
+
* @param {string} [data.FamFinancial] - Optional. Family financial note (v25.2.14+).
|
|
45
|
+
* @param {string} [data.Medical] - Optional. Medical history/summary (v25.2.14+).
|
|
46
|
+
* @param {string} [data.Service] - Optional. Service note (v21.4+).
|
|
47
|
+
* @param {string} [data.MedicalComp] - Optional. Complete medical history (v25.2.14+).
|
|
48
|
+
* @param {string} [data.Treatment] - Optional. Treatment/odontogram notes (v25.2.14+).
|
|
49
|
+
* @param {string} [data.ICEName] - Optional. Emergency contact name.
|
|
50
|
+
* @param {string} [data.ICEPhone] - Optional. Emergency contact phone.
|
|
51
|
+
* @returns {Promise<PatientNote>} - The updated patient note record.
|
|
52
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
53
|
+
* @see https://www.opendental.com/site/apipatientnotes.html
|
|
54
|
+
*/
|
|
55
|
+
async updatePatientNote({ PatNum, FamFinancial, Medical, Service, MedicalComp, Treatment, ICEName, ICEPhone, }) {
|
|
56
|
+
if (!PatNum || typeof PatNum !== "number") {
|
|
57
|
+
throw new Error("Invalid parameter: A valid PatNum is required.");
|
|
58
|
+
}
|
|
59
|
+
return this.httpClient.put(`/patientnotes/${PatNum}`, {
|
|
60
|
+
FamFinancial,
|
|
61
|
+
Medical,
|
|
62
|
+
Service,
|
|
63
|
+
MedicalComp,
|
|
64
|
+
Treatment,
|
|
65
|
+
ICEName,
|
|
66
|
+
ICEPhone,
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
exports.default = PatientNotes;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import HttpClient from "../utils/httpClient";
|
|
2
|
+
import { PatientRace, GetPatientRacesParams } from "../types/patientRaceTypes";
|
|
3
|
+
export default class PatientRaces {
|
|
4
|
+
private httpClient;
|
|
5
|
+
constructor(httpClient: HttpClient);
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves all race and ethnicity information for a specific patient.
|
|
8
|
+
* Requires the dental office to have Public Health enabled.
|
|
9
|
+
* @param {Object} params - The filter parameters.
|
|
10
|
+
* @param {number} params.PatNum - Required. FK to patient.PatNum.
|
|
11
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
12
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
13
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
14
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
15
|
+
* @returns {Promise<PatientRace[]>} - A list of race and ethnicity records for the patient.
|
|
16
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
17
|
+
* @see https://www.opendental.com/site/apipatientraces.html
|
|
18
|
+
*/
|
|
19
|
+
getPatientRaces({ PatNum, Limit, DateFormatString, DateTimeFormatString, }: GetPatientRacesParams): Promise<PatientRace[]>;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=patientRaces.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"patientRaces.d.ts","sourceRoot":"","sources":["../../src/api/patientRaces.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,WAAW,EACX,qBAAqB,EACtB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;;OAYG;IACU,eAAe,CAAC,EAC3B,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;CAOhD"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
class PatientRaces {
|
|
4
|
+
httpClient;
|
|
5
|
+
constructor(httpClient) {
|
|
6
|
+
this.httpClient = httpClient;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Retrieves all race and ethnicity information for a specific patient.
|
|
10
|
+
* Requires the dental office to have Public Health enabled.
|
|
11
|
+
* @param {Object} params - The filter parameters.
|
|
12
|
+
* @param {number} params.PatNum - Required. FK to patient.PatNum.
|
|
13
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
14
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
15
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
16
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
17
|
+
* @returns {Promise<PatientRace[]>} - A list of race and ethnicity records for the patient.
|
|
18
|
+
* @throws {Error} - If PatNum is not a valid number.
|
|
19
|
+
* @see https://www.opendental.com/site/apipatientraces.html
|
|
20
|
+
*/
|
|
21
|
+
async getPatientRaces({ PatNum, Limit, DateFormatString, DateTimeFormatString, }) {
|
|
22
|
+
if (!PatNum || typeof PatNum !== "number") {
|
|
23
|
+
throw new Error("Invalid parameter: A valid PatNum is required.");
|
|
24
|
+
}
|
|
25
|
+
return this.httpClient.get("/patientraces", { PatNum });
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
exports.default = PatientRaces;
|
package/dist/api/patients.d.ts
CHANGED
|
@@ -6,6 +6,9 @@ export default class Patients {
|
|
|
6
6
|
/**
|
|
7
7
|
* Fetch a single patient by their ID.
|
|
8
8
|
* @param {number} PatNum - The ID of the patient.
|
|
9
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
10
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
11
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
9
12
|
* @returns {Promise<Patient>} - The patient data.
|
|
10
13
|
* @throws {Error} - If `PatNum` is not valid or the API returns an error.
|
|
11
14
|
*/
|
|
@@ -29,14 +32,14 @@ export default class Patients {
|
|
|
29
32
|
* @param {string} [params.SubscriberId] - Filter by subscriber ID.
|
|
30
33
|
* @param {string} [params.Email] - Filter by email address.
|
|
31
34
|
* @param {string} [params.Country] - Filter by country.
|
|
32
|
-
* @param {
|
|
35
|
+
* @param {string} [params.clinicNums] - Comma-separated clinic numbers.
|
|
33
36
|
* @param {string} [params.clinicAbbr] - Filter by clinic abbreviation.
|
|
34
37
|
* @param {string} [params.invoiceNumber] - Filter by invoice number.
|
|
35
38
|
* @param {number} [params.Offset] - Pagination offset.
|
|
36
39
|
* @returns {Promise<PatientSummary[]>} - A list of summarized patient data.
|
|
37
40
|
* @throws {Error} - If the API returns an error.
|
|
38
41
|
*/
|
|
39
|
-
getPatients({ LName, FName, Phone, Address, hideInactive, City, State, SSN, ChartNumber, guarOnly, showArchived, Birthdate, SiteNum, SubscriberId, Email, Country,
|
|
42
|
+
getPatients({ LName, FName, Phone, Address, hideInactive, City, State, SSN, ChartNumber, guarOnly, showArchived, Birthdate, SiteNum, SubscriberId, Email, Country, clinicNums, clinicAbbr, invoiceNumber, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPatientsParams): Promise<PatientSummary[]>;
|
|
40
43
|
/**
|
|
41
44
|
* Fetch multiple patients with optional filtering and pagination.
|
|
42
45
|
* @param {Object} params - Filtering and pagination parameters.
|
|
@@ -55,7 +58,7 @@ export default class Patients {
|
|
|
55
58
|
* @returns {Promise<Patient[]>} - A list of summarized patient data.
|
|
56
59
|
* @throws {Error} - If the API returns an error.
|
|
57
60
|
*/
|
|
58
|
-
getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, }?: GetPatientsSimpleParams): Promise<Patient[]>;
|
|
61
|
+
getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, Limit, DateFormatString, DateTimeFormatString, }?: GetPatientsSimpleParams): Promise<Patient[]>;
|
|
59
62
|
/**
|
|
60
63
|
* Create a new patient.
|
|
61
64
|
* @param {Object} data - The data for the new patient.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"patients.d.ts","sourceRoot":"","sources":["../../src/api/patients.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"patients.d.ts","sourceRoot":"","sources":["../../src/api/patients.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;OAQG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQzD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACY,WAAW,CAAC,EACvB,KAAK,EACL,KAAK,EACL,KAAK,EACL,OAAO,EACP,YAAY,EACZ,IAAI,EACJ,KAAK,EACL,GAAG,EACH,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,aAAa,EACb,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACzB,GAAE,iBAAsB,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IA+BnD;;;;;;;;;;;;;;;;;OAiBG;IACU,iBAAiB,CAAC,EAC7B,KAAK,EACL,KAAK,EACL,SAAS,EACT,SAAS,EACT,SAAS,EACT,UAAU,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EACT,WAAW,EACX,MAAM,EACN,KAAK,EACL,gBAAgB,EAChB,oBAAoB,GACvB,GAAE,uBAA4B,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAsBlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,aAAa,CAAC,EACzB,KAAK,EACL,KAAK,EACL,GAAG,YAAY,EAChB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;IAW1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAwCE;IACY,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;CAcxF"}
|
package/dist/api/patients.js
CHANGED
|
@@ -8,6 +8,9 @@ class Patients {
|
|
|
8
8
|
/**
|
|
9
9
|
* Fetch a single patient by their ID.
|
|
10
10
|
* @param {number} PatNum - The ID of the patient.
|
|
11
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
12
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
13
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
11
14
|
* @returns {Promise<Patient>} - The patient data.
|
|
12
15
|
* @throws {Error} - If `PatNum` is not valid or the API returns an error.
|
|
13
16
|
*/
|
|
@@ -36,14 +39,14 @@ class Patients {
|
|
|
36
39
|
* @param {string} [params.SubscriberId] - Filter by subscriber ID.
|
|
37
40
|
* @param {string} [params.Email] - Filter by email address.
|
|
38
41
|
* @param {string} [params.Country] - Filter by country.
|
|
39
|
-
* @param {
|
|
42
|
+
* @param {string} [params.clinicNums] - Comma-separated clinic numbers.
|
|
40
43
|
* @param {string} [params.clinicAbbr] - Filter by clinic abbreviation.
|
|
41
44
|
* @param {string} [params.invoiceNumber] - Filter by invoice number.
|
|
42
45
|
* @param {number} [params.Offset] - Pagination offset.
|
|
43
46
|
* @returns {Promise<PatientSummary[]>} - A list of summarized patient data.
|
|
44
47
|
* @throws {Error} - If the API returns an error.
|
|
45
48
|
*/
|
|
46
|
-
async getPatients({ LName, FName, Phone, Address, hideInactive, City, State, SSN, ChartNumber, guarOnly, showArchived, Birthdate, SiteNum, SubscriberId, Email, Country,
|
|
49
|
+
async getPatients({ LName, FName, Phone, Address, hideInactive, City, State, SSN, ChartNumber, guarOnly, showArchived, Birthdate, SiteNum, SubscriberId, Email, Country, clinicNums, clinicAbbr, invoiceNumber, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
47
50
|
return await this.httpClient.get("/patients", {
|
|
48
51
|
LName,
|
|
49
52
|
FName,
|
|
@@ -61,10 +64,13 @@ class Patients {
|
|
|
61
64
|
SubscriberId,
|
|
62
65
|
Email,
|
|
63
66
|
Country,
|
|
64
|
-
|
|
67
|
+
clinicNums,
|
|
65
68
|
clinicAbbr,
|
|
66
69
|
invoiceNumber,
|
|
67
70
|
Offset,
|
|
71
|
+
Limit,
|
|
72
|
+
DateFormatString,
|
|
73
|
+
DateTimeFormatString,
|
|
68
74
|
});
|
|
69
75
|
}
|
|
70
76
|
/**
|
|
@@ -85,7 +91,7 @@ class Patients {
|
|
|
85
91
|
* @returns {Promise<Patient[]>} - A list of summarized patient data.
|
|
86
92
|
* @throws {Error} - If the API returns an error.
|
|
87
93
|
*/
|
|
88
|
-
async getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, } = {}) {
|
|
94
|
+
async getPatientsSimple({ LName, FName, Birthdate, ClinicNum, PatStatus, DateTStamp, PriProv, Gender, Position, Guarantor, SuperFamily, Offset, Limit, DateFormatString, DateTimeFormatString, } = {}) {
|
|
89
95
|
return await this.httpClient.get("/patients/Simple", {
|
|
90
96
|
LName,
|
|
91
97
|
FName,
|
|
@@ -99,6 +105,9 @@ class Patients {
|
|
|
99
105
|
Guarantor,
|
|
100
106
|
SuperFamily,
|
|
101
107
|
Offset,
|
|
108
|
+
Limit,
|
|
109
|
+
DateFormatString,
|
|
110
|
+
DateTimeFormatString,
|
|
102
111
|
});
|
|
103
112
|
}
|
|
104
113
|
/**
|
|
@@ -132,7 +141,7 @@ class Patients {
|
|
|
132
141
|
*/
|
|
133
142
|
async createPatient({ LName, FName, ...optionalData }) {
|
|
134
143
|
if (!LName || !FName) {
|
|
135
|
-
throw new Error("Invalid
|
|
144
|
+
throw new Error("Invalid parameter: LName and FName are required.");
|
|
136
145
|
}
|
|
137
146
|
return await this.httpClient.post("/patients", {
|
|
138
147
|
LName,
|
|
@@ -187,7 +196,7 @@ class Patients {
|
|
|
187
196
|
throw new Error("Invalid parameter: PatNum must be a valid number.");
|
|
188
197
|
}
|
|
189
198
|
if (!data || Object.keys(data).length === 0) {
|
|
190
|
-
throw new Error("Invalid
|
|
199
|
+
throw new Error("Invalid parameter: Update data cannot be empty.");
|
|
191
200
|
}
|
|
192
201
|
return await this.httpClient.put(`/patients/${PatNum}`, data);
|
|
193
202
|
}
|
|
@@ -10,6 +10,10 @@ export default class PayPlanCharges {
|
|
|
10
10
|
*
|
|
11
11
|
* @see https://www.opendental.com/site/apipayplancharges.html
|
|
12
12
|
* @param params - Query parameters: { PayPlanNum: number } (required)
|
|
13
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
14
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
15
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
16
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
13
17
|
*/
|
|
14
18
|
getPayPlanCharges(params: {
|
|
15
19
|
PayPlanNum: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"payPlanCharges.d.ts","sourceRoot":"","sources":["../../src/api/payPlanCharges.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAS5D,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC
|
|
1
|
+
{"version":3,"file":"payPlanCharges.d.ts","sourceRoot":"","sources":["../../src/api/payPlanCharges.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAS5D,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,UAAU,CAAa;gBAEnB,UAAU,EAAE,UAAU;IAIlC;;;;;;;;;;;OAWG;IACU,iBAAiB,CAC5B,MAAM,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAC7B,OAAO,CAAC,aAAa,EAAE,CAAC;CAoB5B"}
|
|
@@ -16,6 +16,10 @@ class PayPlanCharges {
|
|
|
16
16
|
*
|
|
17
17
|
* @see https://www.opendental.com/site/apipayplancharges.html
|
|
18
18
|
* @param params - Query parameters: { PayPlanNum: number } (required)
|
|
19
|
+
* @param {number} [params.Offset] - Pagination offset. Use with Limit for paginating large result sets.
|
|
20
|
+
* @param {number} [params.Limit] - Maximum number of results to return per request. Defaults to 1000 (the hard limit).
|
|
21
|
+
* @param {string} [params.DateFormatString] - Optional date format override (e.g. "MM/dd/yyyy"). Default: "yyyy-MM-dd". Added in version 22.2.26.
|
|
22
|
+
* @param {string} [params.DateTimeFormatString] - Optional datetime format override (e.g. "MM/dd/yyyy HH:mm:ss"). Default: "yyyy-MM-dd HH:mm:ss". Added in version 22.2.14.
|
|
19
23
|
*/
|
|
20
24
|
async getPayPlanCharges(params) {
|
|
21
25
|
// Validate required parameter
|