Theme switcher

Treatment Plans

Treatment Planning Data: Extract treatment plans and proposed procedures.

Attributes

Attribute

Type

Description

plan_id

integer

Treatment plan identifier

plan_status

string

Plan status (e.g. "Completed")

treatment_date

date

Date of treatment (YYYY-MM-DD)

patient_id

integer

Patient identifier

practitioner_id

integer

Practitioner identifier

treatment_type

string, nullable

Treatment type/category (if recorded)

item_code

string

Procedure/service item code

item_qty

integer

Quantity of items/procedures

tooth_number

string

Tooth number/surface (e.g. "47", "12 (MO)")

appointment_id

integer, nullable

Linked appointment identifier

item_fee

string

Fee charged (fixed-point, e.g. "289.00")

created_date_plan

date-time

Plan creation timestamp

created_by

string

User who created the plan

updated_date_plan

date-time, nullable

Plan last update timestamp

treatment_id

integer

Treatment record identifier

location_id

integer

Practice location identifier

plan_treatment_id

integer

Plan treatment line identifier

ada_item

string

ADA/standard procedure code

created_date_treatment

date-time

Treatment creation timestamp

updated_date_treatment

date-time

Treatment last update timestamp

created_date

date-time

Record creation timestamp

updated_date

date-time

Record last update timestamp

primary_plan_id

integer

Primary/parent plan identifier

is_active

integer (0/1)

Active status flag (0 = inactive, 1 = active)

is_deleted

integer (0/1)

Deletion status (0 = active, 1 = deleted)

Header Parameters

Content-Typestring

Body Parameters

customer_idstring Required

Unique customer identifier

from_datestring

Start date for filtering (YYYY-MM-DD format)

to_datestring

End date for filtering (YYYY-MM-DD format)

date_modifierstring

Filter mode - "All" (default), "Created", or "Updated"

modestring

Execution mode - "auto" (default), "stream", or "job"

output_formatstring

Response format - "ndjson" (default), "json", or "csv"

compressionstring

Compression type - "none" (default), "gzip", or "zip"

encryptionstring

Encryption - "false" (default) or "true"

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1
Was this section helpful?

What made this section unhelpful for you?