Treatment Plans

Track accepted treatment, incomplete charted treatment, or denied treatment. Per OpenDental API.

What are Treatment Plans in OpenDental?

Treatment Plans (TreatPlans) track proposed or accepted treatment for a patient. TPStatus: "Active" (current plan), "Inactive" (draft/declined), or "Saved" (signed snapshot). Active/Inactive plans link to procedures via TreatPlanAttach; Saved plans use ProcTP (copies that don't change). Create an Inactive plan, add procedures, then mark Active or create a Saved copy for patient signature. Supports isSigned for digital signing. TPType is "Insurance" or "Discount". Procedures from treatment plans become ProcedureLogs when completed.

PatNum

TPStatus

Loading treatment plans...

TreatPlanNum	PatNum	DateTP	Heading	TPStatus	TPType	isSigned	Actions

Use filters and click "Load Treatment Plans" or leave PatNum empty to load all.

Create Treatment Plan (Inactive)

Creates an inactive treatplan. Add procedures via TreatPlanAttaches or ProcTPs.

PatNum *

Heading

Optional. Default "Inactive Treatment Plan".

TPType

Defaults to Insurance unless patient has Discount Plan.

Note

Defaults to TreatmentPlanNote preference.

Result:

Create Saved Treatment Plan from Active/Inactive

Creates an unsigned Saved treatplan from an existing Active or Inactive treatplan.

TreatPlanNum *

Heading

UserNumPresenter

FK userod.UserNum. Default 0.

Result:

Search & Update Treatment Plan

PatNum

TPStatus

Select a treatment plan to update:

Update Treatment Plan

—

DateTP

Only for TPStatus Saved. "yyyy-MM-dd"

Heading

ResponsParty

FK patient.PatNum. Patient responsible for approving treatment.

TPType

SignatureText

If TP Sheet has SignatureText field.

SignaturePracticeText

isSigned

"true" digitally signs for patient.

isSignedPractice

Note

Overwrites existing note.

Result:

Treatment Plans - GET Response

GET /treatplans. Params: PatNum, TPStatus (Saved/Active/Inactive), SecDateTEdit. Per OpenDental API.

Example Response:

[
  {
    "TreatPlanNum": 1786,
    "PatNum": 1897,
    "DateTP": "0001-01-01",
    "Heading": "Active Treatment Plan",
    "Note": "Please read this carefully...",
    "SigIsTopaz": "false",
    "ResponsParty": 0,
    "DocNum": 0,
    "TPStatus": "Active",
    "SecUserNumEntry": 12,
    "SecDateEntry": "2022-07-02",
    "SecDateTEdit": "2022-07-02 09:39:54",
    "UserNumPresenter": 0,
    "TPType": "Insurance",
    "DateTSigned": "0001-01-01 00:00:00",
    "DateTPracticeSigned": "0001-01-01 00:00:00",
    "SignatureText": "",
    "SignaturePracticeText": "",
    "isSigned": "false",
    "isSignedPractice": "false"
  }
]

Field Descriptions:

TreatPlanNum: Unique treatment plan ID (read-only)
PatNum: patient.PatNum
DateTP: Date of treatment plan. "yyyy-MM-dd". Only set when TPStatus=Saved.
Heading: Title shown at top of plan
Note: Note at bottom of plan
SigIsTopaz: Topaz signature device (read-only)
ResponsParty: FK patient.PatNum – who approves treatment
DocNum: Document number (read-only)
TPStatus: Saved | Active | Inactive
SecUserNumEntry: User who created (read-only)
SecDateEntry: Entry date (read-only)
SecDateTEdit: Last edit timestamp (read-only)
UserNumPresenter: User who presented plan
TPType: Insurance | Discount
DateTSigned: Patient signature date
DateTPracticeSigned: Practice signature date
SignatureText: Typed patient signature name
SignaturePracticeText: Typed practice signature name
isSigned: Patient has signed
isSignedPractice: Practice has signed

Create Treatment Plan - JSON

POST /treatplans. Creates inactive treatplan. Required: PatNum. Per OpenDental API.

Example Request:

{
  "PatNum": 31,
  "Heading": "Fillings",
  "Note": "ONLY AN ESTIMATE.",
  "TPType": "Insurance"
}

Fields:

PatNum *: Required. patient.PatNum
Heading: Optional. Default "Inactive Treatment Plan"
Note: Optional. Defaults to TreatmentPlanNote preference
TPType: Optional. Insurance | Discount

Create Saved Plan - JSON

POST /treatplans/Saved. Creates unsigned Saved from Active/Inactive. Required: TreatPlanNum. Per OpenDental API.

Example Request:

{
  "TreatPlanNum": 138,
  "Heading": "Saved Plan",
  "UserNumPresenter": 5
}

Fields:

TreatPlanNum *: Required. Existing Active/Inactive TreatPlanNum
Heading: Optional. Defaults to source plan heading
UserNumPresenter: Optional. FK userod.UserNum. Default 0

Update Treatment Plan - JSON

PUT /treatplans/{TreatPlanNum}. All fields optional. Per OpenDental API.

Example Request:

{
  "DateTP": "2024-01-27",
  "Heading": "Saved Treatment Plan",
  "Note": "Please read carefully...",
  "ResponsParty": 712,
  "TPType": "Insurance",
  "SignatureText": "Pamela Hoovey",
  "SignaturePracticeText": "Dr. Ben Jeong",
  "isSigned": "true",
  "isSignedPractice": "true"
}

Updatable Fields:

DateTP: Only if TPStatus=Saved. "yyyy-MM-dd"
Heading: Title at top
Note: Overwrites existing
ResponsParty: FK patient.PatNum – approver
TPType: Insurance | Discount
SignatureText: If TP Sheet has SignatureText field
SignaturePracticeText: If TP Sheet has SigBoxPractice
isSigned: "true" digitally signs for patient
isSignedPractice: "true" signs for practice