{
 "openapi": "3.1.0",
 "info": {
  "title": "Patient Portal (EHR)",
  "version": "20261030b",
  "description": "Portal invitations, activation and reminder preferences. Invite sends the patient a one-time link to the patient portal (statements, appointments and cases), with a second step at sign-in; Add a proxy lets a parent, guardian or carer see the record too."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "portal-accounts": {
    "type": "object",
    "required": [
     "patient_id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "patient_id": {
      "type": "string",
      "format": "uuid",
      "description": "Patient"
     },
     "user_id": {
      "type": "string",
      "format": "uuid",
      "description": "Sign-in account"
     },
     "email": {
      "type": "string",
      "description": "Email"
     },
     "phone": {
      "type": "string",
      "description": "Phone"
     },
     "status": {
      "type": "string",
      "description": "Status",
      "enum": [
       "needs_email",
       "invited",
       "active",
       "locked",
       "disabled",
       "expired"
      ]
     },
     "invited_at": {
      "type": "string",
      "format": "date-time",
      "description": "Invited at",
      "readOnly": true
     },
     "activated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Activated at",
      "readOnly": true
     },
     "last_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last login at",
      "readOnly": true
     },
     "login_count": {
      "type": "integer",
      "description": "Login count",
      "readOnly": true
     },
     "proxy_for_patient_id": {
      "type": "string",
      "format": "uuid",
      "description": "Proxy for patient id"
     },
     "proxy_relationship": {
      "type": "string",
      "description": "Proxy relationship"
     },
     "sms_reminders": {
      "type": "boolean",
      "description": "SMS reminders"
     },
     "email_reminders": {
      "type": "boolean",
      "description": "Email reminders"
     },
     "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
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/ehr/portal-accounts": {
   "get": {
    "summary": "list portal-accounts",
    "operationId": "list_portal_accounts_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "create portal-accounts",
    "operationId": "create_portal_accounts_1_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/portal-accounts/{id}": {
   "get": {
    "summary": "get portal-accounts",
    "operationId": "get_portal_accounts_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "change portal-accounts",
    "operationId": "change_portal_accounts_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "delete portal-accounts",
    "operationId": "delete_portal_accounts_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/ehr/portal-accounts/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_portal_accounts_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"
     }
    }
   }
  }
 }
}