Elderwise Documentation

Authentication & Users

Secure access to the platform with role-based permissions for care teams, caregivers, and administrators, including identity lifecycle controls and sign-in audit trails.

• POST /auth/login - Authenticate users and receive access tokens with device context -> Returns AuthTokenPair<UserContext>
• POST /auth/refresh - Refresh expired access tokens with rotation protection -> Returns AuthTokenPair<SessionMetadata>
• POST /auth/logout - Revoke current refresh token and active session -> Returns ActionResult<SessionRevocation>
• GET /users/me - Retrieve current user profile and effective scopes -> Returns UserProfile
• PUT /users/me - Update user profile and preferences with validation -> Returns UserProfile
• POST /users/invite - Invite new team members with role presets -> Returns InvitationResult
• GET /users?role=care_manager&page=1&pageSize=25 - List users with pagination and filters -> Returns PaginatedList<UserSummary>
• PATCH /users/:id/roles - Update role assignments with policy checks -> Returns UserRoleAssignment
• POST /users/:id/mfa/enroll - Enroll authenticator app or SMS fallback -> Returns MfaEnrollmentChallenge
• GET /audit/access-events?userId=:id - Retrieve sign-in and token activity logs -> Returns PaginatedList<AccessAuditEvent>

Care Workflows

Manage care plans, check-ins, and coordination tasks across the care journey with escalation automation and multidisciplinary collaboration.

• GET /care-plans?patientId=:id&status=active - List care plans for a patient -> Returns PaginatedList<CarePlanSummary>
• POST /care-plans - Create a new care plan with goals and interventions -> Returns CarePlan
• GET /care-plans/:id - Retrieve care plan details, milestones, and owners -> Returns CarePlan
• PUT /care-plans/:id - Update care plan details with optimistic locking -> Returns CarePlan
• POST /care-plans/:id/tasks - Add a workflow task assigned to care team members -> Returns CareTask
• PATCH /care-plans/:id/tasks/:taskId/status - Update task state and completion evidence -> Returns CareTask
• GET /check-ins?patientId=:id&from=2026-01-01 - Retrieve daily check-in responses -> Returns PaginatedList<CheckInResponse>
• POST /check-ins - Submit a new check-in from caregiver, patient, or mobile app -> Returns CheckInResponse
• POST /check-ins/:id/escalate - Trigger nurse escalation workflow for risk signals -> Returns EscalationCase
• GET /care-workflows/templates - List reusable care workflow templates -> Returns List<WorkflowTemplate>

Patients & Records

Patient information management with HIPAA-compliant data handling, consent tracking, and timeline visibility for longitudinal care coordination.

• GET /patients?page=1&pageSize=25&status=active - List patients in your organization -> Returns PaginatedList<PatientSummary>
• GET /patients/:id - Retrieve patient demographics, identifiers, and care status -> Returns Patient
• POST /patients - Register a new patient with consent baseline -> Returns Patient
• PATCH /patients/:id - Update patient record fields with audit logging -> Returns Patient
• GET /patients/:id/timeline - View patient care timeline with event filtering -> Returns PaginatedList<TimelineEvent>
• GET /patients/:id/documents - Access patient documents and metadata -> Returns PaginatedList<DocumentSummary>
• POST /patients/:id/consents - Record HIPAA and PDPA consent artifacts -> Returns ConsentRecord
• GET /patients/:id/vitals?window=30d - Retrieve vitals trend snapshots -> Returns VitalsTrendSet
• POST /patients/:id/clinical-notes - Add structured care note entries -> Returns ClinicalNote
• GET /patients/:id/care-team - List assigned internal and external care participants -> Returns List<CareTeamMember>

Notifications & Alerts

Configure and manage medication reminders, appointment alerts, and care team notifications with escalation policies and delivery observability.

