@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,477 @@
|
|
|
1
|
+
# API: ProcedureLogs
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiprocedurelogs.html
|
|
4
|
+
**DB Schema Ref:** procedurelog
|
|
5
|
+
**Extracted:** 2026-04-22
|
|
6
|
+
**Base Path:** `/procedurelogs`
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
ProcedureLogs represent individual procedure instances for patients. They can be treatment-planned or completed, and once completed are tracked closely by the security system. A procedure can never truly be deleted — its status can only be changed to "Deleted". Group Notes are a special procedure type using code "~GRP~".
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Endpoints
|
|
16
|
+
|
|
17
|
+
### GET /procedurelogs/{ProcNum}
|
|
18
|
+
|
|
19
|
+
**Version:** 23.3.13
|
|
20
|
+
**Description:** Retrieves a single procedure log by its primary key.
|
|
21
|
+
|
|
22
|
+
**Path Parameters:**
|
|
23
|
+
| Name | Type | Required | Description |
|
|
24
|
+
|------|------|----------|-------------|
|
|
25
|
+
| ProcNum | integer | Yes | Primary key of the procedure log |
|
|
26
|
+
|
|
27
|
+
**Response:** object
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| ProcNum | integer | Primary key |
|
|
31
|
+
| PatNum | integer | FK to patient.PatNum |
|
|
32
|
+
| AptNum | integer | FK to appointment.AptNum (0 if none) |
|
|
33
|
+
| ProcDate | string | Procedure date (yyyy-MM-dd) |
|
|
34
|
+
| ProcFee | decimal | Procedure fee |
|
|
35
|
+
| Surf | string | Tooth surfaces (B/F, V, M, O/I, D, L, UL, UR, LR, LL, 1-6, U, L) |
|
|
36
|
+
| ToothNum | string | Tooth number (1-32 or A-T; supernumerary: add 50) |
|
|
37
|
+
| ToothRange | string | Comma/hyphen-separated tooth numbers |
|
|
38
|
+
| Priority | integer | FK to definition.DefNum (DefCat=20 TxPriorities) |
|
|
39
|
+
| priority | string | Text of the priority definition |
|
|
40
|
+
| ProcStatus | string | Procedure status enum (see Field Reference) |
|
|
41
|
+
| ProvNum | integer | FK to provider.ProvNum |
|
|
42
|
+
| provAbbr | string | Provider abbreviation |
|
|
43
|
+
| Dx | integer | FK to definition.DefNum (DefCat=16) |
|
|
44
|
+
| dxName | string | Text of the diagnosis definition |
|
|
45
|
+
| PlannedAptNum | integer | FK to appointment.AptNum for planned appointment |
|
|
46
|
+
| PlaceService | string | Place of service enum (see Field Reference) |
|
|
47
|
+
| Prosthesis | string | "" = none, "I" = Initial, "R" = Replacement |
|
|
48
|
+
| DateOriginalProsth | string | Original prosthesis date for replacements (yyyy-MM-dd) |
|
|
49
|
+
| ClaimNote | string | Note sent on e-claims (max 80 chars; not visible in Canada) |
|
|
50
|
+
| DateEntryC | string | Date procedure was entered or set complete (yyyy-MM-dd) |
|
|
51
|
+
| ClinicNum | integer | FK to clinic.ClinicNum (0 if no clinic) |
|
|
52
|
+
| DiagnosticCode | string | ICD-9 or ICD-10 code for medical claims |
|
|
53
|
+
| IsPrincDiag | boolean string | "true" if principal diagnosis |
|
|
54
|
+
| CodeNum | integer | FK to procedurecode.CodeNum |
|
|
55
|
+
| procCode | string | Procedure code string (e.g., "D0120") |
|
|
56
|
+
| descript | string | Procedure description |
|
|
57
|
+
| UnitQty | integer | Unit quantity |
|
|
58
|
+
| BaseUnits | integer | Base units |
|
|
59
|
+
| DateTP | string | Treatment plan date (yyyy-MM-dd) |
|
|
60
|
+
| SiteNum | integer | FK to site |
|
|
61
|
+
| HideGraphics | boolean | Whether to hide tooth chart graphics |
|
|
62
|
+
| CanadianTypeCodes | string | Canadian type codes |
|
|
63
|
+
| ProcTime | string | Procedure start time (HH:mm:ss) |
|
|
64
|
+
| ProcTimeEnd | string | Procedure end time (HH:mm:ss) |
|
|
65
|
+
| DateTStamp | string | Last modified timestamp (yyyy-MM-dd HH:mm:ss) |
|
|
66
|
+
| Prognosis | integer | FK to definition.DefNum (DefCat=30) |
|
|
67
|
+
| IsLocked | boolean | Whether procedure is locked |
|
|
68
|
+
| BillingNote | string | Account module billing note |
|
|
69
|
+
| DiagnosticCode2 | string | Secondary ICD code |
|
|
70
|
+
| DiagnosticCode3 | string | Tertiary ICD code |
|
|
71
|
+
| DiagnosticCode4 | string | Quaternary ICD code |
|
|
72
|
+
| Discount | decimal | Discount dollar amount |
|
|
73
|
+
| IsDateProsthEst | boolean string | "true" if prosthesis date is estimated |
|
|
74
|
+
| IcdVersion | integer | ICD version: 9 or 10 |
|
|
75
|
+
| SecDateEntry | string | Security entry date |
|
|
76
|
+
| serverDateTime | string | Server current datetime |
|
|
77
|
+
|
|
78
|
+
**Status Codes:**
|
|
79
|
+
| Code | Meaning |
|
|
80
|
+
|------|---------|
|
|
81
|
+
| 200 | OK |
|
|
82
|
+
| 400 | BadRequest |
|
|
83
|
+
| 404 | NotFound |
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### GET /procedurelogs
|
|
88
|
+
|
|
89
|
+
**Version:** 21.1
|
|
90
|
+
**Description:** Retrieves multiple procedure logs matching search criteria.
|
|
91
|
+
|
|
92
|
+
**Query Parameters:**
|
|
93
|
+
| Name | Type | Required | Default | Description |
|
|
94
|
+
|------|------|----------|---------|-------------|
|
|
95
|
+
| PatNum | integer | No | — | Filter by patient |
|
|
96
|
+
| AptNum | integer | No | — | Filter by appointment (added v22.3.32) |
|
|
97
|
+
| ProcDate | string | No | — | "yyyy-MM-dd"; filter by procedure date (added v25.4.14) |
|
|
98
|
+
| ProcStatus | string | No | — | Filter by status: TP, C, EC, EO, R, D, Cn, TPi (added v25.2.21) |
|
|
99
|
+
| PlannedAptNum | integer | No | — | Filter by planned appointment (added v24.4.5) |
|
|
100
|
+
| ClinicNum | integer | No | — | Filter by clinic (added v23.3.13) |
|
|
101
|
+
| CodeNum | integer | No | — | Filter by procedure code (added v25.2.21) |
|
|
102
|
+
| DateTStamp | string | No | — | "yyyy-MM-dd HH:mm:ss"; returns records created on or after this datetime |
|
|
103
|
+
| Offset | integer | No | 0 | Pagination offset |
|
|
104
|
+
|
|
105
|
+
**Response:** array of objects — same fields as single GET
|
|
106
|
+
|
|
107
|
+
**Status Codes:**
|
|
108
|
+
| Code | Meaning |
|
|
109
|
+
|------|---------|
|
|
110
|
+
| 200 | OK |
|
|
111
|
+
| 400 | BadRequest |
|
|
112
|
+
| 404 | NotFound |
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
### GET /procedurelogs/InsuranceHistory
|
|
117
|
+
|
|
118
|
+
**Version:** 22.4.31
|
|
119
|
+
**Description:** Retrieves previous treatment dates per insurance category for a patient/subscription pair.
|
|
120
|
+
|
|
121
|
+
**Query Parameters:**
|
|
122
|
+
| Name | Type | Required | Default | Description |
|
|
123
|
+
|------|------|----------|---------|-------------|
|
|
124
|
+
| PatNum | integer | Yes | — | Patient identifier |
|
|
125
|
+
| InsSubNum | integer | Yes | — | Insurance subscription identifier |
|
|
126
|
+
|
|
127
|
+
**Response:** array of objects
|
|
128
|
+
| Field | Type | Description |
|
|
129
|
+
|-------|------|-------------|
|
|
130
|
+
| insHistPrefName | string | Preference name storing procedure codes for this category |
|
|
131
|
+
| procDate | string | Previous treatment date, "No History", or "Not Set" |
|
|
132
|
+
| ProcNum | integer | Most recent procedure identifier for this category |
|
|
133
|
+
|
|
134
|
+
**Status Codes:**
|
|
135
|
+
| Code | Meaning |
|
|
136
|
+
|------|---------|
|
|
137
|
+
| 200 | OK |
|
|
138
|
+
| 400 | BadRequest |
|
|
139
|
+
| 404 | NotFound |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
### GET /procedurelogs/GroupNotes
|
|
144
|
+
|
|
145
|
+
**Version:** 25.2.38
|
|
146
|
+
**Description:** Retrieves group notes for a patient's procedures.
|
|
147
|
+
|
|
148
|
+
**Query Parameters:**
|
|
149
|
+
| Name | Type | Required | Default | Description |
|
|
150
|
+
|------|------|----------|---------|-------------|
|
|
151
|
+
| PatNum | integer | Yes | — | Patient identifier |
|
|
152
|
+
|
|
153
|
+
**Response:** array of objects
|
|
154
|
+
| Field | Type | Description |
|
|
155
|
+
|-------|------|-------------|
|
|
156
|
+
| PatNum | integer | Patient identifier |
|
|
157
|
+
| ProvNum | integer | Provider identifier |
|
|
158
|
+
| ProcNum | integer | Procedure identifier (code ~GRP~) |
|
|
159
|
+
| ProcNums | array | Related procedure identifiers |
|
|
160
|
+
| Note | string | Group note text |
|
|
161
|
+
| isSigned | string | "true" or "false" |
|
|
162
|
+
|
|
163
|
+
**Status Codes:**
|
|
164
|
+
| Code | Meaning |
|
|
165
|
+
|------|---------|
|
|
166
|
+
| 200 | OK |
|
|
167
|
+
| 400 | BadRequest |
|
|
168
|
+
| 404 | NotFound |
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
### POST /procedurelogs
|
|
173
|
+
|
|
174
|
+
**Version:** 21.4
|
|
175
|
+
**Description:** Creates a new procedure log.
|
|
176
|
+
|
|
177
|
+
**Body Parameters:**
|
|
178
|
+
| Name | Type | Required | Description |
|
|
179
|
+
|------|------|----------|-------------|
|
|
180
|
+
| PatNum | integer | Yes | FK to patient.PatNum |
|
|
181
|
+
| ProcDate | string | Yes | "yyyy-MM-dd" |
|
|
182
|
+
| ProcStatus | string | Yes | TP, C, EO, EC, R, or Cn |
|
|
183
|
+
| CodeNum | integer | Yes (or procCode) | FK to procedurecode.CodeNum |
|
|
184
|
+
| procCode | string | Yes (or CodeNum) | Procedure code string (e.g., "D0120") |
|
|
185
|
+
| AptNum | integer | No | FK to appointment.AptNum |
|
|
186
|
+
| ProcFee | decimal | No | Fee; defaults to procedure code default |
|
|
187
|
+
| Priority | integer | No | FK to definition.DefNum (DefCat=20); mutually exclusive with priority |
|
|
188
|
+
| priority | string | No | Text version of priority; mutually exclusive with Priority |
|
|
189
|
+
| ProvNum | integer | No | FK to provider.ProvNum |
|
|
190
|
+
| Dx | integer | No | FK to definition.DefNum (DefCat=16); mutually exclusive with dxName |
|
|
191
|
+
| dxName | string | No | Text version of diagnosis; mutually exclusive with Dx |
|
|
192
|
+
| PlannedAptNum | integer | No | FK to appointment.AptNum for planned appointment |
|
|
193
|
+
| PlaceService | string | No | Place of service enum (added v25.2.21) |
|
|
194
|
+
| Prosthesis | string | No | "" / "I" / "R" — requires procedurecode.IsProsth=true (added v25.2.21) |
|
|
195
|
+
| DateOriginalProsth | string | No | "yyyy-MM-dd" (added v25.2.21) |
|
|
196
|
+
| ClaimNote | string | No | E-claims note (added v25.2.21) |
|
|
197
|
+
| ClinicNum | integer | No | FK to clinic.ClinicNum |
|
|
198
|
+
| DiagnosticCode | string | No | ICD-9 or ICD-10 code (added v25.4.35) |
|
|
199
|
+
| IsPrincDiag | string | No | "true"/"false" (added v25.4.35) |
|
|
200
|
+
| DateTP | string | No | "yyyy-MM-dd" (added v25.2.21) |
|
|
201
|
+
| SiteNum | integer | No | Site identifier (added v25.2.21) |
|
|
202
|
+
| ProcTime | string | No | "HH:mm:ss" (added v25.2.21) |
|
|
203
|
+
| ProcTimeEnd | string | No | "HH:mm:ss" (added v25.2.21) |
|
|
204
|
+
| Prognosis | integer | No | FK to definition.DefNum (DefCat=30) (added v25.2.21) |
|
|
205
|
+
| ToothNum | string | No | Required for applicable procedure codes |
|
|
206
|
+
| Surf | string | No | Required for applicable procedure codes |
|
|
207
|
+
| ToothRange | string | No | Comma/hyphen-separated tooth numbers |
|
|
208
|
+
| BillingNote | string | No | Account module note (added v25.2.21) |
|
|
209
|
+
| DiagnosticCode2 | string | No | Secondary ICD code (added v25.4.35) |
|
|
210
|
+
| DiagnosticCode3 | string | No | Tertiary ICD code (added v25.4.35) |
|
|
211
|
+
| DiagnosticCode4 | string | No | Quaternary ICD code (added v25.4.35) |
|
|
212
|
+
| Discount | decimal | No | Dollar discount amount (added v25.2.21) |
|
|
213
|
+
| IsDateProsthEst | string | No | "true"/"false" (added v25.2.21) |
|
|
214
|
+
| IcdVersion | integer | No | 9 or 10 (added v25.4.35) |
|
|
215
|
+
|
|
216
|
+
**Response:** object — created procedure log with all fields
|
|
217
|
+
|
|
218
|
+
**Status Codes:**
|
|
219
|
+
| Code | Meaning |
|
|
220
|
+
|------|---------|
|
|
221
|
+
| 201 | Created |
|
|
222
|
+
| 400 | BadRequest |
|
|
223
|
+
| 404 | NotFound |
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
### POST /procedurelogs/GroupNote
|
|
228
|
+
|
|
229
|
+
**Version:** 22.2
|
|
230
|
+
**Description:** Creates a group note linking multiple procedures.
|
|
231
|
+
|
|
232
|
+
**Body Parameters:**
|
|
233
|
+
| Name | Type | Required | Description |
|
|
234
|
+
|------|------|----------|-------------|
|
|
235
|
+
| PatNum | integer | Yes | Patient identifier |
|
|
236
|
+
| Note | string | Yes | Group note text |
|
|
237
|
+
| ProcNums | array | No (optional after v25.3.36) | Array of procedure numbers (e.g., [1,2,3]) |
|
|
238
|
+
| isSigned | string | No (v25.2.38+) | "true"/"false"; default "false" |
|
|
239
|
+
| ProvNum | integer | No (v25.3.36+) | Provider identifier |
|
|
240
|
+
|
|
241
|
+
**Response:** object
|
|
242
|
+
| Field | Type | Description |
|
|
243
|
+
|-------|------|-------------|
|
|
244
|
+
| PatNum | integer | Patient identifier |
|
|
245
|
+
| ProvNum | integer | Provider identifier |
|
|
246
|
+
| ProcNum | integer | Group note procedure identifier |
|
|
247
|
+
| ProcNums | array | Attached procedure identifiers |
|
|
248
|
+
| Note | string | Group note text |
|
|
249
|
+
| isSigned | string | "true" or "false" |
|
|
250
|
+
|
|
251
|
+
**Status Codes:**
|
|
252
|
+
| Code | Meaning |
|
|
253
|
+
|------|---------|
|
|
254
|
+
| 201 | Created |
|
|
255
|
+
| 400 | BadRequest |
|
|
256
|
+
| 404 | NotFound |
|
|
257
|
+
|
|
258
|
+
---
|
|
259
|
+
|
|
260
|
+
### POST /procedurelogs/InsuranceHistory
|
|
261
|
+
|
|
262
|
+
**Version:** 22.4.31
|
|
263
|
+
**Description:** Creates an existing-provider procedure and insurance history claim processor entry.
|
|
264
|
+
|
|
265
|
+
**Body Parameters:**
|
|
266
|
+
| Name | Type | Required | Description |
|
|
267
|
+
|------|------|----------|-------------|
|
|
268
|
+
| PatNum | integer | Yes | Patient identifier |
|
|
269
|
+
| InsSubNum | integer | Yes | Insurance subscription identifier |
|
|
270
|
+
| insHistPrefName | string | Yes | One of: InsHistBWCodes, InsHistPanoCodes, InsHistExamCodes, InsHistProphyCodes, InsHistPerioURCodes, InsHistPerioULCodes, InsHistPerioLRCodes, InsHistPerioLLCodes, InsHistPerioMaintCodes, InsHistDebridementCodes |
|
|
271
|
+
| ProcDate | string | Yes | "yyyy-MM-dd" |
|
|
272
|
+
|
|
273
|
+
**Status Codes:**
|
|
274
|
+
| Code | Meaning |
|
|
275
|
+
|------|---------|
|
|
276
|
+
| 201 | Created |
|
|
277
|
+
| 400 | BadRequest |
|
|
278
|
+
| 404 | NotFound |
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
### PUT /procedurelogs/{ProcNum}
|
|
283
|
+
|
|
284
|
+
**Version:** 22.1
|
|
285
|
+
**Description:** Updates an existing procedure log. All body parameters are optional.
|
|
286
|
+
|
|
287
|
+
**Path Parameters:**
|
|
288
|
+
| Name | Type | Required | Description |
|
|
289
|
+
|------|------|----------|-------------|
|
|
290
|
+
| ProcNum | integer | Yes | Primary key of the procedure log to update |
|
|
291
|
+
|
|
292
|
+
**Body Parameters:**
|
|
293
|
+
| Name | Type | Required | Description |
|
|
294
|
+
|------|------|----------|-------------|
|
|
295
|
+
| AptNum | integer | No | FK to appointment.AptNum |
|
|
296
|
+
| ProcDate | string | No | "yyyy-MM-dd" |
|
|
297
|
+
| ProcFee | decimal | No | Fee amount |
|
|
298
|
+
| Priority | integer | No | FK to definition.DefNum (DefCat=20) |
|
|
299
|
+
| ProcStatus | string | No | TP, C, EO, EC, R, or Cn |
|
|
300
|
+
| ProvNum | integer | No | FK to provider.ProvNum |
|
|
301
|
+
| Dx | integer | No | FK to definition.DefNum (DefCat=16) |
|
|
302
|
+
| PlannedAptNum | integer | No | FK to appointment.AptNum |
|
|
303
|
+
| PlaceService | string | No | Place of service enum (added v25.2.21) |
|
|
304
|
+
| Prosthesis | string | No | "" / "I" / "R" (added v25.2.21) |
|
|
305
|
+
| DateOriginalProsth | string | No | "yyyy-MM-dd" (added v25.2.21) |
|
|
306
|
+
| ClaimNote | string | No | E-claims note (added v25.2.21) |
|
|
307
|
+
| ClinicNum | integer | No | FK to clinic.ClinicNum |
|
|
308
|
+
| DiagnosticCode | string | No | ICD code (added v25.4.35) |
|
|
309
|
+
| IsPrincDiag | string | No | "true"/"false" (added v25.4.35) |
|
|
310
|
+
| CodeNum | integer | No | FK to procedurecode.CodeNum — cannot use with procCode (added v25.2.21) |
|
|
311
|
+
| procCode | string | No | Procedure code string — cannot use with CodeNum; treatment area must match |
|
|
312
|
+
| DateTP | string | No | "yyyy-MM-dd" (added v25.2.21) |
|
|
313
|
+
| SiteNum | integer | No | Site identifier (added v25.2.21) |
|
|
314
|
+
| ProcTime | string | No | "HH:mm:ss" (added v25.2.21) |
|
|
315
|
+
| ProcTimeEnd | string | No | "HH:mm:ss" (added v25.2.21) |
|
|
316
|
+
| Prognosis | integer | No | FK to definition.DefNum (DefCat=30) (added v25.2.21) |
|
|
317
|
+
| ToothNum | string | No | Updated if procedure code supports it |
|
|
318
|
+
| Surf | string | No | Updated if procedure code supports it |
|
|
319
|
+
| ToothRange | string | No | Comma/hyphen-separated tooth numbers |
|
|
320
|
+
| BillingNote | string | No | Account module note (added v25.2.21) |
|
|
321
|
+
| DiagnosticCode2 | string | No | Secondary ICD code (added v25.4.35) |
|
|
322
|
+
| DiagnosticCode3 | string | No | Tertiary ICD code (added v25.4.35) |
|
|
323
|
+
| DiagnosticCode4 | string | No | Quaternary ICD code (added v25.4.35) |
|
|
324
|
+
| Discount | decimal | No | Dollar discount amount (added v25.2.21) |
|
|
325
|
+
| IsDateProsthEst | string | No | "true"/"false" (added v25.2.21) |
|
|
326
|
+
| IcdVersion | integer | No | 9 or 10 (added v25.4.35) |
|
|
327
|
+
|
|
328
|
+
**Response:** object — updated procedure log with all fields
|
|
329
|
+
|
|
330
|
+
**Status Codes:**
|
|
331
|
+
| Code | Meaning |
|
|
332
|
+
|------|---------|
|
|
333
|
+
| 200 | OK |
|
|
334
|
+
| 400 | BadRequest |
|
|
335
|
+
| 404 | NotFound |
|
|
336
|
+
|
|
337
|
+
---
|
|
338
|
+
|
|
339
|
+
### PUT /procedurelogs/{ProcNum}/GroupNote
|
|
340
|
+
|
|
341
|
+
**Version:** 22.2.29
|
|
342
|
+
**Description:** Updates a group note procedure. The ProcNum must be a procedure with procCode "~GRP~".
|
|
343
|
+
|
|
344
|
+
**Path Parameters:**
|
|
345
|
+
| Name | Type | Required | Description |
|
|
346
|
+
|------|------|----------|-------------|
|
|
347
|
+
| ProcNum | integer | Yes | Must be a group note procedure (~GRP~) |
|
|
348
|
+
|
|
349
|
+
**Body Parameters:**
|
|
350
|
+
| Name | Type | Required | Description |
|
|
351
|
+
|------|------|----------|-------------|
|
|
352
|
+
| PatNum | integer | Yes | Patient identifier |
|
|
353
|
+
| Note | string | Yes | Group note text |
|
|
354
|
+
| doAppendNote | string | No (v25.2.38+) | "true" prepends current Note + two newlines to new Note; "false" replaces |
|
|
355
|
+
| isSigned | string | No (v25.2.38+) | "true" applies signature; "false" clears signature |
|
|
356
|
+
| ProvNum | integer | No (v25.3.36+) | Provider identifier |
|
|
357
|
+
|
|
358
|
+
**Response:** object — same fields as POST /procedurelogs/GroupNote response
|
|
359
|
+
|
|
360
|
+
**Status Codes:**
|
|
361
|
+
| Code | Meaning |
|
|
362
|
+
|------|---------|
|
|
363
|
+
| 200 | OK |
|
|
364
|
+
| 400 | BadRequest |
|
|
365
|
+
| 404 | NotFound |
|
|
366
|
+
|
|
367
|
+
---
|
|
368
|
+
|
|
369
|
+
### DELETE /procedurelogs/{ProcNum}
|
|
370
|
+
|
|
371
|
+
**Version:** 22.1
|
|
372
|
+
**Description:** Deletes a procedure log. Only procedures with status TP, TPi, or C (v23.1.11+) can be deleted.
|
|
373
|
+
|
|
374
|
+
**Path Parameters:**
|
|
375
|
+
| Name | Type | Required | Description |
|
|
376
|
+
|------|------|----------|-------------|
|
|
377
|
+
| ProcNum | integer | Yes | Primary key of the procedure to delete |
|
|
378
|
+
|
|
379
|
+
**Status Codes:**
|
|
380
|
+
| Code | Meaning |
|
|
381
|
+
|------|---------|
|
|
382
|
+
| 200 | OK |
|
|
383
|
+
| 400 | BadRequest |
|
|
384
|
+
| 404 | NotFound |
|
|
385
|
+
|
|
386
|
+
---
|
|
387
|
+
|
|
388
|
+
### DELETE /procedurelogs/{ProcNum}/GroupNote
|
|
389
|
+
|
|
390
|
+
**Version:** 22.3.8
|
|
391
|
+
**Description:** Deletes a group note procedure. The ProcNum must be a procedure with procCode "~GRP~".
|
|
392
|
+
|
|
393
|
+
**Path Parameters:**
|
|
394
|
+
| Name | Type | Required | Description |
|
|
395
|
+
|------|------|----------|-------------|
|
|
396
|
+
| ProcNum | integer | Yes | Must be a group note procedure (~GRP~) |
|
|
397
|
+
|
|
398
|
+
**Status Codes:**
|
|
399
|
+
| Code | Meaning |
|
|
400
|
+
|------|---------|
|
|
401
|
+
| 200 | OK |
|
|
402
|
+
| 400 | BadRequest |
|
|
403
|
+
| 404 | NotFound |
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
## Field Reference
|
|
408
|
+
|
|
409
|
+
### ProcStatus (enum: ProcStat)
|
|
410
|
+
| Value | DB Int | Description |
|
|
411
|
+
|-------|--------|-------------|
|
|
412
|
+
| None | 0 | Not used |
|
|
413
|
+
| TP | 1 | Treatment Plan |
|
|
414
|
+
| C | 2 | Complete |
|
|
415
|
+
| EC | 3 | Existing Current Provider |
|
|
416
|
+
| EO | 4 | Existing Other Provider |
|
|
417
|
+
| R | 5 | Referred Out |
|
|
418
|
+
| D | 6 | Deleted |
|
|
419
|
+
| Cn | 7 | Condition |
|
|
420
|
+
| TPi | 8 | Treatment Plan inactive |
|
|
421
|
+
|
|
422
|
+
### PlaceService (enum: PlaceOfService)
|
|
423
|
+
| Value | DB Int | Description |
|
|
424
|
+
|-------|--------|-------------|
|
|
425
|
+
| Office | 0 | Code 11 |
|
|
426
|
+
| PatientsHome | 1 | Code 12 |
|
|
427
|
+
| InpatHospital | 2 | Code 21 |
|
|
428
|
+
| OutpatHospital | 3 | Code 22 |
|
|
429
|
+
| SkilledNursFac | 4 | Code 31 |
|
|
430
|
+
| CustodialCareFacility | 5 | Code 33 |
|
|
431
|
+
| OtherLocation | 6 | Code 99 |
|
|
432
|
+
| MobileUnit | 7 | Code 15 |
|
|
433
|
+
| School | 8 | Code 03 |
|
|
434
|
+
| MilitaryTreatFac | 9 | Code 26 |
|
|
435
|
+
| FederalHealthCenter | 10 | Code 50 |
|
|
436
|
+
| PublicHealthClinic | 11 | Code 71 |
|
|
437
|
+
| RuralHealthClinic | 12 | Code 72 |
|
|
438
|
+
| EmergencyRoomHospital | 13 | Code 23 |
|
|
439
|
+
| AmbulatorySurgicalCenter | 14 | Code 24 |
|
|
440
|
+
| TelehealthOutsideHome | 15 | Code 02 |
|
|
441
|
+
| TelehealthInHome | 16 | Code 10 |
|
|
442
|
+
| OutreachSiteOrStreet | 17 | Code 27 |
|
|
443
|
+
|
|
444
|
+
### Prosthesis values
|
|
445
|
+
| Value | Description |
|
|
446
|
+
|-------|-------------|
|
|
447
|
+
| "" | No prosthesis |
|
|
448
|
+
| I | Initial placement |
|
|
449
|
+
| R | Replacement |
|
|
450
|
+
|
|
451
|
+
---
|
|
452
|
+
|
|
453
|
+
## Implementation Notes
|
|
454
|
+
- Procedures can never truly be deleted from the DB; status changes to "Deleted" (D=6).
|
|
455
|
+
- DELETE endpoint only works for ProcStatus TP, TPi, or C (C added v23.1.11).
|
|
456
|
+
- Cannot DELETE if procedure is attached to a claim, insurance payment, patient payment, adjustment, prescription, payment plan, referral, or ortho case; or if it is the last procedure from a preauthorization claim.
|
|
457
|
+
- `Priority`/`priority` are mutually exclusive; `Dx`/`dxName` are mutually exclusive.
|
|
458
|
+
- `CodeNum`/`procCode` are mutually exclusive in PUT; changing `procCode` fails if treatment areas differ.
|
|
459
|
+
- Empty strings for `ToothNum`, `Surf`, `ToothRange` in PUT are silently ignored.
|
|
460
|
+
- `CodeNum`, `procCode`, `Discount`, `ToothNum`, `Surf`, `ToothRange` cannot be updated if `ProcStatus=C`.
|
|
461
|
+
- Procedure code default notes are not automatically applied via API calls.
|
|
462
|
+
- Group Notes always use procCode "~GRP~" and ProcStatus EC.
|
|
463
|
+
- Before v25.3.36, `POST /procedurelogs/GroupNote` required all procedures to share the same ProcDate, ClinicNum, and ProvNum.
|
|
464
|
+
- Repeated ProcNums in group note are silently ignored.
|
|
465
|
+
- All date formats: "yyyy-MM-dd"; timestamps: "yyyy-MM-dd HH:mm:ss"; times: "HH:mm:ss".
|
|
466
|
+
|
|
467
|
+
---
|
|
468
|
+
|
|
469
|
+
## Related Resources
|
|
470
|
+
| Resource | Purpose |
|
|
471
|
+
|----------|---------|
|
|
472
|
+
| /procedurecodes | Lookup for CodeNum and procCode |
|
|
473
|
+
| /patients | Lookup for PatNum |
|
|
474
|
+
| /providers | Lookup for ProvNum |
|
|
475
|
+
| /appointments | Lookup for AptNum and PlannedAptNum |
|
|
476
|
+
| /definitions | Lookup for Priority (DefCat=20), Dx (DefCat=16), Prognosis (DefCat=30) |
|
|
477
|
+
| /insurancesubscriptions | Lookup for InsSubNum |
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# API: ProcNotes
|
|
2
|
+
|
|
3
|
+
**Source:** https://www.opendental.com/site/apiprocnotes.html
|
|
4
|
+
**Extracted:** 2026-04-22
|
|
5
|
+
**Base Path:** `/procnotes`
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
ProcNotes are notes attached to individual patient procedures (procedurelogs). The system creates a new note record each time a note is edited, preserving an archived history of all changes. Existing notes cannot be modified or deleted; only new notes can be created.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Endpoints
|
|
15
|
+
|
|
16
|
+
### GET /procnotes
|
|
17
|
+
|
|
18
|
+
**Version:** 24.2.29
|
|
19
|
+
**Description:** Retrieves procedure notes ordered by most recent. At least one of `PatNum` or `ProcNum` should be provided.
|
|
20
|
+
|
|
21
|
+
**Query Parameters:**
|
|
22
|
+
| Name | Type | Required | Default | Description |
|
|
23
|
+
|------|------|----------|---------|-------------|
|
|
24
|
+
| PatNum | integer | No | — | FK to patient.PatNum |
|
|
25
|
+
| ProcNum | integer | No | — | FK to procedurelog.ProcNum |
|
|
26
|
+
|
|
27
|
+
**Response:** array of objects
|
|
28
|
+
| Field | Type | Description |
|
|
29
|
+
|-------|------|-------------|
|
|
30
|
+
| ProcNoteNum | integer | Primary key |
|
|
31
|
+
| PatNum | integer | FK to patient.PatNum |
|
|
32
|
+
| ProcNum | integer | FK to procedurelog.ProcNum |
|
|
33
|
+
| EntryDateTime | string | Timestamp (yyyy-MM-dd HH:mm:ss) |
|
|
34
|
+
| UserNum | integer | FK to userod.UserNum — user who created the note |
|
|
35
|
+
| Note | string | Note content |
|
|
36
|
+
| SigIsTopaz | boolean | Whether signature is in Topaz format |
|
|
37
|
+
| isSigned | boolean | Whether note is digitally signed |
|
|
38
|
+
|
|
39
|
+
**Status Codes:**
|
|
40
|
+
| Code | Meaning |
|
|
41
|
+
|------|---------|
|
|
42
|
+
| 200 | OK |
|
|
43
|
+
| 400 | BadRequest (with explanation) |
|
|
44
|
+
| 404 | NotFound (with explanation) |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
### POST /procnotes
|
|
49
|
+
|
|
50
|
+
**Version:** 22.2
|
|
51
|
+
**Description:** Creates a new procedure note. Each creation generates an archived history entry. Notes with 50 or more consecutive blank lines are automatically cleaned.
|
|
52
|
+
|
|
53
|
+
**Body Parameters:**
|
|
54
|
+
| Name | Type | Required | Description |
|
|
55
|
+
|------|------|----------|-------------|
|
|
56
|
+
| PatNum | integer | Yes | FK to patient.PatNum |
|
|
57
|
+
| ProcNum | integer | Yes | FK to procedurelog.ProcNum |
|
|
58
|
+
| Note | string | Yes | Note content |
|
|
59
|
+
| isSigned | boolean | No (v24.2.29+) | "true" to digitally sign; default "false" |
|
|
60
|
+
| doAppendNote | boolean | No (v24.2.29+) | "true" prepends most recent note + two newlines; default "false" |
|
|
61
|
+
|
|
62
|
+
**Response:** object — same fields as GET response
|
|
63
|
+
|
|
64
|
+
**Status Codes:**
|
|
65
|
+
| Code | Meaning |
|
|
66
|
+
|------|---------|
|
|
67
|
+
| 201 | Created |
|
|
68
|
+
| 400 | BadRequest (with explanation) |
|
|
69
|
+
| 404 | NotFound (with explanation) |
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Implementation Notes
|
|
74
|
+
- Existing notes cannot be modified or deleted; every edit creates a new note record with the previous version preserved as history.
|
|
75
|
+
- Notes with 50 or more consecutive blank lines are automatically cleaned on creation.
|
|
76
|
+
- When `isSigned = "true"`, the digital signature displays as: "Digitally Signed by [API DeveloperName] Date Signed: [MM/dd/yyyy HH:mm:ss tt]".
|
|
77
|
+
- Consult the API Implementation documentation for full details on digital signature behavior.
|
|
78
|
+
- Results are returned ordered by most recent entry.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Related Resources
|
|
83
|
+
| Resource | Purpose |
|
|
84
|
+
|----------|---------|
|
|
85
|
+
| /procedurelogs | Lookup for ProcNum |
|
|
86
|
+
| /patients | Lookup for PatNum |
|