API Deprecation Policy
How Parker Apex announces, marks, and sunsets HTTP API endpoints. Partners receive minimum 90-day notice before breaking changes unless a critical security fix requires immediate action.
Policy rules
Minimum 90-day notice
Breaking HTTP API changes require at least 90 days between deprecation announcement and sunset, except for critical security fixes.
Changelog & portal announcement
All deprecations are published in the developer portal changelog with version, affected paths, and migration steps.
OpenAPI deprecated flag
Deprecated operations are marked deprecated: true in OpenAPI specs with x-sunset-date extension where applicable.
Deprecation response headers
Deprecated endpoints return Deprecation: true and Sunset: {RFC 7231 HTTP-date} headers on every response.
Versioned paths preferred
New capabilities ship under versioned paths (/v1/, /v2/). Existing paths remain stable for the notice window.
Schema field deprecation
FHIR and JSON schema fields follow a one release-cycle notice per SCHEMA_GOVERNANCE_V1 before removal.
Response headers on deprecated endpoints
{
-300">"Deprecation": -300">"-300">true",
-300">"Sunset": -300">"Sat, 12 Sep 2026 23:59:59 GMT",
-300">"Link": -300">"</horizon/v1/query/nl>; rel=\"successor-version\""
}Clients should log Deprecation and Sunset headers and migrate before the sunset date.
Currently deprecated endpoints
| Method | Path | Product | Since | Sunset | Replacement |
|---|---|---|---|---|---|
| POST | /tefca/v1/patient-discovery | TEFCA Gateway | 2026-06-12 | 2026-09-12 | POST /tefca/xcpd/search (outbound) or POST /tefca/xcpd/discover (inbound) |
| POST | /tefca/v1/document-query | TEFCA Gateway | 2026-06-12 | 2026-09-12 | POST /tefca/xca/search (outbound) or POST /tefca/xca/query (inbound) |
| POST | /horizon/v1/query | Horizon Analytics | 2026-06-12 | 2026-09-12 | POST /horizon/v1/query/nl then POST /horizon/v1/query/execute |
| GET | /horizon/v1/risk-score | Horizon Analytics | 2026-06-12 | 2026-09-12 | POST /horizon/v1/horizon-score/compute |