@rinse-dental/open-dental 2.0.1 → 2.1.1

package/src/types/diseaseTypes.ts

@@ -0,0 +1,50 @@
+/**
+ * Represents a Disease (Problem) that is assigned to a patient in the Open Dental system.
+ * @see https://www.opendental.com/site/apidiseases.html
+ */
+export interface Disease {
+    DiseaseNum?: number; //PK
+    PatNum?: number; // FK to patient
+    DiseaseDefNum?: number; // FK to DiseaseDef
+    diseaseDefName?: string; //
+    PatNote?: string; // 
+    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Either "Active", "Resolved" or "Inactive". Default "Active".
+    DateStart?: string; //String in "yyyy-MM-dd" format. 
+    DateStop?: string; //String in "yyyy-MM-dd" format.
+  }
+
+  /**
+   * Parameters for GET diseases attached to one or more patients.
+   * @see https://www.opendental.com/site/apidiseases.html
+   */
+  export interface GetDiseasesParams {
+    PatNum?: number; // FK to patient.PatNum. Optional (Optional after version 24.2.5).
+    Offset?: number; // Optional pagination.
+  }
+
+  /**
+   * Parameters for attaching a diseaseDef (Problem) to a patient.
+   * @see https://www.opendental.com/site/apidiseases.html
+   */
+  export interface AddDiseaseParams {
+    PatNum: number; // Required. FK to patient
+    DiseaseDefNum?: number; // Rarely used. Just use diseaseDefName instead, which handles insertion of DiseaseDef automatically.
+    diseaseDefName?: string; // Required unless you choose to use DiseaseDefNum.
+    PatNote?: string; // Optional
+    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Optional. Either "Active", "Resolved" or "Inactive". Default "Active".
+    DateStart?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
+    DateStop?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
+  }
+  
+  /**
+   * Parameters for updating a diseaseDef (Problem) attached to a patient.
+   * @see https://www.opendental.com/site/apidiseases.html
+   */
+  export interface UpdateDiseaseParams {
+    DiseaseNum: number; // Required.
+    PatNote?: string; // Optional. Will overwrite existing note.
+    ProbStatus?: 'Active' | 'Resolved' | 'Inactive'; // Optional. Either "Active", "Resolved" or "Inactive".
+    DateStart?: string; // Optional. String in "yyyy-MM-dd" format. 
+    DateStop?: string; // Optional. String in "yyyy-MM-dd" format.
+  }
+  

package/src/types/medicationPatTypes.ts

@@ -0,0 +1,50 @@
+/**
+ * Represents an Medication that is assigned to a patient in the Open Dental system.
+ * @see https://www.opendental.com/site/apimedicationpats.html
+ */
+export interface MedicationPat {
+    MedicationPatNum?: number; //PK
+    PatNum?: number; // FK to patient
+    medName?: string; //
+    MedicationNum?: number; // FK to Medication
+    PatNote?: string; // 
+    DateStart?: string; // String in "yyyy-MM-dd" format. Default "0001-01-01".
+    DateStop?: string; // String in "yyyy-MM-dd" format. Default "0001-01-01".
+    ProvNum?: number; // FK to Provider
+  }
+
+  /**
+   * Parameters for GET medications attached to a patient.
+   * @see https://www.opendental.com/site/apimedicationpats.html
+   */
+  export interface GetMedicationPatsParams {
+    PatNum: number; // Required. FK to patient.PatNum. Gets all medications for a specified patient.
+    Offset?: number; // Optional. Pagination.
+  }
+
+  /**
+   * Parameters for attaching a medication to a patient.
+   * @see https://www.opendental.com/site/apimedicationpats.html
+   */
+  export interface AddMedicationPatParams {
+    PatNum: number; // FK to patient
+    medName?: string; // Required if MedicationNum is not used. Tries to match to an existing medication. If a new medication must be created, it will be assumed to be generic rather than brand. For more control, use medication POST.
+    MedicationNum?: number; // Rarely used. Just use medName instead, which handles insertion of a Medication automatically. If MedicationNum is used, then medName is not required.
+    PatNote?: string; // Optional. String for notes specific to this patient's medication.
+    DateStart?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
+    DateStop?: string; // Optional. String in "yyyy-MM-dd" format. Default "0001-01-01".
+    ProvNum?: number; // Optional. Default is 0.
+  }
+  
+  /**
+   * Parameters for updating a medication attached to a patient.
+   * @see https://www.opendental.com/site/apimedicationpats.html
+   */
+  export interface UpdateMedicationPatParams {
+    MedicationPatNum: number; // Required.
+    PatNote?: string; // Optional. String for notes specific to this patient's medication.
+    DateStart?: string; // Optional. String in "yyyy-MM-dd" format.
+    DateStop?: string; // Optional. String in "yyyy-MM-dd" format.
+    ProvNum?: number; // Optional.
+  }
+