• GET /notifications - List notification preferences by channel and role -> Returns NotificationPreferenceSet
• PUT /notifications/settings - Update organization notification settings -> Returns NotificationPreferenceSet
• POST /reminders - Create medication or appointment reminder rules -> Returns ReminderRule
• GET /alerts?status=open&priority=high - View active alerts for care team -> Returns PaginatedList<Alert>
• POST /alerts/acknowledge - Acknowledge and resolve alerts with reason codes -> Returns AlertActionResult
• POST /alerts/:id/escalate - Escalate unresolved alerts to designated responders -> Returns EscalationDispatch
• GET /alerts/rules - Retrieve configured clinical and operational alert rules -> Returns List<AlertRule>
• POST /alerts/rules - Create threshold or event-based alert logic -> Returns AlertRule
• GET /notifications/templates - List message templates with localization metadata -> Returns List<NotificationTemplate>
• POST /notifications/test-message - Send a test message to validate channel setup -> Returns DeliveryTestResult

Integrations & Webhooks

Connect with EHR systems and receive real-time updates via webhooks, including HL7 and FHIR interoperability workflows for enterprise deployments.

• GET /integrations - List active integrations and health states -> Returns PaginatedList<IntegrationSummary>
• POST /integrations/ehr - Configure EHR connection credentials and scopes -> Returns EhrIntegration
• GET /integrations/ehr/:id/status - Retrieve sync status and error diagnostics -> Returns IntegrationStatus
• POST /integrations/hl7/channels - Create HL7 feed channel configuration -> Returns Hl7Channel
• POST /integrations/fhir/subscriptions - Register FHIR subscription for patient events -> Returns FhirSubscription
• GET /webhooks - List registered webhook endpoints and event subscriptions -> Returns PaginatedList<WebhookEndpoint>
• POST /webhooks - Register a new webhook endpoint with signing secret -> Returns WebhookEndpoint
• PUT /webhooks/:id - Update webhook URL, events, or retry policy -> Returns WebhookEndpoint
• POST /webhooks/:id/rotate-secret - Rotate webhook signing secret securely -> Returns SecretRotationReceipt
• DELETE /webhooks/:id - Remove webhook registration and disable delivery -> Returns ActionResult<WebhookDeletion>

Analytics & Reporting

Measure operational and clinical outcomes through configurable dashboards, exports, and compliance-aligned reporting pipelines.

• GET /analytics/kpis?period=month - Retrieve top-level performance indicators -> Returns KpiSnapshot
• POST /analytics/reports - Create a scheduled or ad-hoc analytics report -> Returns ReportJob
• GET /analytics/reports/:id - Fetch report metadata, status, and filters -> Returns ReportJob
• GET /analytics/reports/:id/export?format=csv - Download report output file -> Returns FileDownload<ReportArtifact>
• GET /analytics/cohorts?segment=fall-risk - List patient cohorts by configured criteria -> Returns PaginatedList<Cohort>
• GET /analytics/outcomes/readmission-risk - Retrieve readmission risk trends -> Returns OutcomeSeries<ReadmissionRiskPoint>
• GET /analytics/engagement/family - Analyze family engagement metrics and retention -> Returns EngagementAnalytics
• POST /analytics/dashboards - Create a custom dashboard with widgets -> Returns AnalyticsDashboard
• PUT /analytics/dashboards/:id - Update dashboard layout and access permissions -> Returns AnalyticsDashboard
• GET /analytics/audit/compliance?framework=hipaa - Export compliance evidence dataset -> Returns ComplianceAuditExport

Scheduling & Appointments

Coordinate provider schedules, patient appointments, confirmations, and waitlists with automation hooks for reminders and follow-up actions.

• GET /appointments?from=2026-02-01&to=2026-02-28 - List appointments by date range -> Returns PaginatedList<AppointmentSummary>
• POST /appointments - Create a new appointment with modality and location -> Returns Appointment
• GET /appointments/:id - Retrieve appointment details and participant roster -> Returns Appointment
• PATCH /appointments/:id - Update appointment timing, channel, or notes -> Returns Appointment
• POST /appointments/:id/confirm - Record patient or caregiver confirmation -> Returns AppointmentConfirmation
• POST /appointments/:id/cancel - Cancel appointment with reason and rebook options -> Returns AppointmentCancellation
• GET /providers/availability?providerId=:id - Query provider time-slot availability -> Returns AvailabilityGrid
• POST /providers/:id/availability-blocks - Add recurring availability blocks -> Returns AvailabilityRule
• POST /appointments/bulk-reminders - Trigger reminders for upcoming appointments -> Returns BulkDispatchResult
• GET /scheduling/waitlist?clinicId=:id - Retrieve waitlist queue and auto-fill candidates -> Returns PaginatedList<WaitlistEntry>

