Recalls

Recalls by Patient - GET Response

GET /recalls returns an array. Optional param: PatNum. Per OpenDental API.

Example Response:

[
  {
    "RecallNum": 40,
    "PatNum": 38,
    "DateDue": "2022-09-09",
    "DatePrevious": "0001-01-01",
    "RecallInterval": "6m1d",
    "RecallStatus": 142,
    "recallStatus": "Mailed Postcard",
    "Note": "",
    "IsDisabled": "false",
    "DateTStamp": "2021-07-21 10:05:47",
    "RecallTypeNum": 6,
    "DisableUntilBalance": 0.0,
    "DisableUntilDate": "0001-01-01",
    "DateScheduled": "0001-01-01",
    "Priority": "Normal",
    "TimePatternOverride": ""
  }
]

Field Descriptions:

RecallNum: Unique recall ID (read-only)
PatNum: Patient.PatNum
DateDue: Date used for recall reports. "yyyy-MM-dd"
DatePrevious: Previous recall date
RecallInterval: Interval between recalls (e.g. 6m1d = 6 months 1 day)
RecallStatus: FK definition.DefNum where definition.Category=13
recallStatus: Human-readable status (e.g. "Mailed Postcard")
Note: Administrative note for staff
IsDisabled: "true" or "false"
DateTStamp: Last modified timestamp
RecallTypeNum: FK recalltype.RecallTypeNum (Prophy, Perio, Exam, etc.)
DisableUntilBalance: Recall hidden until family balance < this value
DisableUntilDate: Recall disabled until this date. "yyyy-MM-dd"
DateScheduled: Date recall was scheduled
Priority: "Normal" or "ASAP"
TimePatternOverride: Override recalltype.DefaultInterval. X and / only.

Create Recall - JSON Structure

POST /recalls. Required: PatNum, RecallTypeNum. A patient may only have one recall per RecallType. Per OpenDental API.

Example Request:

{
  "PatNum": 38,
  "RecallTypeNum": 8,
  "DateDue": "2022-09-09",
  "RecallInterval": "0y6m0w1d",
  "RecallStatus": 142,
  "Note": "New patient.",
  "IsDisabled": "false",
  "DisableUntilBalance": 0,
  "DisableUntilDate": "0001-01-01",
  "Priority": "Normal",
  "TimePatternOverride": ""
}

Example Response (201 Created):

{
  "RecallNum": 40,
  "PatNum": 38,
  "DateDue": "0001-01-01",
  "DatePrevious": "0001-01-01",
  "RecallInterval": "6m1d",
  "RecallStatus": 142,
  "recallStatus": "Mailed Postcard",
  "Note": "New patient.",
  "IsDisabled": "false",
  "DateTStamp": "2024-09-02 09:31:19",
  "RecallTypeNum": 8,
  "DisableUntilBalance": 0.0,
  "DisableUntilDate": "0001-01-01",
  "DateScheduled": "0001-01-01",
  "Priority": "Normal",
  "TimePatternOverride": ""
}

Field Reference (Create):

PatNum *: Required. FK patient.PatNum
RecallTypeNum *: Required. FK recalltype.RecallTypeNum. One recall per type per patient.
DateDue: Optional. "yyyy-MM-dd". Date used for recall reports.
RecallInterval: Optional. e.g. "1y6m20d" (1y=year, m=month, w=week, d=day). Default from RecallType.
RecallStatus: Optional. FK definition.DefNum (Category=13). Default 0.
Note: Optional. Administrative note for staff.
IsDisabled: Optional. "true" or "false". Default "false".
DisableUntilBalance: Optional. Recall hidden until family balance < this. Default 0.
DisableUntilDate: Optional. "yyyy-MM-dd". Recall disabled until date.
Priority: Optional. "Normal" or "ASAP". Default "Normal".
TimePatternOverride: Optional. X and / characters only. Override recalltype.DefaultInterval.

Recalls

Create Recall

Result:

Search & Update Recall

Select a recall to update:

Update Recall

Result:

Recalls

Create Recall

Result:

Search & Update Recall

Select a recall to update:

Update Recall

Result:

Recalls by Patient - GET Response

Example Response:

Field Descriptions:

Create Recall - JSON Structure

Example Request:

Example Response (201 Created):

Field Reference (Create):

Search & Update Recall

PUT Request (all fields optional):

Updatable Fields: