Appeals

Get appeal analytics report

Returns a read-only appeal analytics report for a selected report type.

GETPublic reference baselineFile or artifactAppealsoperationId: getAppealAnalyticsReporthttps://dev-api.quickintell.com/api/v1/appeals/analytics/{reportType}

Public reference baselineFile or artifactClaims and denials

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

File or artifact

Touches documents, reports, transcripts, PDFs, EDI, or generated artifacts. Metadata is safer than raw content.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the claims and denials contract generated for GET /api/v1/appeals/analytics/{reportType}. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated GET /api/v1/appeals/analytics/{reportType} contract as a file or artifact baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	Potential file or artifact	Documents, PDFs, reports, transcripts, EDI, OCR, or generated artifacts need E4 classification before public examples.
Ownership and storage keys	Evidence required	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Files and Artifacts

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Appeals public API.

Appeals APIs manage QuickRCM denial appeal records, supporting document workflows, peer-to-peer reviews, deadlines, reminders, analytics, and compliance tracking. All endpoints are scoped to the organization selected by the bearer API key; callers do not provide a public organization selector. Use these endpoints after a denial case, claim, supporting document, reminder, peer-to-peer review, compliance event, or compliance rule already exists in QuickRCM. Read endpoints accept `appeals:read` or `appeals:write`; write endpoints require `appeals:write`. The public API exposes local workflow state and sanitized metadata. It intentionally avoids returning raw payer payloads, PHI-heavy activity metadata, S3 object keys, raw EDI, transcripts, or vendor credentials. Electronic portal appeal submission is validate-only through the public API and returns a simulated validation response rather than transmitting a payer payload.

What this endpoint does

Use case

Use this for appeal success, recovery, analyst performance, payer behavior, P2P success, or summary analytics.

Before calling

Choose `reportType` and optional filters that are meaningful for that report.

Request and response behavior

Request guidance

Choose path `reportType` from `success-rates`, `recovery-analysis`, `analyst-performance`, `payer-behavior`, `p2p-success-rates`, or `summary`. Supported query filters are `startDate`, `endDate`, `payerId`, `payerName`, `denialCategory`, `appealLevel`, `analystUserId`, `providerUserId`, `providerSpecialty`, and `periodType`; some filters only affect the matching report implementation.

`appealLevel` must use an Appeals level enum.
`periodType` applies to summary-style analytics.

Response semantics

The response wraps the selected `reportType` and serialized `report` data. Report bodies are report-type-specific and intentionally not a fixed public schema yet.

`report` is report-type-specific serialized data.
Analytics are based on local QuickRCM appeal records.

Errors and retries

Treat invalid report types, dates, or enum filters as 400. Back off on 429 for scheduled reporting.

400 means report type or filter validation failed.
429 should be retried with backoff.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

Name	Location	Required	Type	Description	Validation and safety notes
reportType	path	Yes	success-rates \| recovery-analysis \| analyst-performance \| payer-behavior \| p2p-success-rates \| summary	Path selector for the analytics report: success-rates, recovery-analysis, analyst-performance, payer-behavior, p2p-success-rates, or summary.	Enum values are declared in the Type column.

Query parameters

Name	Location	Required	Type	Description	Validation and safety notes
startDate	query	No	string (date-time)	Optional lower ISO datetime bound for the report period.	Format: date-time.
endDate	query	No	string (date-time)	Optional upper ISO datetime bound for the report period.	Format: date-time.
payerId	query	No	string	Optional QuickRCM payer configuration identifier filter. Used by payer/recovery/success report paths where supported.	Minimum length: 1.
payerName	query	No	string	Optional payer-name filter. Used by P2P success report paths where supported.	Minimum length: 1. Maximum length: 255.
denialCategory	query	No	string	Optional denial category filter for reports that operate on denial categories.	Minimum length: 1. Maximum length: 100.
appealLevel	query	No	LEVEL_1_RECONSIDERATION \| LEVEL_2_FORMAL_APPEAL \| LEVEL_3_EXTERNAL_REVIEW \| LEVEL_4_ALJ_HEARING \| LEVEL_5_COUNCIL_REVIEW \| LEVEL_6_FEDERAL_COURT \| STATE_FAIR_HEARING \| INDEPENDENT_REVIEW_ORG \| STATE_INSURANCE_DEPT	Optional appeal level enum filter.	Enum values are declared in the Type column.
analystUserId	query	No	string	Optional QuickRCM user identifier for analyst-performance filtering.	Minimum length: 1.
providerUserId	query	No	string	Optional QuickRCM provider user identifier for P2P success filtering.	Minimum length: 1.
providerSpecialty	query	No	string	Optional provider specialty filter for P2P success reporting.	Minimum length: 1. Maximum length: 255.
periodType	query	No	WEEKLY \| MONTHLY \| QUARTERLY	Optional summary aggregation period: WEEKLY, MONTHLY, or QUARTERLY.	Enum values are declared in the Type column.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

This endpoint does not define a JSON request body.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

No request example is declared.

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Appeal analytics report

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "reportType": "success-rates",
    "report": "example-report"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request

Handle this response as normal integration control flow.

{
  "error": "Request validation failed",
  "statusCode": 400
}

401

Authentication required

Handle this response as normal integration control flow.

{
  "error": "Authentication required",
  "statusCode": 401
}

403

Organization access denied

Handle this response as normal integration control flow.

{
  "error": "Forbidden",
  "statusCode": 403
}

Adjacent endpoints

Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.

POSTPublic reference baselineLocal write

Acknowledge appeal reminder

/api/v1/appeals/reminders/{reminderId}/acknowledge

POSTPublic reference baselineFile or artifact

Add appeal supporting document

/api/v1/appeals/{appealId}/documents

PUTPublic reference baselineLocal write

Cancel peer-to-peer review

/api/v1/appeals/peer-to-peer/{p2pReviewId}/cancel

POSTPublic reference baselineLocal write

Compile appeal packet

/api/v1/appeals/{appealId}/packet/compile

POSTPublic reference baselineLocal write

Create appeal

/api/v1/appeals

POSTPublic reference baselineFile or artifact

Create appeal document download URL

/api/v1/appeals/documents/{documentId}/download-url

All endpoint pages Open Scalar reference