Document Management

Store, classify, and share care documentation with retention controls, version history, and signature workflows suitable for regulated healthcare records.

• GET /documents?patientId=:id&type=care-summary - List documents with filtering -> Returns PaginatedList<DocumentSummary>
• POST /documents/uploads - Request secure upload URL and metadata token -> Returns UploadSession
• POST /documents - Register uploaded document in patient chart -> Returns DocumentRecord
• GET /documents/:id - Retrieve document metadata and access policy -> Returns DocumentRecord
• PATCH /documents/:id/metadata - Update tags, classification, and retention schedule -> Returns DocumentRecord
• POST /documents/:id/share - Share document with approved external recipients -> Returns ShareReceipt
• POST /documents/:id/signature-requests - Initiate digital signature workflow -> Returns SignatureRequest
• GET /documents/:id/versions - Retrieve immutable version history -> Returns List<DocumentVersion>
• POST /documents/:id/redactions - Create redacted copy for least-privilege access -> Returns RedactionResult
• DELETE /documents/:id - Soft-delete document under retention policy checks -> Returns ActionResult<DocumentDeletion>

AI Assistants

Use clinical AI assistants for triage support, care-plan suggestions, and communication drafting with safety review controls and human approval loops.

• POST /ai/assistants/scribe/sessions - Start ambient clinical scribe session -> Returns ScribeSession
• POST /ai/assistants/scribe/sessions/:id/transcripts - Submit transcript chunks for structuring -> Returns TranscriptIngestResult
• POST /ai/assistants/triage - Classify inbound patient requests by urgency -> Returns TriageRecommendation
• POST /ai/assistants/care-plan-suggestions - Generate care-plan recommendations from patient context -> Returns CarePlanSuggestionSet
• POST /ai/assistants/message-drafts - Draft caregiver communication with tone controls -> Returns MessageDraft
• GET /ai/assistants/jobs/:id - Retrieve asynchronous AI job status and outputs -> Returns AiJobResult
• POST /ai/assistants/jobs/:id/approve - Approve AI output for downstream execution -> Returns ApprovalReceipt
• POST /ai/assistants/jobs/:id/reject - Reject AI output with reviewer feedback -> Returns RejectionReceipt
• GET /ai/models - List available AI models and capability metadata -> Returns List<ModelCatalogEntry>
• GET /ai/safety/events?severity=high - Retrieve AI safety and policy events -> Returns PaginatedList<AiSafetyEvent>

Getting Started with Elderwise

Set up your organization, invite team members, and configure your first care workflow in under 30 minutes while applying baseline security and compliance settings.

• Creating your organization account
• Inviting care team members
• Setting up role-based permissions
• Configuring your first care plan template
• Connecting with family caregivers
• Verifying HIPAA and PDPA consent collection settings
• Configuring organization time zone and service regions
• Defining escalation contacts for urgent care events
• Importing initial patient roster from CSV or EHR
• Reviewing launch checklist before going live

Setting Up Care Workflows

Design care plans that keep families informed and care teams connected throughout the patient journey, with measurable milestones and escalation governance.

• Creating care plan templates
• Configuring daily check-in questions
• Setting up medication schedules
• Defining escalation rules
• Customizing caregiver notifications
• Mapping workflow stages to clinical protocols
• Assigning task ownership by discipline and shift
• Setting expected completion SLAs for each task
• Configuring exception handling for missed check-ins
• Tracking workflow outcomes in analytics dashboards

Managing Patient Communications

Use secure messaging and automated reminders to keep everyone informed without extra work, while maintaining communication preferences and legal consent boundaries.

