Good Faith Estimates

List Good Faith Estimates

Lists Good Faith Estimate records owned by the organization selected by the bearer API key, with optional filters for local GFE status, patient, service-date range, overdue flag, and page-based pagination.

GETNeeds publication reviewRead-onlyGood Faith EstimatesoperationId: listGoodFaithEstimateshttps://dev-api.quickintell.com/api/v1/gfe/estimates

Needs publication reviewRead-onlyPatient financials

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.

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

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

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 patient financials contract generated for GET /api/v1/gfe/estimates. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for GET /api/v1/gfe/estimates, but keeps the route out of ordinary production API positioning until review is complete.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior.

Not public from this page

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review 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.

Good Faith Estimates public API.

Good Faith Estimates APIs expose organization-scoped endpoints for local QuickRCM Good Faith Estimate creation, retrieval, editing, delivery-state recording, acknowledgment, voiding, PDF access, and local Independent Dispute Resolution case tracking. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Read endpoints accept `gfe:read` or `gfe:write`; mutation endpoints require `gfe:write`. The patient, GFE, and IDR case identifiers used by these endpoints must resolve inside the authenticated organization. Optional `appointmentId` and `facilityId` values should be resolved by the caller before creation, but current implementation evidence visibly verifies patient ownership only before storing those optional identifiers. These endpoints manage local workflow state for No Surprises Act support. They compute line totals, estimate totals, patient responsibility, and delivery-deadline metadata; record local delivery and acknowledgment state; create local IDR cases when a billed amount exceeds the estimate by at least 400; and expose PDF availability or access. They do not themselves transmit email, portal, fax, mail, or hand-delivery messages; submit an external IDR filing; adjudicate disputes; collect payments; update patient balances; or expose PDF storage keys. PDF access needs careful wording: S3-backed live responses return a presigned URL with a 300-second lifetime, while local PDF fallback can return a `data:application/pdf;base64,...` URL that still must be treated as sensitive PDF content and should not be logged or persisted. Lifecycle summary: `GFE_DRAFT` and `GFE_GENERATED` can be updated, delivered, or voided; `GFE_DELIVERED` can be acknowledged or voided; `GFE_ACKNOWLEDGED` can initiate a qualifying local IDR case; `GFE_DISPUTED`, `GFE_EXPIRED`, and `GFE_VOID` are not editable, deliverable, or voidable through these public endpoints. IDR transitions are also constrained: initiated to offer submitted or withdrawn; offer submitted to counter received, provider-resolved, or withdrawn; counter received to arbitration, payer-resolved, split-resolved, or withdrawn; arbitration to provider-resolved, payer-resolved, or split-resolved.

What this endpoint does

Use case

Use this endpoint to populate GFE worklists, compliance dashboards, overdue delivery reviews, patient-specific estimate history, or integration reconciliation views before opening one estimate in detail.

Before calling

Authenticate with an API key that has `gfe:read` or `gfe:write`. Choose narrow filters such as `status`, `patientId`, `dateFrom`, `dateTo`, and `isOverdue`.

Request and response behavior

Request guidance

`page` and `pageSize` are one-based pagination controls; the operation defaults to page 1 and page size 25 when omitted. The public schema caps `page` at 10000 and `pageSize` at 100. `dateFrom` and `dateTo` accept valid `YYYY-MM-DD` dates or ISO datetimes, and `dateFrom` must be on or before `dateTo`. Do not send `organizationId`; tenant scope comes from the API key.

`status` values are `GFE_DRAFT`, `GFE_GENERATED`, `GFE_DELIVERED`, `GFE_ACKNOWLEDGED`, `GFE_DISPUTED`, `GFE_EXPIRED`, and `GFE_VOID`.
`isOverdue` is a string query value, either `true` or `false`.
Use service-date filters for period reviews instead of exporting all estimates.
Date-only filters are accepted as calendar dates and parsed by the public handler before operation filtering; ISO datetimes are also accepted when callers need exact boundaries.

Response semantics

The response returns `data.estimates`, `total`, `page`, `pageSize`, and `meta.organizationId`. Estimate rows use the public estimate shape and include identifiers, local status, provider and facility display fields, line items, monetary strings, delivery timestamps, overdue state, and timestamps. Current list implementation does not include the `idrCase` relation before serialization, so list rows should be documented with `idrCase: null`; use `getGoodFaithEstimate` for linked IDR detail.

`data.estimates` is local QuickRCM GFE state, not proof that a delivery channel transmitted a document.
Current list rows return `idrCase: null`; retrieve one estimate to see linked IDR case details.
Monetary response fields are serialized as strings.

Errors and retries

Treat 400 as invalid filters or pagination, 401/403 as credential, scope, or tenant-access issues, and transient server failures as retryable with backoff. Do not retry malformed date ranges unchanged.

