Good Faith Estimates

Void a Good Faith Estimate

Voids a local Good Faith Estimate in a voidable status and records the void reason in local audit context.

POSTNeeds publication reviewPayment or creditGood Faith EstimatesoperationId: voidGoodFaithEstimatehttps://dev-api.quickintell.com/api/v1/gfe/estimates/{gfeId}/void

Needs publication reviewPayment or creditPatient 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. Also requires E2 side-effect policy 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

Payment or credit

May affect payments, credits, refunds, voids, or financial posting. Requires explicit product approval before publication.

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 POST /api/v1/gfe/estimates/{gfeId}/void. 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 POST /api/v1/gfe/estimates/{gfeId}/void, 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. Mutating behavior still needs side-effect and retry evidence.

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	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
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.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

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

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 when a draft, generated, or delivered estimate should no longer be active because it was created in error, superseded, or otherwise invalid for workflow purposes.

Before calling

Authenticate with `gfe:write`, load the estimate, and confirm the current status is `GFE_DRAFT`, `GFE_GENERATED`, or `GFE_DELIVERED`.

Request and response behavior

Request guidance

`voidReason` is required and capped at 2000 characters by the public schema. Keep the reason operational and do not include payer credentials, raw EDI, transcripts, S3 keys, or unnecessary PHI.

`voidReason` is required.
Voidable statuses are `GFE_DRAFT`, `GFE_GENERATED`, and `GFE_DELIVERED`.
The endpoint records local workflow state; it is not a delete operation.

Response semantics

The response returns the updated estimate with status `GFE_VOID`. Voiding is a local status transition; it does not delete the estimate, delete a PDF asset, reverse patient acknowledgment, or close an existing IDR case.

Returned `data.estimate.status` is `GFE_VOID` on success.
The public response does not return the void reason.
Voided estimates remain visible through normal list/detail access unless filtered out by callers.

Errors and retries

A 400 can indicate an invalid or empty void reason or a non-voidable status. A 404 means the estimate was not found in the authenticated organization. Re-read current status before retrying after a timeout.

400 can mean the current status is acknowledged, disputed, expired, or already void.
404 can intentionally hide wrong-tenant estimates.
Do not document voiding as deleting PDF files or estimate rows.

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
gfeId	path	Yes	string	QuickRCM Good Faith Estimate identifier in a path parameter. It must resolve inside the authenticated organization.	Minimum length: 1.

Query parameters

This endpoint does not define query parameters.

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.

Name	Location	Required	Type	Description	Validation and safety notes
signature	body	No	string	Optional request marker on several schemas. It is not bearer authentication and is not returned in public responses.	Minimum length: 1.
voidReason	body	Yes	string	Required local reason for voiding the estimate. It is sanitized and not returned in public estimate responses.	Minimum length: 1. Maximum length: 2000.

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.

{
  "voidReason": "example-voidreason",
  "signature": "example-signature"
}

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 voided

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "estimate": {
      "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 void_good_faith_estimate",
      "providerNpi": "1234567893",
      "facilityName": "Example void_good_faith_estimate",
      "facilityId": "00000000-0000-4000-8000-000000000001",
      "serviceDate": "2026-06-08T10:15:30Z",
      "lineItems": [
        {
          "cptCode": "example-cptcode",
          "description": "Example void_good_faith_estimate note",
          "quantity": 1.25,
          "unitCharge": "example-unitcharge",
          "totalCharge": "example-totalcharge",
          "providerName": "Example void_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"
    }
  },
  "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
}

404

Good Faith Estimate not found

Handle this response as normal integration control flow.

{
  "error": "Resource not found",
  "statusCode": 404
}

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