@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,135 @@
|
|
|
1
|
+
# API: ChartModules
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apichartmodules.html
|
|
4
|
+
**Extracted:** 2026-04-22
|
|
5
|
+
**Base Path:** `/chartmodules`
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
ChartModules provides read-only access to patient chart data, including progress notes, patient demographic information panels, and planned appointments. It mirrors the key views visible in the Open Dental chart module UI.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Endpoints
|
|
15
|
+
|
|
16
|
+
### GET /chartmodules/{PatNum}/ProgNotes
|
|
17
|
+
|
|
18
|
+
**Version:** 21.4
|
|
19
|
+
**Description:** Returns a list of progress note entries for a patient, covering appointments, commlogs, tasks, emails, lab cases, prescriptions, sheets, and procedures.
|
|
20
|
+
|
|
21
|
+
**Path Parameters:**
|
|
22
|
+
| Name | Type | Required | Description |
|
|
23
|
+
|------|------|----------|-------------|
|
|
24
|
+
| PatNum | integer | Yes | Patient number |
|
|
25
|
+
|
|
26
|
+
**Query Parameters:**
|
|
27
|
+
| Name | Type | Required | Default | Description |
|
|
28
|
+
|------|------|----------|---------|-------------|
|
|
29
|
+
| Offset | integer | No | 0 | Pagination offset |
|
|
30
|
+
|
|
31
|
+
**Response:** array of objects
|
|
32
|
+
| Field | Type | Description |
|
|
33
|
+
|-------|------|-------------|
|
|
34
|
+
| ObjectType | string | Type of object: Appointment, Commlog, Task, Email, LabCase, Rx, Sheet |
|
|
35
|
+
| PrimaryKey | integer | Primary key corresponding to ObjectType |
|
|
36
|
+
| Date | string | Human-readable date (MM/DD/YYYY) |
|
|
37
|
+
| Time | string | Human-readable time (H:MMa/p) |
|
|
38
|
+
| DateTime | string | ISO format datetime |
|
|
39
|
+
| Th | string | ToothNum for Procedure; blank otherwise |
|
|
40
|
+
| Surf | string | Tooth surface for Procedure; blank otherwise |
|
|
41
|
+
| Dx | string | Diagnosis description |
|
|
42
|
+
| Description | string | Object description |
|
|
43
|
+
| Note | string | Additional notes |
|
|
44
|
+
| Stat | string | Procedure status (e.g., "TP"); blank otherwise |
|
|
45
|
+
| Prov | string | Provider abbreviation |
|
|
46
|
+
| ProvNum | integer | Provider number |
|
|
47
|
+
| Amount | string | ProcFee for Procedure; blank otherwise |
|
|
48
|
+
| ProcCode | string | Procedure code (e.g., "D0220"); blank otherwise |
|
|
49
|
+
| User | string | Creator name (Commlog, Email, Rx only) |
|
|
50
|
+
| Signed | string | "Signed" if signature present; blank otherwise |
|
|
51
|
+
| Length | string | Appointment length (HH:mm format) |
|
|
52
|
+
| Abbr | string | Procedure abbreviation |
|
|
53
|
+
| Clinic | string | Clinic abbreviation |
|
|
54
|
+
| ClinicNum | integer | Clinic number |
|
|
55
|
+
|
|
56
|
+
**Status Codes:**
|
|
57
|
+
| Code | Meaning |
|
|
58
|
+
|------|---------|
|
|
59
|
+
| 200 | OK |
|
|
60
|
+
| 404 | Patient not found |
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
### GET /chartmodules/{PatNum}/PatientInfo
|
|
65
|
+
|
|
66
|
+
**Version:** 22.1
|
|
67
|
+
**Description:** Returns an array of field-content pairs representing the patient information panel displayed in the chart module.
|
|
68
|
+
|
|
69
|
+
**Path Parameters:**
|
|
70
|
+
| Name | Type | Required | Description |
|
|
71
|
+
|------|------|----------|-------------|
|
|
72
|
+
| PatNum | integer | Yes | Patient number |
|
|
73
|
+
|
|
74
|
+
**Response:** array of field-content pair objects
|
|
75
|
+
| Field | Description |
|
|
76
|
+
|-------|-------------|
|
|
77
|
+
| Age | Patient age |
|
|
78
|
+
| ABC0 | Credit rating or personal attributes |
|
|
79
|
+
| Billing Type | Patient's billing classification |
|
|
80
|
+
| Referred From | Referral source |
|
|
81
|
+
| Date First Visit | First visit date |
|
|
82
|
+
| Prov. (Pri, Sec) | Comma-separated abbreviations for primary and secondary providers |
|
|
83
|
+
| Pri Ins | Primary insurance plan |
|
|
84
|
+
| Sec Ins | Secondary insurance plan |
|
|
85
|
+
| Payor Types | Payment system identifier |
|
|
86
|
+
| Premedicate | Pre-appointment medications |
|
|
87
|
+
| Problem - [Name] | Patient problems (or "None") |
|
|
88
|
+
| Med Urgent | Medical urgent notes |
|
|
89
|
+
| Medical Summary | Medical summary notes |
|
|
90
|
+
| Service Notes | Patient service notes |
|
|
91
|
+
| Medication - [Name] | Patient medications (or "None") |
|
|
92
|
+
| Allergy - [Name] | Patient allergies (or "None") |
|
|
93
|
+
| Pat Restrictions | Patient restrictions (or "None") |
|
|
94
|
+
|
|
95
|
+
**Status Codes:**
|
|
96
|
+
| Code | Meaning |
|
|
97
|
+
|------|---------|
|
|
98
|
+
| 200 | OK |
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
### GET /chartmodules/{PatNum}/PlannedAppts
|
|
103
|
+
|
|
104
|
+
**Version:** 22.2
|
|
105
|
+
**Description:** Returns a list of planned appointments for a patient.
|
|
106
|
+
|
|
107
|
+
**Path Parameters:**
|
|
108
|
+
| Name | Type | Required | Description |
|
|
109
|
+
|------|------|----------|-------------|
|
|
110
|
+
| PatNum | integer | Yes | Patient number |
|
|
111
|
+
|
|
112
|
+
**Response:** array of objects
|
|
113
|
+
| Field | Type | Description |
|
|
114
|
+
|-------|------|-------------|
|
|
115
|
+
| AptNum | integer | Planned appointment number |
|
|
116
|
+
| ProvNum | integer | Associated provider number |
|
|
117
|
+
| ItemOrder | integer | Planned appointment sequence order |
|
|
118
|
+
| minutes | integer | Appointment duration in minutes |
|
|
119
|
+
| ProcDescript | string | Attached procedure(s) description |
|
|
120
|
+
| Note | string | Appointment note |
|
|
121
|
+
| dateSched | string | Linked scheduled appointment datetime |
|
|
122
|
+
| AptStatus | string | Appointment status (e.g., "Planned") |
|
|
123
|
+
|
|
124
|
+
**Status Codes:**
|
|
125
|
+
| Code | Meaning |
|
|
126
|
+
|------|---------|
|
|
127
|
+
| 200 | OK |
|
|
128
|
+
| 404 | Patient not found |
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Implementation Notes
|
|
133
|
+
- `Offset` on ProgNotes enables pagination for patients with large chart histories.
|
|
134
|
+
- `Amount`, `Th`, `Surf`, `Stat`, `ProcCode`, `Signed`, `Length`, `User` fields are conditionally populated depending on ObjectType.
|
|
135
|
+
- PatientInfo returns label-value pairs; field names match the Open Dental chart module UI labels exactly.
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
# API: ClaimPayments
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiclaimpayments.html
|
|
4
|
+
**Extracted:** 2026-04-22
|
|
5
|
+
**Base Path:** `/claimpayments`
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
ClaimPayments are used to finalize insurance payments received for dental claims. They link insurance checks to ClaimProcs and support both single-claim and batch (multi-claim) payment workflows. This resource is complex and requires ClaimProcs to be in a received/supplemental state with InsPayAmt finalized before use.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Endpoints
|
|
15
|
+
|
|
16
|
+
### GET /claimpayments/{ClaimPaymentNum}
|
|
17
|
+
|
|
18
|
+
**Version:** 23.2.15
|
|
19
|
+
**Description:** Retrieves a single claim payment record.
|
|
20
|
+
|
|
21
|
+
**Path Parameters:**
|
|
22
|
+
| Name | Type | Required | Description |
|
|
23
|
+
|------|------|----------|-------------|
|
|
24
|
+
| ClaimPaymentNum | integer | Yes | Claim payment identifier |
|
|
25
|
+
|
|
26
|
+
**Response:** object
|
|
27
|
+
| Field | Type | Description |
|
|
28
|
+
|-------|------|-------------|
|
|
29
|
+
| ClaimPaymentNum | integer | Primary key |
|
|
30
|
+
| CheckDate | string | Date of the check |
|
|
31
|
+
| CheckAmt | decimal | Check amount |
|
|
32
|
+
| CheckNum | string | Check number |
|
|
33
|
+
| BankBranch | string | Bank branch |
|
|
34
|
+
| Note | string | Payment note |
|
|
35
|
+
| ClinicNum | integer | FK to clinic |
|
|
36
|
+
| DepositNum | integer | FK to deposit |
|
|
37
|
+
| CarrierName | string | Insurance carrier name |
|
|
38
|
+
| DateIssued | string | Date check issued by carrier |
|
|
39
|
+
| IsPartial | boolean | True if partial payment |
|
|
40
|
+
| PayType | integer | Definition.DefNum (Category=32) |
|
|
41
|
+
| payType | string | Definition item name for PayType |
|
|
42
|
+
| SecUserNumEntry | integer | FK to userod; user who created record |
|
|
43
|
+
| SecDateEntry | string | Date record was created |
|
|
44
|
+
| SecDateTEdit | string | Last modified timestamp |
|
|
45
|
+
| PayGroup | integer | Definition.DefNum (Category=40) |
|
|
46
|
+
| payGroup | string | Definition item name for PayGroup |
|
|
47
|
+
|
|
48
|
+
**Status Codes:**
|
|
49
|
+
| Code | Meaning |
|
|
50
|
+
|------|---------|
|
|
51
|
+
| 200 | OK |
|
|
52
|
+
| 404 | Not Found |
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
### GET /claimpayments
|
|
57
|
+
|
|
58
|
+
**Version:** 23.2.15
|
|
59
|
+
**Description:** Retrieves multiple claim payment records, optionally filtered by last edit date.
|
|
60
|
+
|
|
61
|
+
**Query Parameters:**
|
|
62
|
+
| Name | Type | Required | Default | Description |
|
|
63
|
+
|------|------|----------|---------|-------------|
|
|
64
|
+
| SecDateTEdit | string | No | — | Returns payments edited on or after this datetime (yyyy-MM-dd HH:mm:ss) |
|
|
65
|
+
|
|
66
|
+
**Response:** array of claim payment objects (same fields as single GET)
|
|
67
|
+
|
|
68
|
+
**Status Codes:**
|
|
69
|
+
| Code | Meaning |
|
|
70
|
+
|------|---------|
|
|
71
|
+
| 200 | OK |
|
|
72
|
+
| 400 | Bad Request |
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
### POST /claimpayments
|
|
77
|
+
|
|
78
|
+
**Version:** 22.4.8
|
|
79
|
+
**Description:** Finalizes a claim payment for a single claim. Cannot be used if office preference `ClaimPaymentBatchOnly` is true.
|
|
80
|
+
|
|
81
|
+
**Body Parameters:**
|
|
82
|
+
| Name | Type | Required | Description |
|
|
83
|
+
|------|------|----------|-------------|
|
|
84
|
+
| claimNum | integer | Yes | FK to claim.ClaimNum |
|
|
85
|
+
| CheckAmt | decimal | Yes | Must match total ClaimProcs InsPayAmt |
|
|
86
|
+
| CheckDate | string | No | Format yyyy-MM-dd; default = today |
|
|
87
|
+
| CheckNum | string | No | Check number |
|
|
88
|
+
| BankBranch | string | No | Bank branch |
|
|
89
|
+
| Note | string | No | Payment note |
|
|
90
|
+
| ClinicNum | integer | No | Default = claim's ClinicNum |
|
|
91
|
+
| CarrierName | string | No | Default = InsPlan's CarrierName |
|
|
92
|
+
| DateIssued | string | No | Format yyyy-MM-dd; check date from carrier |
|
|
93
|
+
| PayType | integer | No | Definition.DefNum (Category=32); default = first definition |
|
|
94
|
+
| PayGroup | integer | No | Definition.DefNum (Category=40); default = first definition |
|
|
95
|
+
|
|
96
|
+
**Response:** claim payment object with newly assigned ClaimPaymentNum
|
|
97
|
+
|
|
98
|
+
**Status Codes:**
|
|
99
|
+
| Code | Meaning |
|
|
100
|
+
|------|---------|
|
|
101
|
+
| 201 | Created |
|
|
102
|
+
| 400 | Bad Request |
|
|
103
|
+
| 404 | Not Found |
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
### POST /claimpayments/Batch
|
|
108
|
+
|
|
109
|
+
**Version:** 24.2.18
|
|
110
|
+
**Description:** Creates a batch claim payment spanning multiple claims.
|
|
111
|
+
|
|
112
|
+
**Body Parameters:**
|
|
113
|
+
| Name | Type | Required | Description |
|
|
114
|
+
|------|------|----------|-------------|
|
|
115
|
+
| claimNums | array of integers | Yes | Array of claim identifiers, e.g. [1,2,3] |
|
|
116
|
+
| CheckAmt | decimal | Yes | Total check amount; sets IsPartial=true if less than sum of ClaimProcs InsPayAmt |
|
|
117
|
+
| CheckDate | string | No | Format yyyy-MM-dd; default = today |
|
|
118
|
+
| CheckNum | string | No | Check number |
|
|
119
|
+
| BankBranch | string | No | Bank branch |
|
|
120
|
+
| Note | string | No | Payment note |
|
|
121
|
+
| ClinicNum | integer | No | Default = 0 |
|
|
122
|
+
| CarrierName | string | No | Default = first claim's InsPlan CarrierName |
|
|
123
|
+
| DateIssued | string | No | Format yyyy-MM-dd; default = "0001-01-01" |
|
|
124
|
+
| PayType | integer | No | Definition.DefNum (Category=32) |
|
|
125
|
+
| PayGroup | integer | No | Definition.DefNum (Category=40) |
|
|
126
|
+
|
|
127
|
+
**Response:** claim payment object with newly assigned ClaimPaymentNum
|
|
128
|
+
|
|
129
|
+
**Status Codes:**
|
|
130
|
+
| Code | Meaning |
|
|
131
|
+
|------|---------|
|
|
132
|
+
| 201 | Created |
|
|
133
|
+
| 400 | Bad Request |
|
|
134
|
+
| 404 | Not Found |
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
### PUT /claimpayments/{ClaimPaymentNum}
|
|
139
|
+
|
|
140
|
+
**Version:** 23.2.15
|
|
141
|
+
**Description:** Updates an existing claim payment record.
|
|
142
|
+
|
|
143
|
+
**Path Parameters:**
|
|
144
|
+
| Name | Type | Required | Description |
|
|
145
|
+
|------|------|----------|-------------|
|
|
146
|
+
| ClaimPaymentNum | integer | Yes | Claim payment identifier |
|
|
147
|
+
|
|
148
|
+
**Body Parameters:**
|
|
149
|
+
| Name | Type | Required | Description |
|
|
150
|
+
|------|------|----------|-------------|
|
|
151
|
+
| CheckAmt | decimal | No | Added v25.2.26; updates amount, sets IsPartial if needed |
|
|
152
|
+
| CheckNum | string | No | Check number |
|
|
153
|
+
| BankBranch | string | No | Bank branch |
|
|
154
|
+
| Note | string | No | Replaces existing note |
|
|
155
|
+
| CarrierName | string | No | For reporting purposes |
|
|
156
|
+
| PayType | integer | No | Definition.DefNum (Category=32) |
|
|
157
|
+
| PayGroup | integer | No | Definition.DefNum (Category=40) |
|
|
158
|
+
|
|
159
|
+
**Response:** updated claim payment object
|
|
160
|
+
|
|
161
|
+
**Status Codes:**
|
|
162
|
+
| Code | Meaning |
|
|
163
|
+
|------|---------|
|
|
164
|
+
| 200 | OK |
|
|
165
|
+
| 400 | Bad Request |
|
|
166
|
+
| 404 | Not Found |
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
### DELETE /claimpayments/{ClaimPaymentNum}
|
|
171
|
+
|
|
172
|
+
**Version:** 24.3.13
|
|
173
|
+
**Description:** Deletes a claim payment. Cannot delete if associated with an EOB or deposit.
|
|
174
|
+
|
|
175
|
+
**Path Parameters:**
|
|
176
|
+
| Name | Type | Required | Description |
|
|
177
|
+
|------|------|----------|-------------|
|
|
178
|
+
| ClaimPaymentNum | integer | Yes | Claim payment identifier |
|
|
179
|
+
|
|
180
|
+
**Response:** 200 No Content on success
|
|
181
|
+
|
|
182
|
+
**Status Codes:**
|
|
183
|
+
| Code | Meaning |
|
|
184
|
+
|------|---------|
|
|
185
|
+
| 200 | OK |
|
|
186
|
+
| 400 | Bad Request (associated with EOB or deposit) |
|
|
187
|
+
| 404 | Not Found |
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
191
|
+
## Implementation Notes
|
|
192
|
+
- Before POST/Batch: ClaimProcs must have Status = "Received" or "Supplemental" and InsPayAmt finalized; Claim.ClaimStatus must be "R".
|
|
193
|
+
- ClaimProc.InsPayAmt cannot be updated once ClaimPaymentNum is assigned to it.
|
|
194
|
+
- Batch operations do not link Deposits or attach EOBs.
|
|
195
|
+
- Single claim POST is blocked when office preference `ClaimPaymentBatchOnly` is true.
|
|
196
|
+
- `IsPartial` is automatically set to true when `CheckAmt` differs from the sum of ClaimProcs InsPayAmt.
|
|
197
|
+
- `PayType` references Definition Category=32; `PayGroup` references Definition Category=40.
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## Related Resources
|
|
202
|
+
| Resource | Purpose |
|
|
203
|
+
|----------|---------|
|
|
204
|
+
| ClaimProcs | Must be updated to Received/Supplemental status before payment finalization |
|
|
205
|
+
| Claims | ClaimStatus must be "R" before payment |
|
|
206
|
+
| Definitions | Source of PayType (Cat=32) and PayGroup (Cat=40) values |
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
# API: ClaimProcs
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiclaimprocs.html
|
|
4
|
+
**DB Schema Ref:** claimproc
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/claimprocs`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
ClaimProcs link procedures to claims, link insurance payments to procedures or claims, and store insurance estimates for procedures not yet on a claim. A single procedure may have multiple ClaimProc rows if insurance made more than one payment. Many fields are optional depending on the use case.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /claimprocs/{ClaimProcNum}
|
|
18
|
+
|
|
19
|
+
**Version:** 25.1.27
|
|
20
|
+
**Description:** Retrieves a single ClaimProc record by its primary key.
|
|
21
|
+
|
|
22
|
+
**Path Parameters:**
|
|
23
|
+
| Name | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| ClaimProcNum | integer | Yes | FK / primary key of the ClaimProc |
|
|
26
|
+
|
|
27
|
+
**Response:** object
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| ClaimProcNum | integer | Primary key |
|
|
31
|
+
| ProcNum | integer | FK to procedurelog.ProcNum; 0 for total payments or Canadian carrier-issued procedures |
|
|
32
|
+
| ClaimNum | integer | FK to claim.ClaimNum; 0 for estimates, adjustments, and capitation |
|
|
33
|
+
| PatNum | integer | FK to patient.PatNum; must match claim.PatNum |
|
|
34
|
+
| ProvNum | integer | FK to provider.ProvNum |
|
|
35
|
+
| FeeBilled | decimal | Fee billed to insurance; may differ from actual procedure fee |
|
|
36
|
+
| InsPayEst | decimal | Estimated insurance payment after all adjustments |
|
|
37
|
+
| DedApplied | decimal | Deductible applied to this procedure (0 if none) |
|
|
38
|
+
| Status | string | ClaimProcStatus enum value (see Field Reference) |
|
|
39
|
+
| InsPayAmt | decimal | Actual insurance payment amount |
|
|
40
|
+
| Remarks | string | EOB remarks from insurance about the procedure |
|
|
41
|
+
| ClaimPaymentNum | integer | FK to claimpayment.ClaimPaymentNum (insurance check) |
|
|
42
|
+
| PlanNum | integer | FK to insplan.PlanNum |
|
|
43
|
+
| DateCP | date | Payment date used for payment reports |
|
|
44
|
+
| WriteOff | decimal | Amount not covered by insurance, written off |
|
|
45
|
+
| CodeSent | string | Procedure code sent to insurance (may differ from actual code) |
|
|
46
|
+
| AllowedOverride | decimal | Override for allowed/UCR fee; -1 indicates blank |
|
|
47
|
+
| Percentage | integer | Insurance coverage percentage (auto-calculated); -1 if blank |
|
|
48
|
+
| PercentOverride | integer | User-set coverage percentage override 0-100; -1 if no override |
|
|
49
|
+
| CopayAmt | decimal | Calculated copay amount; -1 if blank |
|
|
50
|
+
| NoBillIns | boolean | If true, procedure is not billed to this insurance plan |
|
|
51
|
+
| PaidOtherIns | decimal | Amount paid/estimated by lower-order insurance; -1 if blank |
|
|
52
|
+
| BaseEst | decimal | Base estimate: (fee or allowedOverride - copay) × percentage |
|
|
53
|
+
| CopayOverride | decimal | User-set copay override; -1 if blank |
|
|
54
|
+
| ProcDate | date | Date of the procedure |
|
|
55
|
+
| DateEntry | date | Date status was changed to Received or Supplemental |
|
|
56
|
+
| DedEst | decimal | Estimated deductible; -1 if blank |
|
|
57
|
+
| DedEstOverride | decimal | Override for DedEst; -1 if blank |
|
|
58
|
+
| InsEstTotal | decimal | Total insurance estimate (BaseEst minus ded, paidOtherIns, overAnnualMax) |
|
|
59
|
+
| InsEstTotalOverride | decimal | Override for InsEstTotal; -1 if blank |
|
|
60
|
+
| PaidOtherInsOverride | decimal | Override for PaidOtherIns; -1 if blank |
|
|
61
|
+
| EstimateNote | string | Auto-generated note about over-max, exclusions, and limitations |
|
|
62
|
+
| WriteOffEst | decimal | Estimated write-off (PPO); -1 if blank |
|
|
63
|
+
| WriteOffEstOverride | decimal | Override for WriteOffEst; -1 if blank |
|
|
64
|
+
| ClinicNum | integer | FK to clinic.ClinicNum; 0 if no clinic |
|
|
65
|
+
| InsSubNum | integer | FK to inssub.InsSubNum |
|
|
66
|
+
| PaymentRow | integer | 1-indexed sort order for payments on an EOB |
|
|
67
|
+
| PayPlanNum | integer | FK to payplan.PayPlanNum; 0 if not attached |
|
|
68
|
+
| ClaimPaymentTracking | integer | FK to definition.DefNum (Category=36) |
|
|
69
|
+
| claimPaymentTracking | string | Definition item name for ClaimPaymentTracking |
|
|
70
|
+
| SecUserNumEntry | integer | FK to userod; user who created the row |
|
|
71
|
+
| SecDateEntry | date | Date the row was inserted |
|
|
72
|
+
| SecDateTEdit | string | Auto-updated timestamp of last modification |
|
|
73
|
+
| DateSuppReceived | date | Date first set to Received or Supplemental |
|
|
74
|
+
| DateInsFinalized | date | Date of the first ClaimPayment for the claim |
|
|
75
|
+
| IsTransfer | boolean | True if created by Income Transfer Manager to reallocate "As Total" payments |
|
|
76
|
+
| ClaimAdjReasonCodes | string | Comma-delimited ERA Claim Adjustment Reason Codes |
|
|
77
|
+
|
|
78
|
+
**Status Codes:**
|
|
79
|
+
| Code | Meaning |
|
|
80
|
+
|------|---------|
|
|
81
|
+
| 200 | OK |
|
|
82
|
+
| 400 | Bad Request |
|
|
83
|
+
| 404 | Not Found |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### GET /claimprocs
|
|
88
|
+
|
|
89
|
+
**Version:** 22.2.33
|
|
90
|
+
**Description:** Retrieves a list of ClaimProcs with optional filtering.
|
|
91
|
+
|
|
92
|
+
**Query Parameters:**
|
|
93
|
+
| Name | Type | Required | Default | Description |
|
|
94
|
+
|------|------|----------|---------|-------------|
|
|
95
|
+
| ProcNum | integer | No | — | Added v23.2.16; FK to procedurelog.ProcNum |
|
|
96
|
+
| ClaimNum | integer | No | — | Optional after v23.2.16; FK to claim.ClaimNum |
|
|
97
|
+
| PatNum | integer | No | — | Optional after v23.2.16; FK to patient.PatNum |
|
|
98
|
+
| Status | string | No | — | Added v24.4.13; one of: NotReceived, Received, Preauth, Adjustment, Supplemental, CapClaim, Estimate, CapComplete, CapEstimate, InsHist |
|
|
99
|
+
| ClaimPaymentNum | integer | No | — | Added v23.2.16; FK to claimpayment.ClaimPaymentNum |
|
|
100
|
+
|
|
101
|
+
**Response:** array of ClaimProc objects (same fields as single GET)
|
|
102
|
+
|
|
103
|
+
**Status Codes:**
|
|
104
|
+
| Code | Meaning |
|
|
105
|
+
|------|---------|
|
|
106
|
+
| 200 | OK |
|
|
107
|
+
| 400 | Bad Request |
|
|
108
|
+
| 404 | Not Found |
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
### PUT /claimprocs/{ClaimProcNum}
|
|
113
|
+
|
|
114
|
+
**Version:** 22.3.33
|
|
115
|
+
**Description:** Updates a ClaimProc using the same calculations as the Open Dental application. Recalculates associated claim totals. Cannot update ClaimProcs with `IsTransfer=true` or Status of Adjustment, InsHist, CapClaim, CapComplete, or CapEstimate.
|
|
116
|
+
|
|
117
|
+
**Path Parameters:**
|
|
118
|
+
| Name | Type | Required | Description |
|
|
119
|
+
|------|------|----------|-------------|
|
|
120
|
+
| ClaimProcNum | integer | Yes | ClaimProc primary key |
|
|
121
|
+
|
|
122
|
+
**Body Parameters:**
|
|
123
|
+
| Name | Type | Required | Description |
|
|
124
|
+
|------|------|----------|-------------|
|
|
125
|
+
| ProvNum | integer | No | Provider; follows ProcProvChangesClaimProcWithClaim preference |
|
|
126
|
+
| FeeBilled | decimal | No | Amount billed to insurance |
|
|
127
|
+
| DedApplied | decimal | No | Deductible applied; matches DedEstOverride when Status is NotReceived or Preauth |
|
|
128
|
+
| Status | string | No | NotReceived, Received, Preauth, Supplemental, or Estimate; setting to Received/Supplemental updates DateEntry |
|
|
129
|
+
| InsPayAmt | decimal | No | Actual insurance payment; cannot update once attached to a check |
|
|
130
|
+
| Remarks | string | No | EOB remarks; overwrites existing |
|
|
131
|
+
| ClaimPaymentNum | integer | No | Added v24.3.24; attach to partial ClaimPayment; use 0 to detach |
|
|
132
|
+
| WriteOff | decimal | No | Amount written off |
|
|
133
|
+
| CodeSent | string | No | Procedure code sent to insurance; validate with ProcedureCodes GET |
|
|
134
|
+
| PercentOverride | integer | No | 0-100; use -1 for no override |
|
|
135
|
+
| NoBillIns | string | No | Added v23.2.10; "true" or "false"; when true removes all estimates and override values |
|
|
136
|
+
| CopayOverride | decimal | No | Based on copay fee schedule; use -1 for no override |
|
|
137
|
+
| DedEstOverride | decimal | No | Patient annual deductible override; use -1 for no override |
|
|
138
|
+
| InsEstTotalOverride | decimal | No | Estimated insurance payment override; use -1 for no override |
|
|
139
|
+
| PaidOtherInsOverride | decimal | No | Amounts paid by lower-order insurance override; use -1 for no override |
|
|
140
|
+
| WriteOffEstOverride | decimal | No | Write-off amount override (PPOs); use -1 for no override |
|
|
141
|
+
| ClaimPaymentTracking | integer | No | FK to Definition.DefNum (Category=36); tracks payment info/rejection reasons |
|
|
142
|
+
|
|
143
|
+
**Response:** updated ClaimProc object with all fields
|
|
144
|
+
|
|
145
|
+
**Status Codes:**
|
|
146
|
+
| Code | Meaning |
|
|
147
|
+
|------|---------|
|
|
148
|
+
| 200 | OK |
|
|
149
|
+
| 400 | Bad Request |
|
|
150
|
+
| 404 | Not Found |
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
### PUT /claimprocs/InsAdjust
|
|
155
|
+
|
|
156
|
+
**Version:** 21.1
|
|
157
|
+
**Description:** Adds or modifies an insurance adjustment ClaimProc. If `insUsed` exactly matches existing payments, any adjustment ClaimProc is deleted.
|
|
158
|
+
|
|
159
|
+
**Body Parameters:**
|
|
160
|
+
| Name | Type | Required | Description |
|
|
161
|
+
|------|------|----------|-------------|
|
|
162
|
+
| PatPlanNum | integer | Yes | Patient insurance plan identifier |
|
|
163
|
+
| insUsed | decimal | Conditional | Total insurance used; required if deductibleUsed not provided |
|
|
164
|
+
| deductibleUsed | decimal | Conditional | Total deductible used; required if insUsed not provided |
|
|
165
|
+
| date | string | No | Benefit year date yyyy-MM-dd; defaults to current date |
|
|
166
|
+
|
|
167
|
+
**Response:** 200 OK regardless of outcome (ClaimProcs may be added or deleted)
|
|
168
|
+
|
|
169
|
+
**Status Codes:**
|
|
170
|
+
| Code | Meaning |
|
|
171
|
+
|------|---------|
|
|
172
|
+
| 200 | OK |
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
### POST /claimprocs/InsAdjust
|
|
177
|
+
|
|
178
|
+
**Version:** 23.2.5
|
|
179
|
+
**Description:** Creates an insurance adjustment ClaimProc with Status="Adjustment".
|
|
180
|
+
|
|
181
|
+
**Body Parameters:**
|
|
182
|
+
| Name | Type | Required | Description |
|
|
183
|
+
|------|------|----------|-------------|
|
|
184
|
+
| PatPlanNum | integer | Yes | Patient insurance plan identifier |
|
|
185
|
+
| insUsed | decimal | No | Total insurance used; default 0 |
|
|
186
|
+
| deductibleUsed | decimal | No | Total deductible used; default 0 |
|
|
187
|
+
| date | string | No | Format yyyy-MM-dd; default current date |
|
|
188
|
+
|
|
189
|
+
**Response:** created ClaimProc object with Status="Adjustment"
|
|
190
|
+
|
|
191
|
+
**Status Codes:**
|
|
192
|
+
| Code | Meaning |
|
|
193
|
+
|------|---------|
|
|
194
|
+
| 201 | Created |
|
|
195
|
+
| 400 | Bad Request |
|
|
196
|
+
| 404 | Not Found |
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
### POST /claimprocs/Supplemental
|
|
201
|
+
|
|
202
|
+
**Version:** 25.2.7
|
|
203
|
+
**Description:** Creates a ClaimProc with Status="Supplemental" for supplemental insurance payments.
|
|
204
|
+
|
|
205
|
+
**Body Parameters:**
|
|
206
|
+
| Name | Type | Required | Description |
|
|
207
|
+
|------|------|----------|-------------|
|
|
208
|
+
| ClaimProcNum | integer | Yes | Reference to existing ClaimProc |
|
|
209
|
+
| InsPayAmt | decimal | No | Insurance payment amount; default 0 |
|
|
210
|
+
|
|
211
|
+
**Response:** created ClaimProc object with Status="Supplemental"
|
|
212
|
+
|
|
213
|
+
**Status Codes:**
|
|
214
|
+
| Code | Meaning |
|
|
215
|
+
|------|---------|
|
|
216
|
+
| 201 | Created |
|
|
217
|
+
| 400 | Bad Request |
|
|
218
|
+
| 404 | Not Found |
|
|
219
|
+
|
|
220
|
+
---
|
|
221
|
+
|
|
222
|
+
## Field Reference
|
|
223
|
+
|
|
224
|
+
### Status (enum: ClaimProcStatus)
|
|
225
|
+
| Value | DB Int | Description |
|
|
226
|
+
|-------|--------|-------------|
|
|
227
|
+
| NotReceived | 0 | Claims created or sent but not yet received |
|
|
228
|
+
| Received | 1 | Claims that have been received |
|
|
229
|
+
| Preauth | 2 | Preauthorizations |
|
|
230
|
+
| Adjustment | 3 | Benefit adjustments from coverage window; never attached to a claim |
|
|
231
|
+
| Supplemental | 4 | Additional payments on procedures already received; most fields blank |
|
|
232
|
+
| CapClaim | 5 | Capitation claim; always has a duplicate CapComplete ClaimProc for the same procedure |
|
|
233
|
+
| Estimate | 6 | Replaces old procedure-table estimate fields; may be attached to a claim (becomes NotReceived) |
|
|
234
|
+
| CapComplete | 7 | Completed capitation procedure; stores copay and writeoff; never attached to a claim |
|
|
235
|
+
| CapEstimate | 8 | Capitation estimate; becomes CapComplete when procedure completes |
|
|
236
|
+
| InsHist | 9 | Insurance history procedures (Existing Other / EO procs) |
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Implementation Notes
|
|
241
|
+
- Override fields (`PercentOverride`, `CopayOverride`, `DedEstOverride`, `InsEstTotalOverride`, `PaidOtherInsOverride`, `WriteOffEstOverride`, `AllowedOverride`) use -1 to represent no override (blank).
|
|
242
|
+
- `InsPayAmt` cannot be updated once the ClaimProc is attached to a ClaimPayment check.
|
|
243
|
+
- BlueBook values are not updated by the API.
|
|
244
|
+
- Editing a received ClaimProc may delete associated Income Transfers.
|
|
245
|
+
- PUT cannot be used on ClaimProcs with `IsTransfer=true` or Status of Adjustment, InsHist, CapClaim, CapComplete, or CapEstimate.
|
|
246
|
+
- Setting Status to Received or Supplemental automatically updates `DateEntry` to the current time.
|
|
247
|
+
|
|
248
|
+
---
|
|
249
|
+
|
|
250
|
+
## Related Resources
|
|
251
|
+
| Resource | Purpose |
|
|
252
|
+
|----------|---------|
|
|
253
|
+
| Claims | Parent claim record |
|
|
254
|
+
| ClaimPayments | Insurance check linked via ClaimPaymentNum |
|
|
255
|
+
| Definitions | ClaimPaymentTracking (Category=36) |
|
|
256
|
+
| ProcedureCodes | Validate CodeSent values |
|