400 can indicate invalid enum values, invalid calendar dates, `dateFrom` after `dateTo`, or pagination bounds.
403 means the API key lacks tenant access or the required GFE permission.
Do not log broad query parameters if they contain patient-adjacent workflow context.

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

This endpoint does not define path parameters.

Query parameters

Name	Location	Required	Type	Description	Validation and safety notes
status	query	No	GFE_DRAFT \| GFE_GENERATED \| GFE_DELIVERED \| GFE_ACKNOWLEDGED \| GFE_DISPUTED \| GFE_EXPIRED \| GFE_VOID	Optional local Good Faith Estimate lifecycle status filter.	Enum values are declared in the Type column.
patientId	query	No	string	Optional QuickRCM patient identifier. Results remain scoped to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
dateFrom	query	No	string	Inclusive lower bound for estimate service dates. Use `YYYY-MM-DD` or an ISO datetime string.	Minimum length: 1.
dateTo	query	No	string	Inclusive upper bound for estimate service dates. It must be on or after `dateFrom` when both are supplied.	Minimum length: 1.
isOverdue	query	No	true \| false	Optional string filter for estimates marked overdue by delivery-deadline logic; accepted values are `true` and `false`.	Enum values are declared in the Type column.
page	query	No	integer	One-based page number. Defaults to 1 in the operation layer and is capped at 10000 by the public schema.	Minimum value: 1. Maximum value: 10000.
pageSize	query	No	integer	Maximum estimates returned per page. Defaults to 25 in the operation layer and is capped at 100 by the public schema.	Minimum value: 1. Maximum value: 100.

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

Good Faith Estimate list

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "estimates": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "estimateNumber": "example-estimatenumber",
        "patientId": "00000000-0000-4000-8000-000000000001",
        "appointmentId": "00000000-0000-4000-8000-000000000001",
        "status": "GFE_DRAFT",
        "providerName": "Example good_faith_estimate",
        "providerNpi": "1234567893",
        "facilityName": "Example good_faith_estimate",
        "facilityId": "00000000-0000-4000-8000-000000000001",
        "serviceDate": "2026-06-08T10:15:30Z",
        "lineItems": [
          {
            "cptCode": "example-cptcode",
            "description": "Example good_faith_estimate note",
            "quantity": 1.25,
            "unitCharge": "example-unitcharge",
            "totalCharge": "example-totalcharge",
            "providerName": "Example good_faith_estimate",
            "providerNpi": "1234567893",
            "providerType": "example-providertype"
          }
        ],
        "totalEstimatedCost": "example-totalestimatedcost",
        "patientResponsibility": "example-patientresponsibility",
        "deliveryMethod": "GFE_DEL_EMAIL",
        "deliveredAt": "2026-06-08T10:15:30Z",
        "deliveryDeadline": "2026-06-08T10:15:30Z",
        "isDeliveryOverdue": true,
        "acknowledgedAt": "2026-06-08T10:15:30Z",
        "disputedAt": "2026-06-08T10:15:30Z",
        "idrCase": {
          "id": "00000000-0000-4000-8000-000000000001",
          "organizationId": "00000000-0000-4000-8000-000000000001",
          "status": "IDR_INITIATED",
          "billedAmount": "example-billedamount",
          "estimatedAmount": "example-estimatedamount",
          "resolvedAmount": "example-resolvedamount",
          "qualifyingPaymentAmount": "example-qualifyingpaymentamount",
          "providerOfferAmount": "example-providerofferamount",
          "payerCounterAmount": "example-payercounteramount",
          "arbitrationAmount": "example-arbitrationamount",
          "initiatedAt": "2026-06-08T10:15:30Z",
          "resolvedAt": "2026-06-08T10:15:30Z",
          "createdAt": "2026-06-08T10:15:30Z",
          "updatedAt": "2026-06-08T10:15:30Z"
        },
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

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.

POSTNeeds publication reviewLocal write

Acknowledge a Good Faith Estimate

/api/v1/gfe/estimates/{gfeId}/acknowledge

POSTNeeds publication reviewFile or artifact

Create a Good Faith Estimate

/api/v1/gfe/estimates

POSTNeeds publication reviewValidate or simulate

Deliver a Good Faith Estimate

/api/v1/gfe/estimates/{gfeId}/deliver

GETNeeds publication reviewRead-only

Get a Good Faith Estimate

/api/v1/gfe/estimates/{gfeId}

GETNeeds publication reviewFile or artifact

Get a Good Faith Estimate PDF URL

/api/v1/gfe/estimates/{gfeId}/pdf-url

POSTNeeds publication reviewLocal write

Initiate a GFE dispute

/api/v1/gfe/estimates/{gfeId}/disputes

All endpoint pages Open Scalar reference