TreatPlanAttaches

For requests or help with our API
Post Reply
PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

TreatPlanAttaches

Post by PBECKER » Mon Oct 02, 2023 8:32 am

API Team,

We have treatment plans in "saved" status that we would like to update. For example if the TP has 5 procedure codes we would like to remove some of procedure codes and make existing treatment plan as saved or saved and signed.

Ref: https://opendental.com/site/apitreatplanattaches.html

TreatPlanAttaches PUT
Version Added: 23.2.17
Updates the Priority on a treatplanattach.
TreatPlanAttachNum: Required in the URL.
Priority: definition.DefNum where definition.Category=20.

Example Request:
PUT /treatplanattaches/70
{
"Priority": 149
}

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

SLeon
Posts: 482
Joined: Mon Mar 01, 2021 10:00 am

Re: TreatPlanAttaches

Post by SLeon » Mon Oct 02, 2023 9:16 am

Good morning,

From your other Treatment Plan forum thread:
DerekR wrote:
Thu Sep 21, 2023 8:11 am
TreatPlanAttaches GET does not have any parameters. I believe you are referring to the TreatPlans GET that does allow the parameter's of "Active" and "Saved". However TreatPlans GET never returns any of the procedure cost details that you are describing. ProcTPs GET does return these fields as these objects are copies of procedures that are attached to Saved treatment plans.

For clarification a treatplan stores all treatment plans, including Active, Inactive, and Saved treatment plans. Active and Inactive treatment plans use treatplanattach to reference attached procedures. As procedures are set complete, they get removed from active and inactive treatment plans. Saved treatment plans use proctp, which are copies of the procedure, and will not change after being saved.
The "snapshots" of procedures on Saved treatment plans are stored in the ProcTP table, not the TreatPlanAttach table.

If you want to edit these on a Saved treatment plan, you will need to use ProcTPs PUT.

If you want to delete these on a Saved treatment plan, we can add ProcTPs DELETE to our development list.

It is important to note that Open Dental does not allow editing or deleting of ProcTPs on saved treatment plans that have already been signed.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: TreatPlanAttaches

Post by PBECKER » Mon Oct 02, 2023 12:53 pm

Yes we're needing the ProcTPs DELETE as our goal is to have the ability to remove procedure codes from a saved treatment plan that is not signed.

Will this require a new Open Dental version upgrade?

Thank you Open Dental API Team

SLeon
Posts: 482
Joined: Mon Mar 01, 2021 10:00 am

Re: TreatPlanAttaches

Post by SLeon » Mon Oct 02, 2023 1:03 pm

Yes, we can add ProcTPs DELETE to our development list. Please remember that this would delete the ProcTP entry and not delete the original procedure and not delete the procedure code.

Once complete, all new API methods require the dental office to update to use the new feature.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: TreatPlanAttaches

Post by PBECKER » Mon Oct 02, 2023 1:19 pm

Is this the option only in order to remove procedure codes from a treatment plan that is in "saved" status?

If yes how long do we anticipate this new ProcTPs DELETE method?

One other question, procedure Codes that are removed from a "saved" TP would those proc codes be moved to the inactive TP or are the permanently removed from all TP's?

SLeon
Posts: 482
Joined: Mon Mar 01, 2021 10:00 am

Re: TreatPlanAttaches

Post by SLeon » Mon Oct 02, 2023 2:59 pm

1. Yes. The only way to remove items from a Saved Treatment Plan is by double-clicking the desired row and clicking the Delete button highlighted in this screenshot:

TreatmentPlans_Save_ProcTPDelete.gif
TreatmentPlans_Save_ProcTPDelete.gif (140.42 KiB) Viewed 1871 times

We will mimic this in ProcTPs DELETE.

2. This will take a few weeks to to develop and complete.

3. Lastly,
PBECKER wrote:
Mon Oct 02, 2023 1:19 pm
procedure Codes that are removed from a "saved" TP
You mean deleted ProcTPs. ProcedureCodes are detailed here and cannot be deleted via the API.
PBECKER wrote:
Mon Oct 02, 2023 1:19 pm
would those proc codes be moved to the inactive TP or are the permanently removed from all TP's?
Again, ProcTps are not in any way associated with an Inactive (or Active) treatment plan. They are only associated with Saved Treatment Plans. Deleting a ProcTP will only remove the information from that specific Saved Treatment Plan, not any other plan.

From our documentation:
TreatPlans with a TPStatus of "Active" or "Inactive" use TreatPlanAttach to reference attached procedures. TreatPlans with a TPStatus of "Saved" use ProcTp which are copies of the procedure, and will not change after being saved.

PBECKER
Posts: 125
Joined: Mon Jan 03, 2022 11:54 am

Re: TreatPlanAttaches

Post by PBECKER » Tue Oct 03, 2023 1:15 pm

Hello API Team

yes it would be great to have ProcTPs DELETE as that would allow us to remove Procedure code from a "saved treatment plan"

We will wait for the update thank you so much

Post Reply