{
 "openapi": "3.1.0",
 "info": {
  "title": "Recalls (EHR)",
  "version": "20261030b",
  "description": "Patients to see again by a date. The daily job reminds each patient whose recall falls due and who has nothing booked (if they allow reminders), and marks the ones who have booked."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "recalls": {
    "type": "object",
    "required": [
     "patient_id",
     "reason",
     "due_date"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "readOnly": true
     },
     "recall_no": {
      "type": "string",
      "description": "Recall no",
      "readOnly": true
     },
     "patient_id": {
      "type": "string",
      "format": "uuid",
      "description": "Patient"
     },
     "provider_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provider"
     },
     "recall_type": {
      "type": "string",
      "description": "Type",
      "enum": [
       "follow_up",
       "screening",
       "immunization",
       "care_gap"
      ]
     },
     "reason": {
      "type": "string",
      "description": "What for"
     },
     "due_date": {
      "type": "string",
      "format": "date",
      "description": "Due"
     },
     "interval_months": {
      "type": "integer",
      "description": "Repeats every (months)"
     },
     "channel": {
      "type": "string",
      "description": "Remind by",
      "enum": [
       "email",
       "sms"
      ]
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "pending",
       "reminded",
       "booked",
       "completed",
       "cancelled"
      ]
     },
     "reminded_at": {
      "type": "string",
      "format": "date-time",
      "description": "Reminded at",
      "readOnly": true
     },
     "reminder_id": {
      "type": "string",
      "format": "uuid",
      "description": "Reminder id",
      "readOnly": true
     },
     "appointment_id": {
      "type": "string",
      "format": "uuid",
      "description": "Appointment id"
     },
     "notes": {
      "type": "string",
      "description": "Notes"
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ehr/recalls": {
   "get": {
    "summary": "list recalls",
    "operationId": "list_recalls_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create recalls",
    "operationId": "create_recalls_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/recalls/{id}": {
   "get": {
    "summary": "get recalls",
    "operationId": "get_recalls_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change recalls",
    "operationId": "change_recalls_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete recalls",
    "operationId": "delete_recalls_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/recalls/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_recalls_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}