• Sending secure messages to families
• Setting up automated appointment reminders
• Configuring medication reminder schedules
• Viewing message history and engagement
• Managing communication preferences
• Defining channel fallback rules for urgent updates
• Applying language and readability templates by audience
• Tracking unread high-priority messages for follow-up
• Using message tagging for care episode context
• Exporting communication logs for compliance review

Administrative Configuration

Configure organization settings, manage users, and customize Elderwise for your workflows with operational controls designed for healthcare administrators.

• Managing organization settings
• User administration and permissions
• Audit log review and compliance
• Customizing notification templates
• Configuring integration settings
• Establishing data retention and archival policies
• Configuring single sign-on and session timeout policy
• Setting up environment-specific API keys and scopes
• Creating operational runbooks for onboarding staff
• Monitoring system health and integration job failures

Security & Compliance Setup

Implement a defensible security and compliance baseline aligned with HIPAA and PDPA expectations, including auditability and incident readiness.

• Enabling mandatory multi-factor authentication for privileged users
• Defining least-privilege RBAC templates for each care role
• Configuring audit log retention and immutable export schedule
• Setting up breach notification contact and response workflow
• Reviewing data residency controls for regional PDPA requirements
• Applying webhook signature verification and key rotation cadence
• Configuring PHI masking in analytics and support views
• Documenting vendor access and third-party integration approvals
• Running monthly access review and account attestation
• Preparing evidence packets for internal and external audits

Analytics & Reporting Guide

Build decision-ready reporting for operations, care outcomes, and compliance using Elderwise dashboards, cohorts, and scheduled exports.

• Selecting KPI definitions for care quality and operations
• Building cohort filters for high-risk population monitoring
• Creating executive and frontline dashboard views
• Configuring report scheduling and secure delivery channels
• Exporting reports for board, payer, and regulatory reviews
• Using drill-down views to identify missed interventions
• Correlating communication engagement with care outcomes
• Versioning metric definitions across reporting periods
• Validating data freshness and source lineage metadata
• Sharing report artifacts with role-based access controls

Mobile App Configuration

Configure the Elderwise mobile experience for clinicians and caregivers with offline support, secure access, and notification reliability.

• Provisioning mobile app access by role and device policy
• Configuring biometric login and session expiration behavior
• Setting up offline check-in capture and sync retries
• Defining push notification categories and urgency handling
• Customizing quick actions for high-frequency tasks
• Managing lost-device remote sign-out and token revocation
• Testing secure media upload on constrained networks
• Applying locale and accessibility defaults for field teams
• Monitoring mobile crash analytics and stability metrics
• Rolling out phased app updates with communication plans

Multi-Location Management

Operate Elderwise across multiple clinics, facilities, or care programs while maintaining consistent governance, access boundaries, and reporting rollups.

• Modeling organization hierarchy and location-level ownership
• Configuring location-scoped patient and user permissions
• Managing shared templates with local override controls
• Standardizing escalation rules across facilities
• Consolidating analytics with location-level drill downs
• Coordinating regional compliance requirements and documentation
• Handling cross-location transfers with full audit continuity
• Segmenting communication channels by service area
• Benchmarking operational performance across sites
• Planning phased rollouts for newly onboarded locations

Automate Your First Appointment Reminder

Create automated appointment reminders that reduce no-shows and keep families informed about upcoming visits across SMS, email, and in-app channels.

1. Navigate to Settings > Notifications
2. Select 'Appointment Reminders' template
3. Configure timing (24 hours, 2 hours before)
4. Customize message content
5. Enable and test with a sample patient
6. Set fallback channel order (push, SMS, then email)
7. Add localization variables for patient preferred language
8. Enable confirmation links and cancellation reason capture
9. Review reminder delivery logs for sample records
10. Publish the automation to production schedule
11. Add suppression rule for opt-out and do-not-disturb contacts
12. Document ownership and KPI target for reminder adherence

Build a Care Gap Dashboard

Create a dashboard to identify patients who have not completed check-ins or may need follow-up outreach, then operationalize actions for care teams.

