TRUE CARE SYSTEM • RELEASE NOTES
API Release Notes
Documents approved backend changes that affect business logic, validation, integrations, data handling, security, and audit behavior.
Release notes may reference Provider operations, PHI-related workflows, security controls, billing, payroll, EVV, integrations, or proprietary implementation details. Public documentation must avoid credentials, private endpoints, source code, customer data, and sensitive internal security information.
Purpose
Documents approved backend changes that affect business logic, validation, integrations, data handling, security, and audit behavior.
Release Documentation Requirements
Endpoint Changes
Record newly added, changed, deprecated, or removed endpoints and any client impact.
Business Logic
Explain changes to scheduling, visit, authorization, billing, payroll, BSS, HIPAA, support, or administration logic.
Data and Validation
Document new validation, Provider-scoped filters, response fields, transaction parsing, and sequence handling.
Security and Audit
Record authentication, authorization, impersonation, PHI-access logging, login-history, and security-event changes.
Compatibility
State whether Web, Mobile, background jobs, integrations, or external consumers require coordinated deployment.
Required Release Record
| Field | Required Information |
|---|---|
| Version | Product version, build, release identifier, or deployment reference. |
| Date | Release, deployment, publication, or approval date. |
| Environment | Development, QA, staging, production, TestFlight, Google Play, or Apple App Store. |
| Scope | Affected product, module, Provider workflow, integration, or documentation area. |
| Validation | QA result, regression evidence, smoke tests, security review, and production confirmation. |
| Provider Action | App update, browser refresh, training, configuration review, data correction, or no action. |
| Rollback | Rollback trigger, prior stable version, reversal steps, and data-reconciliation requirements. |