@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
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# API: ProcTPs
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiproctps.html
|
|
4
|
+
**DB Schema Ref:** proctp
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/proctps`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
ProcTPs are procedure copies attached to saved treatment plans. Each ProcTP references the original procedure log via `ProcNumOrig`. They are distinct from active/inactive treatment plan procedures — for those, use TreatPlanAttaches. ProcTPs can only be modified or deleted when associated with an unsigned treatment plan.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /proctps
|
|
18
|
+
|
|
19
|
+
**Version:** 22.4.17
|
|
20
|
+
**Description:** Retrieves a list of ProcTPs for a specific treatment plan.
|
|
21
|
+
|
|
22
|
+
**Query Parameters:**
|
|
23
|
+
| Name | Type | Required | Default | Description |
|
|
24
|
+
|------|------|----------|---------|-------------|
|
|
25
|
+
| TreatPlanNum | integer | Yes | — | FK to treatplan.TreatPlanNum |
|
|
26
|
+
|
|
27
|
+
**Response:** array of objects
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| ProcTPNum | integer | Primary key |
|
|
31
|
+
| TreatPlanNum | integer | FK to treatplan.TreatPlanNum |
|
|
32
|
+
| PatNum | integer | FK to patient.PatNum |
|
|
33
|
+
| ProcNumOrig | integer | FK to procedurelog.ProcNum — the original procedure this is copied from |
|
|
34
|
+
| ItemOrder | integer | Display order within the treatment plan (0-based, set at creation, cannot change) |
|
|
35
|
+
| Priority | integer | FK to definition.DefNum (DefCat=20 TxPriorities) |
|
|
36
|
+
| ToothNumTP | string | Tooth number (may be in international format) |
|
|
37
|
+
| Surf | string | Tooth surface/area |
|
|
38
|
+
| ProcCode | string | Display text only — not a foreign key |
|
|
39
|
+
| Descript | string | Description (originally from procedurecode.Descript; user can change) |
|
|
40
|
+
| FeeAmt | decimal | Fee charged to patient |
|
|
41
|
+
| PriInsAmt | decimal | Expected primary insurance amount |
|
|
42
|
+
| SecInsAmt | decimal | Expected secondary insurance amount |
|
|
43
|
+
| PatAmt | decimal | Expected patient portion |
|
|
44
|
+
| Discount | decimal | Discount amount (PPO or procedure-level) |
|
|
45
|
+
| Prognosis | string | Prognosis text from definition (user can change) |
|
|
46
|
+
| Dx | string | Diagnosis text from definition (user can change) |
|
|
47
|
+
| ProcAbbr | string | Procedure abbreviation (user can change) |
|
|
48
|
+
| SecUserNumEntry | integer | FK to userod.UserNum — user who created the row |
|
|
49
|
+
| SecDateEntry | date | Date the row was inserted |
|
|
50
|
+
| SecDateTEdit | datetime | Auto-updated by MySQL on any row change |
|
|
51
|
+
| FeeAllowed | decimal | Primary insurance allowed amount (PPO fee or out-of-network allowed) |
|
|
52
|
+
| TaxAmt | decimal | Sales tax estimate for this procedure |
|
|
53
|
+
| ProvNum | integer | FK to provider.ProvNum |
|
|
54
|
+
| DateTP | date | Treatment plan date for this procedure |
|
|
55
|
+
| ClinicNum | integer | FK to clinic.ClinicNum |
|
|
56
|
+
| CatPercUCR | decimal | UCR fee for the procedure (not user-editable) |
|
|
57
|
+
|
|
58
|
+
**Status Codes:**
|
|
59
|
+
| Code | Meaning |
|
|
60
|
+
|------|---------|
|
|
61
|
+
| 200 | OK |
|
|
62
|
+
| 400 | BadRequest |
|
|
63
|
+
| 404 | NotFound |
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### PUT /proctps/{ProcTPNum}
|
|
68
|
+
|
|
69
|
+
**Version:** 24.4.26
|
|
70
|
+
**Description:** Updates a ProcTP. Only ProcTPs associated with an unsigned treatment plan can be updated. All body parameters are optional.
|
|
71
|
+
|
|
72
|
+
**Path Parameters:**
|
|
73
|
+
| Name | Type | Required | Description |
|
|
74
|
+
|------|------|----------|-------------|
|
|
75
|
+
| ProcTPNum | integer | Yes | Primary key of the ProcTP to update |
|
|
76
|
+
|
|
77
|
+
**Body Parameters:**
|
|
78
|
+
| Name | Type | Required | Description |
|
|
79
|
+
|------|------|----------|-------------|
|
|
80
|
+
| Priority | integer | No | FK to definition.DefNum (DefCat=20) |
|
|
81
|
+
| ToothNumTP | string | No | Tooth number display string |
|
|
82
|
+
| Surf | string | No | Surface/area display string |
|
|
83
|
+
| ProcCode | string | No | Procedure code display text (not a FK) |
|
|
84
|
+
| Descript | string | No | Description |
|
|
85
|
+
| FeeAmt | decimal | No | Fee charged to patient |
|
|
86
|
+
| PriInsAmt | decimal | No | Expected primary insurance amount |
|
|
87
|
+
| SecInsAmt | decimal | No | Expected secondary insurance amount |
|
|
88
|
+
| PatAmt | decimal | No | Expected patient portion |
|
|
89
|
+
| Discount | decimal | No | Discount amount |
|
|
90
|
+
| Prognosis | string | No | Prognosis text |
|
|
91
|
+
| Dx | string | No | Diagnosis text |
|
|
92
|
+
| ProcAbbr | string | No | Procedure abbreviation |
|
|
93
|
+
| FeeAllowed | decimal | No | Primary insurance allowed amount |
|
|
94
|
+
|
|
95
|
+
**Response:** object — updated ProcTP with all fields listed in GET response
|
|
96
|
+
|
|
97
|
+
**Status Codes:**
|
|
98
|
+
| Code | Meaning |
|
|
99
|
+
|------|---------|
|
|
100
|
+
| 200 | OK |
|
|
101
|
+
| 400 | BadRequest |
|
|
102
|
+
| 404 | NotFound |
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
### DELETE /proctps/{ProcTPNum}
|
|
107
|
+
|
|
108
|
+
**Version:** 23.3.10
|
|
109
|
+
**Description:** Removes a ProcTP. Only ProcTPs associated with an unsigned treatment plan can be deleted.
|
|
110
|
+
|
|
111
|
+
**Path Parameters:**
|
|
112
|
+
| Name | Type | Required | Description |
|
|
113
|
+
|------|------|----------|-------------|
|
|
114
|
+
| ProcTPNum | integer | Yes | Primary key of the ProcTP to delete |
|
|
115
|
+
|
|
116
|
+
**Status Codes:**
|
|
117
|
+
| Code | Meaning |
|
|
118
|
+
|------|---------|
|
|
119
|
+
| 200 | OK |
|
|
120
|
+
| 400 | BadRequest |
|
|
121
|
+
| 404 | NotFound |
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Implementation Notes
|
|
126
|
+
- ProcTP records are copies of procedures; `ProcCode`, `Descript`, `Prognosis`, `Dx`, and `ProcAbbr` are display text only and not foreign keys — they can be freely edited.
|
|
127
|
+
- `ProcNumOrig` (FK to procedurelog.ProcNum) is used to check that the referenced procedure still exists and has status TP.
|
|
128
|
+
- `ItemOrder` is set at creation and cannot be changed; it determines display order within the treatment plan.
|
|
129
|
+
- Both PUT and DELETE require the associated treatment plan to be unsigned.
|
|
130
|
+
- `FeeAmt`, `PriInsAmt`, `SecInsAmt`, `PatAmt`, and `FeeAllowed` are never automatically updated after the ProcTP is created.
|
|
131
|
+
- For active/inactive treatment plan procedures, use TreatPlanAttaches instead of ProcTPs.
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## Related Resources
|
|
136
|
+
| Resource | Purpose |
|
|
137
|
+
|----------|---------|
|
|
138
|
+
| /treatplans | Lookup for TreatPlanNum |
|
|
139
|
+
| /procedurelogs | Referenced by ProcNumOrig |
|
|
140
|
+
| /providers | Lookup for ProvNum |
|
|
141
|
+
| /definitions | Lookup for Priority (DefCat=20) |
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
# API: Providers
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiproviders.html
|
|
4
|
+
**DB Schema Ref:** provider
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/providers`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
Providers represent dentists, hygienists, dental students, billing entities, or dummy providers used for billing and scheduling. There is no limit to the number of providers; however, once added a provider cannot be deleted even from within Open Dental — use `IsHidden` to hide inactive providers.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /providers/{ProvNum}
|
|
18
|
+
|
|
19
|
+
**Version:** 24.4.17
|
|
20
|
+
**Description:** Retrieves a single provider by primary key.
|
|
21
|
+
|
|
22
|
+
**Path Parameters:**
|
|
23
|
+
| Name | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| ProvNum | integer | Yes | Primary key of the provider |
|
|
26
|
+
|
|
27
|
+
**Response:** object
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| ProvNum | integer | Primary key |
|
|
31
|
+
| Abbr | string | Abbreviation shown in Open Dental lists (human-readable PK); varchar(255) |
|
|
32
|
+
| LName | string | Last name or billing entity name; varchar(100) |
|
|
33
|
+
| FName | string | First name; varchar(100) |
|
|
34
|
+
| MI | string | Middle initial or name; varchar(100) |
|
|
35
|
+
| Suffix | string | Credential suffix (e.g., DMD, DDS); varchar(100) |
|
|
36
|
+
| FeeSched | integer | FK to feesched.FeeSchedNum |
|
|
37
|
+
| Specialty | integer | FK to definition.DefNum (category=35) |
|
|
38
|
+
| SSN | string | SSN or TIN without dashes; varchar(12) |
|
|
39
|
+
| StateLicense | string | State license number (deprecated in DB); varchar(15) |
|
|
40
|
+
| IsSecondary | boolean | True if hygienist |
|
|
41
|
+
| provColor | string | RGB color value for appointment display |
|
|
42
|
+
| IsHidden | boolean | If true, provider does not appear in lists; does not affect scheduled appointments |
|
|
43
|
+
| UsingTIN | boolean | True if SSN field stores a Tax ID Number |
|
|
44
|
+
| SigOnFile | boolean | Signature on file status |
|
|
45
|
+
| NationalProvID | string | US NPI or Canadian UIN/CDA provider number; varchar(255) |
|
|
46
|
+
| DateTStamp | datetime | Last modification timestamp |
|
|
47
|
+
| IsNotPerson | boolean | True if billing entity or organization (not a person) |
|
|
48
|
+
| ProvStatus | string | "Active" or "Deleted" |
|
|
49
|
+
| IsHiddenReport | boolean | If true, excluded from standard report combo boxes |
|
|
50
|
+
| Birthdate | date | Date of birth (yyyy-MM-dd) |
|
|
51
|
+
| SchedNote | string | Scheduling instructions |
|
|
52
|
+
| PreferredName | string | Name displayed in eClipboard |
|
|
53
|
+
| serverDateTime | datetime | Current server datetime |
|
|
54
|
+
|
|
55
|
+
**Status Codes:**
|
|
56
|
+
| Code | Meaning |
|
|
57
|
+
|------|---------|
|
|
58
|
+
| 200 | OK |
|
|
59
|
+
| 404 | NotFound (with explanation) |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### GET /providers
|
|
64
|
+
|
|
65
|
+
**Version:** 21.1
|
|
66
|
+
**Description:** Retrieves all providers with optional filtering. Note: `serverDateTime` is not returned when filtering by `ClinicNum`.
|
|
67
|
+
|
|
68
|
+
**Query Parameters:**
|
|
69
|
+
| Name | Type | Required | Default | Description |
|
|
70
|
+
|------|------|----------|---------|-------------|
|
|
71
|
+
| ClinicNum | integer | No | — | Filter by clinic; returns non-hidden providers assigned to clinic or unrestricted |
|
|
72
|
+
| DateTStamp | string | No | — | "yyyy-MM-dd HH:mm:ss"; returns providers modified after this timestamp (added v21.3) |
|
|
73
|
+
|
|
74
|
+
**Response:** array of objects — same fields as single GET
|
|
75
|
+
|
|
76
|
+
**Status Codes:**
|
|
77
|
+
| Code | Meaning |
|
|
78
|
+
|------|---------|
|
|
79
|
+
| 200 | OK |
|
|
80
|
+
| 400 | BadRequest — "DateTStamp format must be yyyy-MM-dd HH:mm:ss" |
|
|
81
|
+
| 404 | NotFound — "Clinic not found" |
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
### POST /providers
|
|
86
|
+
|
|
87
|
+
**Version:** 21.4
|
|
88
|
+
**Description:** Creates a new provider, billing entity, or dummy provider.
|
|
89
|
+
|
|
90
|
+
**Body Parameters:**
|
|
91
|
+
| Name | Type | Required | Description |
|
|
92
|
+
|------|------|----------|-------------|
|
|
93
|
+
| Abbr | string | Yes | Short abbreviation (max 255 chars) |
|
|
94
|
+
| LName | string | No | Last name or billing entity name |
|
|
95
|
+
| FName | string | No | First name; omit if IsNotPerson=true |
|
|
96
|
+
| MI | string | No | Middle initial; omit if IsNotPerson=true |
|
|
97
|
+
| Suffix | string | No | Credential suffix |
|
|
98
|
+
| FeeSched | integer | No | FK to feesched.FeeSchedNum; defaults to first in list |
|
|
99
|
+
| Specialty | integer | No | FK to definition.DefNum (category=35); defaults to first in list |
|
|
100
|
+
| SSN | string | No | SSN or TIN without dashes |
|
|
101
|
+
| StateLicense | string | No | State license number (added v24.4.31) |
|
|
102
|
+
| IsSecondary | boolean | No | Default false |
|
|
103
|
+
| IsHidden | boolean | No | Default false |
|
|
104
|
+
| UsingTIN | boolean | No | Default true |
|
|
105
|
+
| SigOnFile | boolean | No | Default "false" (added v24.4.17) |
|
|
106
|
+
| NationalProvID | string | No | NPI or CDA provider number (added v24.4.31) |
|
|
107
|
+
| IsNotPerson | boolean | No | For billing entities; omit FName and MI when true; default false |
|
|
108
|
+
| IsHiddenReport | boolean | No | Default false |
|
|
109
|
+
| BirthDate | date | No | Format yyyy-MM-dd |
|
|
110
|
+
| SchedNote | string | No | Scheduling instructions |
|
|
111
|
+
| PreferredName | string | No | Name for eClipboard display |
|
|
112
|
+
|
|
113
|
+
**Response:** object — provider with all fields (see GET response)
|
|
114
|
+
|
|
115
|
+
**Status Codes:**
|
|
116
|
+
| Code | Meaning |
|
|
117
|
+
|------|---------|
|
|
118
|
+
| 201 | Created |
|
|
119
|
+
| 400 | BadRequest (with explanation) |
|
|
120
|
+
| 404 | NotFound (with explanation) |
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
### PUT /providers/{ProvNum}
|
|
125
|
+
|
|
126
|
+
**Version:** 22.1
|
|
127
|
+
**Description:** Updates provider information. All body parameters are optional.
|
|
128
|
+
|
|
129
|
+
**Path Parameters:**
|
|
130
|
+
| Name | Type | Required | Description |
|
|
131
|
+
|------|------|----------|-------------|
|
|
132
|
+
| ProvNum | integer | Yes | Primary key of the provider to update |
|
|
133
|
+
|
|
134
|
+
**Body Parameters:**
|
|
135
|
+
| Name | Type | Required | Description |
|
|
136
|
+
|------|------|----------|-------------|
|
|
137
|
+
| Abbr | string | No | Cannot be blank |
|
|
138
|
+
| FName | string | No | First name |
|
|
139
|
+
| LName | string | No | Last name |
|
|
140
|
+
| MI | string | No | Middle initial |
|
|
141
|
+
| Suffix | string | No | Credential suffix |
|
|
142
|
+
| PreferredName | string | No | eClipboard display name |
|
|
143
|
+
| Specialty | integer | No | FK to definition.DefNum (category=35) |
|
|
144
|
+
| SigOnFile | boolean | No | "true" or "false" (added v24.4.17) |
|
|
145
|
+
| NationalProvId | string | No | NPI or CDA number |
|
|
146
|
+
| StateLicense | string | No | State license number |
|
|
147
|
+
| SSN | string | No | SSN or TIN without dashes |
|
|
148
|
+
| UsingTIN | string | No | "true" or "false" |
|
|
149
|
+
|
|
150
|
+
**Response:** object — updated provider with all fields
|
|
151
|
+
|
|
152
|
+
**Status Codes:**
|
|
153
|
+
| Code | Meaning |
|
|
154
|
+
|------|---------|
|
|
155
|
+
| 200 | OK |
|
|
156
|
+
| 400 | BadRequest (with explanation) |
|
|
157
|
+
| 404 | NotFound (with explanation) |
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Field Reference
|
|
162
|
+
|
|
163
|
+
### ProvStatus (enum: ProviderStatus)
|
|
164
|
+
| Value | DB Int | Description |
|
|
165
|
+
|-------|--------|-------------|
|
|
166
|
+
| Active | 0 | Active provider |
|
|
167
|
+
| Deleted | 1 | Deleted provider |
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
## Implementation Notes
|
|
172
|
+
- Providers cannot be deleted via the API or from within Open Dental; use `IsHidden = true` to hide inactive providers.
|
|
173
|
+
- `IsHidden` removes the provider from all lists but does not affect already-scheduled appointments; hidden providers cannot access eRx.
|
|
174
|
+
- `IsHiddenReport` excludes the provider from standard report combo boxes, but their data is still included when running reports for "All" providers.
|
|
175
|
+
- `IsNotPerson` should be true for billing entities and organizations; omit `FName` and `MI` when using this flag.
|
|
176
|
+
- `SSN` and `UsingTIN` are related: set `UsingTIN = true` when the SSN field contains a Tax ID Number. No dashes in either case.
|
|
177
|
+
- `Abbr` is the human-readable identifier for providers; it cannot be blank on PUT.
|
|
178
|
+
- Use `DateTStamp` query parameter on GET /providers for synchronization workflows; use the returned `serverDateTime` as the next sync reference point.
|
|
179
|
+
- `ClinicNum` filter on GET returns non-hidden providers assigned to the clinic or unrestricted providers; `serverDateTime` is not returned in this case.
|
|
180
|
+
- `StateLicense` is deprecated in the DB but still exposed via the API.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Related Resources
|
|
185
|
+
| Resource | Purpose |
|
|
186
|
+
|----------|---------|
|
|
187
|
+
| /definitions | Lookup for Specialty (DefCat=35) |
|
|
188
|
+
| /feeschedules | Lookup for FeeSched |
|
|
189
|
+
| /clinics | Filter providers by ClinicNum |
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# API: Queries
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiqueries.html
|
|
4
|
+
**Extracted:** 2026-04-22
|
|
5
|
+
**Base Path:** `/queries`
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
The Queries endpoints allow execution of custom read-only SQL statements against the Open Dental database. Results can be delivered to an SFTP location as CSV (POST /queries) or returned inline as JSON with a row limit (PUT /queries/ShortQuery). All queries are screened for read-only access; any command that would modify the database is rejected.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Endpoints
|
|
15
|
+
|
|
16
|
+
### POST /queries
|
|
17
|
+
|
|
18
|
+
**Version:** 21.1
|
|
19
|
+
**Description:** Executes a read-only SQL query and saves results to an SFTP location as a CSV file. When `IsAsync = true`, the response returns after query completion but before file transfer completes.
|
|
20
|
+
|
|
21
|
+
**Body Parameters:**
|
|
22
|
+
| Name | Type | Required | Description |
|
|
23
|
+
|------|------|----------|-------------|
|
|
24
|
+
| SqlCommand | string | Yes | The SQL query to execute |
|
|
25
|
+
| SftpAddress | string | Yes | Full file path using forward slashes |
|
|
26
|
+
| SftpUsername | string | Yes | SFTP credentials username |
|
|
27
|
+
| SftpPassword | string | Yes | SFTP credentials password |
|
|
28
|
+
| SftpPort | integer | No | SFTP port; default 22 |
|
|
29
|
+
| IsAsync | boolean | No (v23.3.26+) | "true" returns response after query completes, before file transfer completes; default "false" |
|
|
30
|
+
|
|
31
|
+
**Response:** Empty file with "OK" if no results; otherwise a comma-delimited CSV file at the SFTP path
|
|
32
|
+
|
|
33
|
+
**Status Codes:**
|
|
34
|
+
| Code | Meaning |
|
|
35
|
+
|------|---------|
|
|
36
|
+
| 201 | Created — success |
|
|
37
|
+
| 400 | BadRequest — SQL syntax error or SFTP connection error |
|
|
38
|
+
| 401 | Unauthorized — query is not read-only or attempts to execute on temporary tables improperly |
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
### PUT /queries/ShortQuery
|
|
43
|
+
|
|
44
|
+
**Version:** 21.2
|
|
45
|
+
**Description:** Executes a read-only SQL query and returns up to 100 rows as a JSON data table.
|
|
46
|
+
|
|
47
|
+
**Query Parameters:**
|
|
48
|
+
| Name | Type | Required | Default | Description |
|
|
49
|
+
|------|------|----------|---------|-------------|
|
|
50
|
+
| Offset | integer | No | 0 | Pagination offset |
|
|
51
|
+
|
|
52
|
+
**Body Parameters:**
|
|
53
|
+
| Name | Type | Required | Description |
|
|
54
|
+
|------|------|----------|-------------|
|
|
55
|
+
| SqlCommand | string | Yes | The SQL query to execute |
|
|
56
|
+
|
|
57
|
+
**Response:** JSON array of result row objects (max 100 rows per page)
|
|
58
|
+
|
|
59
|
+
**Status Codes:**
|
|
60
|
+
| Code | Meaning |
|
|
61
|
+
|------|---------|
|
|
62
|
+
| 200 | OK — JSON array of result objects |
|
|
63
|
+
| 400 | BadRequest — SQL syntax error |
|
|
64
|
+
| 401 | Unauthorized — query is not read-only or improperly uses temporary tables |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Implementation Notes
|
|
69
|
+
- All queries are screened for read-only access; any command that would modify the database will not be executed.
|
|
70
|
+
- Temporary tables are permitted within queries.
|
|
71
|
+
- Do not include null byte escape sequences (`\0`, `\\0`) in SQL; use `CHAR(0)` instead if null byte filtering is needed.
|
|
72
|
+
- `PUT /queries/ShortQuery` returns a maximum of 100 rows; use `Offset` for pagination.
|
|
73
|
+
- `POST /queries` with `IsAsync = true` (added v23.3.26) returns before the SFTP file transfer completes — useful for long queries where the caller does not need to wait for the file write.
|
|
74
|
+
- SFTP paths must use forward slashes.
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# API: QuickPasteCats
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiquickpastecats.html
|
|
4
|
+
**DB Schema Ref:** quickpastecat
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/quickpastecats`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
QuickPasteCats (Quick Paste Categories) are used to organize Quick Paste Notes of a similar type. Every QuickPasteNote must belong to a category. Each category can be designated as the default for one or more note type contexts within Open Dental.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /quickpastecats/{QuickPasteCatNum}
|
|
18
|
+
|
|
19
|
+
**Version:** 22.3.26
|
|
20
|
+
**Description:** Retrieves a single QuickPasteCat by its primary key.
|
|
21
|
+
|
|
22
|
+
**Path Parameters:**
|
|
23
|
+
| Name | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| QuickPasteCatNum | integer | Yes | Primary key of the category |
|
|
26
|
+
|
|
27
|
+
**Response:** object
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| QuickPasteCatNum | integer | Primary key |
|
|
31
|
+
| Description | string | Category name/description; varchar(255) |
|
|
32
|
+
| ItemOrder | integer | Display order position (0-based) |
|
|
33
|
+
| DefaultForTypes | string | Comma-separated integers representing associated EnumQuickPasteType values |
|
|
34
|
+
|
|
35
|
+
**Status Codes:**
|
|
36
|
+
| Code | Meaning |
|
|
37
|
+
|------|---------|
|
|
38
|
+
| 200 | OK |
|
|
39
|
+
| 404 | NotFound |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
### GET /quickpastecats
|
|
44
|
+
|
|
45
|
+
**Version:** 22.3.26
|
|
46
|
+
**Description:** Retrieves a list of all QuickPasteCats with optional pagination.
|
|
47
|
+
|
|
48
|
+
**Query Parameters:**
|
|
49
|
+
| Name | Type | Required | Default | Description |
|
|
50
|
+
|------|------|----------|---------|-------------|
|
|
51
|
+
| Limit | integer | No | — | Maximum number of records to return |
|
|
52
|
+
| Offset | integer | No | 0 | Number of records to skip for pagination |
|
|
53
|
+
|
|
54
|
+
**Response:** array of objects — same fields as single GET
|
|
55
|
+
|
|
56
|
+
**Status Codes:**
|
|
57
|
+
| Code | Meaning |
|
|
58
|
+
|------|---------|
|
|
59
|
+
| 200 | OK |
|
|
60
|
+
| 400 | BadRequest |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Field Reference
|
|
65
|
+
|
|
66
|
+
### DefaultForTypes (enum: EnumQuickPasteType)
|
|
67
|
+
`DefaultForTypes` is stored as comma-separated integers. Each integer maps to the following values:
|
|
68
|
+
|
|
69
|
+
| Value | DB Int | Description |
|
|
70
|
+
|-------|--------|-------------|
|
|
71
|
+
| None | 0 | QuickPasteNotes disabled for this area; or if no category assigned, only first category with this type can be used |
|
|
72
|
+
| Procedure | 1 | Procedure note area |
|
|
73
|
+
| Appointment | 2 | Appointment note area |
|
|
74
|
+
| CommLog | 3 | Communication log area |
|
|
75
|
+
| Adjustment | 4 | Adjustment area |
|
|
76
|
+
| Claim | 5 | Claim area |
|
|
77
|
+
| Email | 6 | Email area |
|
|
78
|
+
| InsPlan | 7 | Insurance plan area |
|
|
79
|
+
| Letter | 8 | Letter area |
|
|
80
|
+
| MedicalSummary | 9 | Medical summary area |
|
|
81
|
+
| ServiceNotes | 10 | Service notes area |
|
|
82
|
+
| MedicalHistory | 11 | Medical history area |
|
|
83
|
+
| MedicationEdit | 12 | Medication edit area |
|
|
84
|
+
| MedicationPat | 13 | Patient medication area |
|
|
85
|
+
| PatAddressNote | 14 | Patient address note area |
|
|
86
|
+
| Payment | 15 | Payment area |
|
|
87
|
+
| PayPlan | 16 | Payment plan area |
|
|
88
|
+
| Query | 17 | Query area |
|
|
89
|
+
| Referral | 18 | Referral area |
|
|
90
|
+
| Rx | 19 | Prescription area |
|
|
91
|
+
| FinancialNotes | 20 | Financial notes area |
|
|
92
|
+
| ChartTreatment | 21 | Chart treatment area |
|
|
93
|
+
| MedicalUrgent | 22 | Medical urgent area |
|
|
94
|
+
| Statement | 23 | Statement area |
|
|
95
|
+
| Recall | 24 | Recall area |
|
|
96
|
+
| Popup | 25 | Popup area |
|
|
97
|
+
| TxtMsg | 26 | Text message area |
|
|
98
|
+
| Task | 27 | Task area |
|
|
99
|
+
| Schedule | 28 | Schedule area |
|
|
100
|
+
| TreatPlan | 29 | Treatment plan area |
|
|
101
|
+
| ClaimCustomTrack | 30 | Claim custom tracking area |
|
|
102
|
+
| AutoNotePrompt | 31 | Auto note prompt area |
|
|
103
|
+
| JobManager | 32 | Job manager area |
|
|
104
|
+
| ReadOnly | 33 | Do not use |
|
|
105
|
+
| Lab | 34 | Lab area |
|
|
106
|
+
| Equipment | 35 | Equipment area |
|
|
107
|
+
| Etrans834Import | 36 | 834 import area |
|
|
108
|
+
| InCaseOfEmergency | 37 | In case of emergency area |
|
|
109
|
+
| ProviderSearchFilter | 38 | Provider search filter area |
|
|
110
|
+
| ProgramLink | 39 | Program link area |
|
|
111
|
+
| PhoneEmpDefaultStatus | 40 | Phone employee default status area |
|
|
112
|
+
| WebChat | 41 | Web chat area |
|
|
113
|
+
| FAQ | 42 | FAQ area |
|
|
114
|
+
| Sheets | 43 | Sheets area — autonotes only, not quickpaste |
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Implementation Notes
|
|
119
|
+
- Each category can be the default for multiple note type contexts; `DefaultForTypes` stores these as comma-separated integers.
|
|
120
|
+
- Every QuickPasteNote must be associated with a category.
|
|
121
|
+
- If no category is assigned for a given note type context, only the first category with `None` (0) type can be used.
|
|
122
|
+
- `ItemOrder` is 0-based.
|
|
123
|
+
- `Sheets` (43) is for autonotes only — QuickPaste is not available in that context.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Related Resources
|
|
128
|
+
| Resource | Purpose |
|
|
129
|
+
|----------|---------|
|
|
130
|
+
| /quickpastenotes | Notes belonging to these categories |
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# API: QuickPasteNotes
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiquickpastenotes.html
|
|
4
|
+
**DB Schema Ref:** quickpastenote
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/quickpastenotes`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
QuickPasteNotes are templates used to easily replace abbreviated text with longer notes. Each note belongs to a QuickPasteCat (category). Users can trigger note expansion by preceding the abbreviation with a "?" character.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /quickpastenotes/{QuickPasteNoteNum}
|
|
18
|
+
|
|
19
|
+
**Version:** 22.3.24
|
|
20
|
+
**Description:** Retrieves a single QuickPasteNote by its primary key.
|
|
21
|
+
|
|
22
|
+
**Path Parameters:**
|
|
23
|
+
| Name | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| QuickPasteNoteNum | integer | Yes | Primary key of the note |
|
|
26
|
+
|
|
27
|
+
**Response:** object
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| QuickPasteNoteNum | integer | Primary key |
|
|
31
|
+
| QuickPasteCatNum | integer | FK to quickpastecat.QuickPasteCatNum |
|
|
32
|
+
| ItemOrder | integer | Display order within the category (0-based) |
|
|
33
|
+
| Note | text | Full note text content |
|
|
34
|
+
| Abbreviation | string | Abbreviated trigger text; preceded by "?" to expand; varchar(255) |
|
|
35
|
+
|
|
36
|
+
**Status Codes:**
|
|
37
|
+
| Code | Meaning |
|
|
38
|
+
|------|---------|
|
|
39
|
+
| 200 | OK |
|
|
40
|
+
| 404 | NotFound — "QuickPasteNote not found." |
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
### GET /quickpastenotes
|
|
45
|
+
|
|
46
|
+
**Version:** 22.3.24
|
|
47
|
+
**Description:** Retrieves a list of QuickPasteNotes with optional filtering by category.
|
|
48
|
+
|
|
49
|
+
**Query Parameters:**
|
|
50
|
+
| Name | Type | Required | Default | Description |
|
|
51
|
+
|------|------|----------|---------|-------------|
|
|
52
|
+
| QuickPasteCatNum | integer | No | — | Filter by category FK to quickpastecat.QuickPasteCatNum |
|
|
53
|
+
|
|
54
|
+
**Response:** array of objects — same fields as single GET
|
|
55
|
+
|
|
56
|
+
**Status Codes:**
|
|
57
|
+
| Code | Meaning |
|
|
58
|
+
|------|---------|
|
|
59
|
+
| 200 | OK |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Implementation Notes
|
|
64
|
+
- QuickPasteNotes are used to replace abbreviated text with longer notes; the `Abbreviation` field is preceded by "?" to trigger expansion.
|
|
65
|
+
- Every note must belong to a `QuickPasteCatNum` category.
|
|
66
|
+
- `ItemOrder` is 0-based and determines display order within the category.
|
|
67
|
+
- `Note` can be multiple lines and potentially very long.
|
|
68
|
+
- Consult the QuickPasteNote database schema documentation for additional column details.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Related Resources
|
|
73
|
+
| Resource | Purpose |
|
|
74
|
+
|----------|---------|
|
|
75
|
+
| /quickpastecats | Parent categories for these notes |
|