Treat Plan Attaches

Procedures attached to a treatment plan (TPStatus Active or Inactive). For Saved treatment plans, use ProcTPs instead. Per OpenDental API TreatPlanAttaches.

TreatPlanAttaches — Used to show procedures attached to a TreatPlan with TPStatus Active or Inactive. Use TreatPlans GET to find the TreatPlanNum of an existing treatplan. Supports GET (list by TreatPlanNum), POST (attach procedure), PUT (update Priority). See TreatPlanAttach Database Schema.

TreatPlanNum *

Enter a TreatPlanNum and click "Load Attaches" to view.

TreatPlanAttachNum	TreatPlanNum	ProcNum	Priority	priority	Actions

Attach Procedure to Treatment Plan

Creates an association between a treatment plan and a procedure. TreatPlanNum and ProcNum are required. Priority is optional (definition.DefNum where definition.Category=20; default 0).

TreatPlanNum *

FK to treatplan.TreatPlanNum.

ProcNum *

FK to procedurelog.ProcNum.

Priority

Optional. definition.DefNum where definition.Category=20 (e.g. 148=Wait, 149=Low, 151=1, 159=Recmend). Default 0.

Result:

Update Priority on TreatPlanAttach

Updates the Priority (definition.DefNum, Category=20) for an existing treatplanattach.

TreatPlanAttachNum *

Priority *

definition.DefNum where definition.Category=20.

Result:

TreatPlanAttaches GET

GET /treatplanattaches?TreatPlanNum={TreatPlanNum}. TreatPlanNum is required (FK to treatplan.TreatPlanNum). Returns procedures attached to that plan (Active/Inactive). For Saved plans use ProcTPs. Per OpenDental API TreatPlanAttaches.

Example Response:

[
  { "TreatPlanAttachNum": 3211, "TreatPlanNum": 1845, "ProcNum": 1977, "Priority": 151, "priority": "1" },
  { "TreatPlanAttachNum": 3222, "TreatPlanNum": 1845, "ProcNum": 11018, "Priority": 159, "priority": "Recmend" },
  { "TreatPlanAttachNum": 3223, "TreatPlanNum": 1845, "ProcNum": 11017, "Priority": 148, "priority": "Wait" }
]

All response fields:

TreatPlanAttachNum — Primary key of the treatplanattach table.
TreatPlanNum — FK to treatplan.TreatPlanNum.
ProcNum — FK to procedurelog.ProcNum (the procedure attached).
Priority — definition.DefNum where definition.Category=20 (numeric).
priority — Description of Priority (e.g. "1", "Wait", "Recmend", "Low").

TreatPlanAttaches POST

Creates an association between a treatment plan and a procedure. Version 23.2.17.

Request body:

TreatPlanNum — Required. FK to treatplan.TreatPlanNum.
ProcNum — Required. FK to procedurelog.ProcNum.
Priority — Optional. definition.DefNum where definition.Category=20. Default 0.

Example request:

{"TreatPlanNum": 9, "ProcNum": 132, "Priority": 148}

Example response (201 Created):

{"TreatPlanAttachNum": 70, "TreatPlanNum": 9, "ProcNum": 132, "Priority": 148, "priority": "Wait"}

TreatPlanAttaches PUT

Updates the Priority on a treatplanattach. TreatPlanAttachNum in URL. Version 23.2.17.

URL:

PUT /treatplanattaches/{TreatPlanAttachNum}

Request body:

Priority — definition.DefNum where definition.Category=20.

Example request:

{"Priority": 149}

Example response (200 OK):

{"TreatPlanAttachNum": 70, "TreatPlanNum": 9, "ProcNum": 132, "Priority": 149, "priority": "Low"}