@rinse-dental/open-dental 0.1.1 → 0.1.4
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/deploy_notes.txt +21 -0
- package/dist/api/appointments.d.ts +1 -1
- package/dist/api/appointments.d.ts.map +1 -1
- package/dist/api/chartModules.d.ts +14 -0
- package/dist/api/chartModules.d.ts.map +1 -0
- package/dist/api/chartModules.js +21 -0
- package/dist/api/commlogs.d.ts +1 -1
- package/dist/api/commlogs.d.ts.map +1 -1
- package/dist/api/index.d.ts +8 -1
- package/dist/api/index.d.ts.map +1 -1
- package/dist/api/index.js +17 -4
- package/dist/api/patFields.d.ts +53 -0
- package/dist/api/patFields.d.ts.map +1 -0
- package/dist/api/patFields.js +87 -0
- package/dist/api/patients.d.ts +20 -1
- package/dist/api/patients.d.ts.map +1 -1
- package/dist/api/patients.js +34 -0
- package/dist/api/recalls.d.ts +84 -0
- package/dist/api/recalls.d.ts.map +1 -0
- package/dist/api/recalls.js +120 -0
- package/dist/api/schedules.d.ts +29 -0
- package/dist/api/schedules.d.ts.map +1 -0
- package/dist/api/schedules.js +47 -0
- package/dist/api/treatplans.d.ts +53 -0
- package/dist/api/treatplans.d.ts.map +1 -0
- package/dist/api/treatplans.js +77 -0
- package/dist/openDental.d.ts +38 -3
- package/dist/openDental.d.ts.map +1 -1
- package/dist/openDental.js +74 -4
- package/dist/types/{appointmentType.d.ts → appointmentTypes.d.ts} +1 -1
- package/dist/types/appointmentTypes.d.ts.map +1 -0
- package/dist/types/chartModuleTypes.d.ts +21 -0
- package/dist/types/chartModuleTypes.d.ts.map +1 -0
- package/dist/types/{commlogType.d.ts → commlogTypes.d.ts} +1 -1
- package/dist/types/commlogTypes.d.ts.map +1 -0
- package/dist/types/commlogTypes.js +2 -0
- package/dist/types/patFieldTypes.d.ts +23 -0
- package/dist/types/patFieldTypes.d.ts.map +1 -0
- package/dist/types/patFieldTypes.js +2 -0
- package/dist/types/recallTypes.d.ts +98 -0
- package/dist/types/recallTypes.d.ts.map +1 -0
- package/dist/types/recallTypes.js +2 -0
- package/dist/types/scheduleTypes.d.ts +28 -0
- package/dist/types/scheduleTypes.d.ts.map +1 -0
- package/dist/types/scheduleTypes.js +2 -0
- package/dist/types/treatPlanTypes.d.ts +72 -0
- package/dist/types/treatPlanTypes.d.ts.map +1 -0
- package/dist/types/treatPlanTypes.js +2 -0
- package/package.json +1 -1
- package/src/api/appointments.ts +1 -2
- package/src/api/chartModules.ts +25 -0
- package/src/api/commlogs.ts +1 -1
- package/src/api/index.ts +8 -2
- package/src/api/patFields.ts +112 -0
- package/src/api/patients.ts +50 -1
- package/src/api/recalls.ts +148 -0
- package/src/api/schedules.ts +65 -0
- package/src/api/treatplans.ts +97 -0
- package/src/openDental.ts +85 -4
- package/src/types/chartModuleTypes.ts +29 -0
- package/src/types/patFieldTypes.ts +24 -0
- package/src/types/recallTypes.ts +102 -0
- package/src/types/scheduleTypes.ts +28 -0
- package/src/types/treatPlanTypes.ts +75 -0
- package/dist/types/appointmentType.d.ts.map +0 -1
- package/dist/types/commlogType.d.ts.map +0 -1
- /package/dist/types/{appointmentType.js → appointmentTypes.js} +0 -0
- /package/dist/types/{commlogType.js → chartModuleTypes.js} +0 -0
- /package/src/types/{appointmentType.ts → appointmentTypes.ts} +0 -0
- /package/src/types/{commlogType.ts → commlogTypes.ts} +0 -0
package/src/openDental.ts
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
import HttpClient from "./utils/httpClient";
|
|
2
|
-
import Patients from "./api/patients";
|
|
3
2
|
import Appointments from "./api/appointments";
|
|
3
|
+
import ChartModules from "./api/chartModules";
|
|
4
|
+
import CommLogs from "./api/commlogs";
|
|
5
|
+
import PatFields from "./api/patFields";
|
|
6
|
+
import Patients from "./api/patients";
|
|
7
|
+
import ProcedureLogs from "./api/procedureLog";
|
|
8
|
+
import Recalls from "./api/recalls";
|
|
9
|
+
import TreatmentPlans from "./api/treatplans";
|
|
10
|
+
import Schedules from "./api/schedules";
|
|
11
|
+
|
|
4
12
|
|
|
5
13
|
class OpenDental {
|
|
6
14
|
private static httpClient: HttpClient;
|
|
@@ -19,6 +27,47 @@ class OpenDental {
|
|
|
19
27
|
this.httpClient = new HttpClient(baseURL, authToken);
|
|
20
28
|
}
|
|
21
29
|
|
|
30
|
+
/**
|
|
31
|
+
* Create a new instance of the Appointments API.
|
|
32
|
+
*/
|
|
33
|
+
public static Appointments() {
|
|
34
|
+
if (!this.httpClient) {
|
|
35
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
36
|
+
}
|
|
37
|
+
return new Appointments(this.httpClient);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Create a new instance of the ChartModule API endpoint.
|
|
43
|
+
*/
|
|
44
|
+
public static CommLogs() {
|
|
45
|
+
if (!this.httpClient) {
|
|
46
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
47
|
+
}
|
|
48
|
+
return new CommLogs(this.httpClient);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Create a new instance of the ChartModule API endpoint.
|
|
53
|
+
*/
|
|
54
|
+
public static ChartModules() {
|
|
55
|
+
if (!this.httpClient) {
|
|
56
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
57
|
+
}
|
|
58
|
+
return new ChartModules(this.httpClient);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Create a new instance of the Patients API.
|
|
63
|
+
*/
|
|
64
|
+
public static PatFields() {
|
|
65
|
+
if (!this.httpClient) {
|
|
66
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
67
|
+
}
|
|
68
|
+
return new PatFields(this.httpClient);
|
|
69
|
+
}
|
|
70
|
+
|
|
22
71
|
/**
|
|
23
72
|
* Create a new instance of the Patients API.
|
|
24
73
|
*/
|
|
@@ -30,14 +79,46 @@ class OpenDental {
|
|
|
30
79
|
}
|
|
31
80
|
|
|
32
81
|
/**
|
|
33
|
-
* Create a new instance of the
|
|
82
|
+
* Create a new instance of the ProcedureLogs API endpoint.
|
|
83
|
+
*/
|
|
84
|
+
public static ProcedureLogs() {
|
|
85
|
+
if (!this.httpClient) {
|
|
86
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
87
|
+
}
|
|
88
|
+
return new ProcedureLogs(this.httpClient);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Create a new instance of the Patients API.
|
|
34
93
|
*/
|
|
35
|
-
public static
|
|
94
|
+
public static Recalls() {
|
|
36
95
|
if (!this.httpClient) {
|
|
37
96
|
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
38
97
|
}
|
|
39
|
-
return new
|
|
98
|
+
return new Recalls(this.httpClient);
|
|
40
99
|
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* Create a new instance of the TreatmentPlans API.
|
|
103
|
+
*/
|
|
104
|
+
public static TreatmentPlans() {
|
|
105
|
+
if (!this.httpClient) {
|
|
106
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
107
|
+
}
|
|
108
|
+
return new TreatmentPlans(this.httpClient);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Create a new instance of the Schedules API.
|
|
113
|
+
*/
|
|
114
|
+
public static Schedules() {
|
|
115
|
+
if (!this.httpClient) {
|
|
116
|
+
throw new Error("OpenDental not initialized. Call OpenDental.initialize() first.");
|
|
117
|
+
}
|
|
118
|
+
return new Schedules(this.httpClient);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
|
|
41
122
|
}
|
|
42
123
|
|
|
43
124
|
export { OpenDental };
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents an appointment in the Open Dental system.
|
|
3
|
+
* Used in multiple appointment-related endpoints.
|
|
4
|
+
* @see https://www.opendental.com/site/apiappointments.html
|
|
5
|
+
*/
|
|
6
|
+
export interface PlannedAppointment {
|
|
7
|
+
AptNum?: number; // Unique identifier for the appointment
|
|
8
|
+
ProvNum?: number; // Provider number associated with the appointment
|
|
9
|
+
ItemOrder?: string; // Time pattern in 5-minute increments, e.g., "/XX/" for 20 minutes
|
|
10
|
+
minutes?: string; //The length of the appointment in minutes.
|
|
11
|
+
ProcDescript?: string; // Description of procedures linked to the appointment
|
|
12
|
+
Note?: string; //Appointment Note.
|
|
13
|
+
dateSched?: string; //DateTime of the linked scheduled appointment.
|
|
14
|
+
AptStatus?: AptStatus; //appointment.AptStatus.
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Appointment status options.
|
|
19
|
+
* @see https://www.opendental.com/site/apiappointments.html
|
|
20
|
+
*/
|
|
21
|
+
export type AptStatus =
|
|
22
|
+
| "Scheduled"
|
|
23
|
+
| "Complete"
|
|
24
|
+
| "UnschedList"
|
|
25
|
+
| "ASAP"
|
|
26
|
+
| "Broken"
|
|
27
|
+
| "Planned"
|
|
28
|
+
| "PtNote"
|
|
29
|
+
| "PtNoteCompleted";
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Parameters for fetching multiple patients.
|
|
3
|
+
* @see https://www.opendental.com/site/apipatfields.html
|
|
4
|
+
*/
|
|
5
|
+
export interface PatField {
|
|
6
|
+
PatFieldNum?: number; //Unique identifier for patfield
|
|
7
|
+
PatNum?: number; //Unique identifier for patient
|
|
8
|
+
FieldName?: string; // FK to patFieldDef.FieldName. Case sensitive.
|
|
9
|
+
FieldValue?: string; // Value for this specific patfield
|
|
10
|
+
SecDateTEdit?: string; //Timestamp representing when the PatField was last edited. In "yyyy-MM-dd HH:mm:ss" format.
|
|
11
|
+
SecDateEntry?: string; //"YYYY-MM-DD"
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export interface GetPatFieldsParams {
|
|
15
|
+
PatNum?: number; //(Optional after version 22.4.5) The patient's PatNum.
|
|
16
|
+
FieldName?: string; // (Optional after version 22.4.5) FK to patFieldDef.FieldName. Case sensitive.
|
|
17
|
+
SecDateTEdit?: string; //(Added in version 22.4.5) Timestamp representing when the PatField was last edited. In "yyyy-MM-dd HH:mm:ss" format.
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface AddUpdatePatFieldParams {
|
|
21
|
+
PatNum: number; //Required. The patient's PatNum.
|
|
22
|
+
FieldName: string; // Required. FK to PatFieldDef.FieldName. Case sensitive.
|
|
23
|
+
FieldValue: string; // Required. See the top of this page for more information. Relies on PatFieldDef.FieldType.
|
|
24
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GET Recalls object.
|
|
3
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
4
|
+
*/
|
|
5
|
+
export interface Recall {
|
|
6
|
+
RecallNum?: number; // Primary key
|
|
7
|
+
PatNum?: number; // FK to Patient table
|
|
8
|
+
DateDue?: string; // The date the recall is due. Based off previously completed recall procedures or insurance history. If blank, the patient has never had a recall procedure set complete.
|
|
9
|
+
DatePrevious?: string; // Date of previous treatment. String in "yyyy-mm-dd" format.
|
|
10
|
+
RecallInterval?: string; // The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for days. An example of 1 year, 6 months, and 20 days should be formatted as follows: '1y6m20d'. Default recalltype.DefaultInterval.
|
|
11
|
+
RecallStatus?: number; // FK to definition.DefNum where definition.Category=13. Default 0.
|
|
12
|
+
recallStatus?: string; // FK to definition.FieldValue where definition.Category=13
|
|
13
|
+
Note?: string; // An administrative note for staff use.
|
|
14
|
+
IsDisabled?: "true" | "false"; // Either "true" or "false". Default "false".
|
|
15
|
+
DateTStamp?: string; // datetime recall was created/updated
|
|
16
|
+
RecallTypeNum?: number; // Typically either "Prophy" or "Perio". RecallType is dependent upon Setup Recall and Recall Types.
|
|
17
|
+
DisableUntilBalance?: number; // Family balance must be less than this value for the recall to show in the recall list. Default 0.
|
|
18
|
+
DisableUntilDate?: string; // Recall will be disabled until this date. String in "yyyy-MM-dd" format.
|
|
19
|
+
DateScheduled?: string; // Date of their next recall. String in "yyyy-MM-dd" format.
|
|
20
|
+
Priority?: "Normal" | "ASAP"; // Either "Normal" or "ASAP". Default "Normal".
|
|
21
|
+
TimePatternOverride?: string; // Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* GET Recall List params.
|
|
26
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
27
|
+
*/
|
|
28
|
+
export interface RecallListParams {
|
|
29
|
+
DateStart?: string; // Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysPast preference.
|
|
30
|
+
DateEnd?: number; // Due date range. String in "yyyy-mm-dd" format. Default is based on RecallDaysFuture preference.
|
|
31
|
+
ProvNum?: string; // Provider. Default is all providers. Will consider PriProv and SecProv.
|
|
32
|
+
ClinicNum?: string; // Clinic. Default is all clinics. Use 0 for "Unassigned".
|
|
33
|
+
RecallType?: string; // Typically either "Prophy" or "Perio". Default is all RecallTypes stored in the preference.
|
|
34
|
+
IncludeReminded?: string; // Show patients that have already received reminders. Either "true" or "false". Default is false.
|
|
35
|
+
Offset?: number;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* GET Recall List object.
|
|
40
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
41
|
+
*/
|
|
42
|
+
export interface RecallList {
|
|
43
|
+
DueDate?: string; // The date the recall is due. Based off previously completed recall procedures or insurance history. If blank, the patient has never had a recall procedure set complete.
|
|
44
|
+
PatNum?: number; // FK to Patient table
|
|
45
|
+
Patient?: string; // Patient's name. Last, First.
|
|
46
|
+
Age?: string; // Patient's Age.
|
|
47
|
+
Type?: string; // RecallType due.
|
|
48
|
+
Interval?: string; //The length of time between each recall appointment for the recall type.
|
|
49
|
+
NumRemind?: string; //The number of reminders sent since the patient's last recall appointment.
|
|
50
|
+
LastReminder?: string; //The date the last reminder was sent.
|
|
51
|
+
Contact?: string; //The patient's Preferred Recall Method. E.g. Text:(541)555-1234
|
|
52
|
+
Status?: string; //Recall communication about a patient's unscheduled recall appointment. Example "Left Msg".
|
|
53
|
+
ClinicNum?: number; //ClinicNum of clinic patient is assigned to. Will be 0 if not using Clinics.
|
|
54
|
+
Note?: string; //Administrative note.
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* CREATE Recall params. Creates a recall object.
|
|
59
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
60
|
+
*/
|
|
61
|
+
export interface CreateRecallParams {
|
|
62
|
+
PatNum: number; // Required. FK to Patient table
|
|
63
|
+
RecallTypeNum: number; // Required. Typically either "Prophy" or "Perio". RecallType is dependent upon Setup Recall and Recall Types.
|
|
64
|
+
DateDue?: string; // The date the recall is due. Based off previously completed recall procedures or insurance history. If blank, the patient has never had a recall procedure set complete.
|
|
65
|
+
RecallInterval?: string; // The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for days. An example of 1 year, 6 months, and 20 days should be formatted as follows: '1y6m20d'. Default recalltype.DefaultInterval.
|
|
66
|
+
RecallStatus?: number; // FK to definition.DefNum where definition.Category=13. Default 0.
|
|
67
|
+
Note?: string; // An administrative note for staff use.
|
|
68
|
+
IsDisabled?: "true" | "false"; // Either "true" or "false". Default "false".
|
|
69
|
+
DisableUntilBalance?: number; // Family balance must be less than this value for the recall to show in the recall list. Default 0.
|
|
70
|
+
DisableUntilDate?: string; // Recall will be disabled until this date. String in "yyyy-MM-dd" format.
|
|
71
|
+
Priority?: "Normal" | "ASAP"; // Either "Normal" or "ASAP". Default "Normal".
|
|
72
|
+
TimePatternOverride?: string; // Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* EDIT Recall params. Updates a recall object.
|
|
77
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
78
|
+
*/
|
|
79
|
+
export interface UpdateRecallParams {
|
|
80
|
+
RecallNum: number; // Required. Primary key of recall to edit
|
|
81
|
+
DateDue?: string; // The date the recall is due. Based off previously completed recall procedures or insurance history. If blank, the patient has never had a recall procedure set complete.
|
|
82
|
+
RecallInterval?: string; // The interval between recalls. String that contains a digit followed by 'y' for years, 'm' for months, 'w' for weeks, or 'd' for days. An example of 1 year, 6 months, and 20 days should be formatted as follows: '1y6m20d'. Default recalltype.DefaultInterval.
|
|
83
|
+
RecallStatus?: number; // FK to definition.DefNum where definition.Category=13. Default 0.
|
|
84
|
+
Note?: string; // An administrative note for staff use.
|
|
85
|
+
IsDisabled?: "true" | "false"; // Either "true" or "false". Default "false".
|
|
86
|
+
DisableUntilBalance?: number; // Family balance must be less than this value for the recall to show in the recall list. Default 0.
|
|
87
|
+
DisableUntilDate?: string; // Recall will be disabled until this date. String in "yyyy-MM-dd" format.
|
|
88
|
+
Priority?: "Normal" | "ASAP"; // Either "Normal" or "ASAP". Default "Normal".
|
|
89
|
+
TimePatternOverride?: string; // Used to override recalltype.DefaultInterval. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* EDIT Recall Status params and object.
|
|
94
|
+
* @see https://www.opendental.com/site/apirecalls.html
|
|
95
|
+
*/
|
|
96
|
+
export interface UpdateRecallStatusParams {
|
|
97
|
+
PatNum: number; // Required. FK to Patient table
|
|
98
|
+
recallType: string; // Required. Typically either "Prophy" or "Perio". RecallType is dependent upon Setup Recall and Recall Types.
|
|
99
|
+
RecallStatus?: number; // FK to definition.DefNum where definition.Category=13. Default 0.
|
|
100
|
+
commlogMode?: "None" | "Email" | "Mail" | "Phone" | "InPerson" | "Text" | "EmailAndText" | "PhoneAndText"; // Optional. Either "None", "Email", "Mail", "Phone", "InPerson", "Text", "EmailAndText", or "PhoneAndText".
|
|
101
|
+
commlogNote?: string; // Optional. This text will be used instead of the default commlog.Note.
|
|
102
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Parameters for fetching multiple patients.
|
|
3
|
+
* @see https://www.opendental.com/site/apischedules.html
|
|
4
|
+
*/
|
|
5
|
+
export interface Schedule {
|
|
6
|
+
ScheduleNum?: number; //Unique identifier for patfield
|
|
7
|
+
SchedDate?: string; //"YYYY-MM-DD"
|
|
8
|
+
StartTime?: string; //"12:00:00"
|
|
9
|
+
StopTime?: string; //"12:00:00"
|
|
10
|
+
SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
|
|
11
|
+
ProvNum?: number; //FK to provider.ProvNum.
|
|
12
|
+
BlockoutType?: string; //"YYYY-MM-DD"
|
|
13
|
+
blockoutType?: string; //"YYYY-MM-DD"
|
|
14
|
+
Note?: string; //"YYYY-MM-DD"
|
|
15
|
+
operatories?: string; //"YYYY-MM-DD"
|
|
16
|
+
EmployeeNum?: string; //"YYYY-MM-DD"
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export interface GetSchedulesParams {
|
|
20
|
+
date?: string; //"YYYY-MM-DD", For a single day. Today's date by default.
|
|
21
|
+
dateStart?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
|
|
22
|
+
dateEnd?: string; //"YYYY-MM-DD" For a date range, inclusive of both dates.
|
|
23
|
+
SchedType?: "Practice" | "Provider" | "Blockout" | "Employee" | "WebSchedASAP"; //Either "Practice", "Provider", "Blockout", "Employee", or "WebSchedASAP".
|
|
24
|
+
BlockoutDefNum?: string; //Definition.DefNum where definition.Category=25.
|
|
25
|
+
ProvNum?: number; //FK to provider.ProvNum.
|
|
26
|
+
EmployeeNum?: number; //FK to employee.EmployeeNum.
|
|
27
|
+
Offset?: number; //pagination
|
|
28
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GET TreatPlans object.
|
|
3
|
+
* @see https://www.opendental.com/site/apitreatplans.html
|
|
4
|
+
*/
|
|
5
|
+
export interface TreatmentPlan {
|
|
6
|
+
TreatPlanNum?: number; // Primary key
|
|
7
|
+
PatNum?: number; // FK to Patient table
|
|
8
|
+
DateTP?: string; //
|
|
9
|
+
Heading?: string; // Optional. Default "Inactive Treatment Plan".
|
|
10
|
+
Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
|
|
11
|
+
SigIsTopaz?: "true" | "false"; //
|
|
12
|
+
ResponsParty?: number; // FK to patient.PatNum. The patient responsible for approving the treatment.
|
|
13
|
+
DocNum?: number; //
|
|
14
|
+
TPStatus?: string; // "Saved", "Active" or "Inactive"
|
|
15
|
+
SecUserNumEntry?: number; //
|
|
16
|
+
SecDateEntry?: string; //
|
|
17
|
+
SecDateTEdit?: string; //
|
|
18
|
+
UserNumPresenter?: number; //
|
|
19
|
+
TPType?: "Insurance" | "Discount"; // Either "Insurance" or "Discount".
|
|
20
|
+
DateTSigned?: string; //
|
|
21
|
+
DateTPracticeSigned?: string; //
|
|
22
|
+
SignatureText?: string; // The typed name of the person who signed the patient signature.
|
|
23
|
+
SignaturePracticeText?: string; // The typed name of the person who signed the practice signature.
|
|
24
|
+
isSigned?: "true" | "false"; //
|
|
25
|
+
isSignedPractice?: "true" | "false"; //
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Get TreatPlans Params. Returns TreatPlan object
|
|
30
|
+
* @see https://www.opendental.com/site/apitreatplans.html
|
|
31
|
+
*/
|
|
32
|
+
export interface GetTreatmentPlanParams {
|
|
33
|
+
PatNum?: number; // FK to Patient table
|
|
34
|
+
SecDateTEdit?: string; // Only include TreatPlans with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.
|
|
35
|
+
TPStatus?: "Saved" | "Active" | "Inactive"; // Either "Saved", "Active", or "Inactive". Default all.
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* POST TreatPlans Params. Returns TreatPlan object
|
|
40
|
+
* @see https://www.opendental.com/site/apitreatplans.html
|
|
41
|
+
*/
|
|
42
|
+
export interface CreateTreatmentPlanParams {
|
|
43
|
+
PatNum: number; // Required. FK to Patient table
|
|
44
|
+
Heading?: string; // Optional. Defaults to the heading of the supplied Treatment Plan.
|
|
45
|
+
Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
|
|
46
|
+
TPType?: "Insurance" | "Discount"; // Optional. Either "Insurance" or "Discount". If the patient is subscribed to a Discount Plan, this will default to "Discount". Otherwise, defaults to "Insurance".
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* POST Save TreatPlans Params. Returns TreatPlan object.
|
|
51
|
+
* Creates an unsigned Saved TreatPlan from an existing Active or Inactive TreatPlan.
|
|
52
|
+
* @see https://www.opendental.com/site/apitreatplans.html
|
|
53
|
+
*/
|
|
54
|
+
export interface SaveTreatmentPlanParams {
|
|
55
|
+
TreatPlanNum: number; // Required. PK of treatment plan to be saved
|
|
56
|
+
Heading?: string; // Optional. Defaults to the heading of the supplied Treatment Plan.
|
|
57
|
+
UserNumPresenter?: number; // Optional. FK to userod.UserNum. Default 0.
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* PUT TreatPlans object.
|
|
62
|
+
* @see https://www.opendental.com/site/apitreatplans.html
|
|
63
|
+
*/
|
|
64
|
+
export interface UpdateTreatmentPlanParams {
|
|
65
|
+
TreatPlanNum: number; // Required in the URL.
|
|
66
|
+
DateTP?: string; // The date of the treatment plan. Can only be set if TPStatus is "Saved". String in "yyyy-MM-dd" format.
|
|
67
|
+
Heading?: string; // The heading that shows at the top of the treatment plan.
|
|
68
|
+
Note?: string; // A note specific to this treatment plan that shows at the bottom. Overwrites existing note.
|
|
69
|
+
ResponsParty?: number; // FK to patient.PatNum. The patient responsible for approving the treatment.
|
|
70
|
+
TPType?: "Insurance" | "Discount"; // Either "Insurance" or "Discount".
|
|
71
|
+
SignatureText?: string; // The typed name of the person who signed the patient signature.
|
|
72
|
+
SignaturePracticeText?: string; // The typed name of the person who signed the practice signature.
|
|
73
|
+
isSigned?: "true" | "false"; // Either "true" or "false". True updates the treatplan Signature, digitally signs for the patient, and overwrites existing signature. False clears the exisiting treatplan Signature.
|
|
74
|
+
isSignedPractice?: "true" | "false"; // Either "true" or "false". True updates the treatplan SignaturePractice, digitally signs for the practice, and overwrites existing signature. False clears the exisiting treatplan SignaturePractice.
|
|
75
|
+
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"appointmentType.d.ts","sourceRoot":"","sources":["../../src/types/appointmentType.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACD,MAAM,WAAW,aAAa;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAEL;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,SAAS,CAAC,EAAE,QAAQ,GAAG,WAAW,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,cAAc,GAAG,QAAQ,CAAC;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,UAAU,GACV,aAAa,GACb,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,iBAAiB,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,MAAM,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"commlogType.d.ts","sourceRoot":"","sources":["../../src/types/commlogType.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IACzG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CAClD;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;IACxG,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CACpD"}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|