Skip to main content
PUT
Update Treatment Plan

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

treatment_plan_id
string
required

Body

application/json

Save edits to a treatment plan (title, snapshot, patient message).

title
string | null
snapshot
Snapshot · object | null

Edited structured snapshot

patientMessage
string | null

Response

Successful Response

Full treatment plan for the provider editor/review view.

id
string
required
patientId
string
required
sourceNoteId
string
required
title
string
required
status
enum<string>
required

Lifecycle of a treatment plan generated from a note.

Available options:
DRAFT,
SENT
snapshot
Snapshot · object
required
sharedWithPatient
boolean
required
templateId
string | null
eventId
string | null
locationId
string | null
sentVia
string[] | null
sharedDate
string<date-time> | null
patientMessage
string | null
createdDate
string<date-time> | null
updatedDate
string<date-time> | null