1. Access Analytics > Dashboard Builder
2. Add 'Check-in Completion' widget
3. Configure 'Days Since Last Contact' filter
4. Set up 'Risk Score' sorting
5. Create automated alert for high-risk patients
6. Add cohort filter for recently discharged patients
7. Create a table widget grouped by care coordinator
8. Configure threshold highlights for overdue follow-up
9. Save dashboard and assign read access to team leads
10. Schedule weekly PDF export to operations mailbox
11. Create drill-through action to open patient timeline directly
12. Review dashboard monthly with clinical governance committee

Set Up EHR Integration

Connect Elderwise with your electronic health record system for seamless data synchronization using FHIR and optional HL7 interfaces.

1. Review EHR integration requirements
2. Configure FHIR endpoint connection
3. Map patient identifiers between systems
4. Set up data sync schedule
5. Test with sample patient records
6. Enable production synchronization
7. Configure webhook callbacks for appointment updates
8. Validate inbound and outbound consent status mapping
9. Create retry policy for transient transport failures
10. Monitor first sync run and reconcile data discrepancies
11. Document interface ownership and on-call escalation
12. Export integration validation report for compliance records

Configure Multi-Factor Authentication

Enable organization-wide multi-factor authentication to strengthen account security for administrators, clinicians, and support staff.

1. Open Security > Authentication Policies
2. Enable MFA requirement for all privileged roles
3. Select authenticator app as primary factor method
4. Configure SMS fallback for approved exception cases
5. Set enrollment deadline and reminder cadence
6. Enroll pilot users and verify login flow
7. Test account recovery workflow with help desk policy
8. Review MFA enrollment dashboard for completion rates
9. Export enrollment evidence for security audit packet
10. Roll out MFA enforcement to all production users
11. Set policy exceptions with expiration dates for temporary access needs
12. Enable alerting for repeated failed second-factor challenges

Set Up Automated Patient Outreach

Design outreach campaigns that trigger after missed check-ins, care transitions, or elevated risk indicators while preserving communication consent controls.

1. Go to Engagement > Outreach Automations
2. Create a new automation named Missed Check-In Follow-Up
3. Define trigger condition for two missed check-ins in 48 hours
4. Add branch rule for high-risk patients to escalate immediately
5. Select message templates for caregiver and family audiences
6. Configure quiet hours and timezone-aware delivery settings
7. Add stop condition when patient responds or call is completed
8. Enable task creation for unresolved outreach after 24 hours
9. Run sandbox simulation using anonymized patient profiles
10. Activate automation and monitor first-week response metrics
11. Create A/B message variant to optimize response quality
12. Escalate unresolved outreach to live call queue after final attempt

Create Custom Reports

Build reusable custom reports for leadership, compliance, and frontline operations using filters, calculated metrics, and scheduled exports.

1. Navigate to Analytics > Reports
2. Click Create Report and choose the Operations template
3. Select date range, location scope, and care program filters
4. Add metrics for check-in adherence and response times
5. Include calculated field for intervention completion rate
6. Group rows by care manager and service location
7. Apply PHI masking option for external stakeholder views
8. Preview report and validate metric totals
9. Schedule weekly CSV delivery to secure mailbox
10. Save report as shared template for department leads
11. Configure report version notes to track metric definition changes
12. Share onboarding guide so teams interpret report fields consistently

Implement Role-Based Access Control

Design and enforce RBAC policies across multiple teams to ensure least-privilege access to patient data, analytics, and integration controls.

1. Review default roles and permission matrix
2. Define custom roles for care coordinators and regional admins
3. Map each role to required scopes and API permissions
4. Create location-scoped access boundaries for multi-site teams
5. Apply conditional policies for sensitive document categories
6. Configure approval workflow for temporary elevated access
7. Test role assignments with representative user accounts
8. Run access audit to identify over-privileged accounts
9. Set quarterly access recertification reminders
10. Publish RBAC policy and train administrators on change controls
11. Enable alerting for failed authorization attempts
12. Archive signed access governance review for HIPAA evidence