{
 "openapi": "3.1.0",
 "info": {
  "title": "Patients (EHR)",
  "version": "20261030b",
  "description": "Read and maintain patients records (ehr.patients)."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "patients": {
    "type": "object",
    "required": [
     "mrn",
     "first_name",
     "last_name",
     "date_of_birth"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "mrn": {
      "type": "string",
      "description": "Medical record number"
     },
     "first_name": {
      "type": "string",
      "description": "First name"
     },
     "last_name": {
      "type": "string",
      "description": "Last name"
     },
     "native_name": {
      "type": "string",
      "description": "Name in native script"
     },
     "date_of_birth": {
      "type": "string",
      "format": "date",
      "description": "Date of birth"
     },
     "sex_at_birth": {
      "type": "string",
      "description": "Sex at birth",
      "enum": [
       "female",
       "male",
       "other",
       "unknown"
      ]
     },
     "gender_identity": {
      "type": "string",
      "description": "Gender identity"
     },
     "preferred_language": {
      "type": "string",
      "description": "Preferred language"
     },
     "interpreter_needed": {
      "type": "boolean",
      "description": "Interpreter needed"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "address": {
      "type": "string",
      "description": "Address"
     },
     "restricted_chart": {
      "type": "boolean",
      "description": "Restricted chart"
     },
     "is_active": {
      "type": "boolean",
      "description": "Is active"
     },
     "org_unit_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org unit id",
      "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
     },
     "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
     },
     "city": {
      "type": "string",
      "description": "City"
     },
     "state_code": {
      "type": "string",
      "description": "State"
     },
     "postal_code": {
      "type": "string",
      "description": "ZIP code"
     },
     "bad_address": {
      "type": "boolean",
      "description": "Mail came back (hold statements)"
     },
     "in_collections": {
      "type": "boolean",
      "description": "With a collection agency"
     },
     "statement_hold": {
      "type": "string",
      "description": "Hold statements because"
     },
     "reminders_opt_out": {
      "type": "boolean",
      "description": "No reminders"
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ehr/patients": {
   "get": {
    "summary": "list patients",
    "operationId": "list_patients_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create patients",
    "operationId": "create_patients_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/patients/{id}": {
   "get": {
    "summary": "get patients",
    "operationId": "get_patients_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change patients",
    "operationId": "change_patients_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete patients",
    "operationId": "delete_patients_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "patch": {
    "summary": "Patch patients",
    "operationId": "action_patients_3_5",
    "description": "Body keys: confirm_duplicate, duplicate_reason, review_later",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/patients/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_patients_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"
     }
    }
   }
  },
  "/api/ehr/patients/check-duplicates": {
   "post": {
    "summary": "Check duplicates",
    "operationId": "action_patients_0_5",
    "description": "Body keys: firstName, lastName*, dateOfBirth",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/patients/{id}/chart": {
   "get": {
    "summary": "Chart",
    "operationId": "action_patients_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}