Good Faith Estimates

Update a GFE IDR case

Updates local status and safe financial tracking fields on an organization-owned GFE IDR case.

PUTNeeds publication reviewLocal writeGood Faith EstimatesoperationId: updateGfeIdrCasehttps://dev-api.quickintell.com/api/v1/gfe/idr-cases/{idrCaseId}

Needs publication reviewLocal writePatient 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

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

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 PUT /api/v1/gfe/idr-cases/{idrCaseId}. 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 PUT /api/v1/gfe/idr-cases/{idrCaseId}, 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 as the IDR workflow moves through offer, counter, arbitration, resolution, or withdrawal states, or when safe amount fields need to be recorded.

Before calling

Authenticate with `gfe:write`, resolve `idrCaseId` from the same organization, and know the current IDR status before requesting a transition.

Request and response behavior

Request guidance

All body fields are optional, but callers should send at least the status or amount field they intend to update. Status transitions are validated against the module state machine. `notes` and `arbitrationDecision` are accepted as local text fields but are sanitized and are not returned in the public response.

Allowed statuses are `IDR_INITIATED`, `IDR_OFFER_SUBMITTED`, `IDR_COUNTER_RECEIVED`, `IDR_ARBITRATION`, `IDR_RESOLVED_PROVIDER`, `IDR_RESOLVED_PAYER`, `IDR_RESOLVED_SPLIT`, and `IDR_WITHDRAWN`.
Allowed transitions are initiated to offer submitted or withdrawn; offer submitted to counter received, resolved provider, or withdrawn; counter received to arbitration, resolved payer, resolved split, or withdrawn; arbitration to resolved provider, resolved payer, or resolved split.
Amount fields must be zero or greater when supplied.
Amount-only updates are accepted when one or more safe financial fields are present; avoid sending an empty body because it has no useful workflow effect.

Response semantics

The response returns `data.idrCase`, including IDR status, billed and estimated amounts, offer/counter/arbitration/resolved amounts, qualifying payment amount, and timestamps. It does not include notes or arbitration decision text and is not evidence of external arbitration outcome unless a separate approved workflow records that fact.

`resolvedAt` is set when the operation moves the case to a resolved or withdrawn status.
The response contains local workflow state only.
Text fields accepted in the request are not echoed in the public response.

Errors and retries

A 400 can indicate an invalid status enum, invalid status transition, or invalid field value. A 404 means the IDR case is missing or outside the authenticated organization. Re-read the case after timeouts before replaying updates.

400 can indicate an invalid status transition such as moving directly from initiated to arbitration.
404 can mean the IDR case does not belong to the API key organization.
Do not claim this endpoint files or resolves an external arbitration case.

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
idrCaseId	path	Yes	string	QuickRCM IDR case identifier from the path. It must belong to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

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 schema field on IDR update. It is not returned and should not be used for authentication.	Minimum length: 1.
status	body	No	IDR_INITIATED \| IDR_OFFER_SUBMITTED \| IDR_COUNTER_RECEIVED \| IDR_ARBITRATION \| IDR_RESOLVED_PROVIDER \| IDR_RESOLVED_PAYER \| IDR_RESOLVED_SPLIT \| IDR_WITHDRAWN	Optional requested local IDR status. Transitions are validated from the current stored status.	Enum values are declared in the Type column.
providerOfferAmount	body	No	number	Optional non-negative provider offer amount retained on the local IDR case.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
payerCounterAmount	body	No	number	Optional non-negative payer counter amount retained on the local IDR case.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
arbitrationDecision	body	No	string	Optional local decision text accepted by the public schema and sanitized before storage. It is not returned in the public response.	Minimum length: 1. Maximum length: 4000.
arbitrationAmount	body	No	number	Optional non-negative arbitration amount.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
resolvedAmount	body	No	number	Optional non-negative resolved amount.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
qualifyingPaymentAmount	body	No	number	Optional non-negative qualifying payment amount.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
notes	body	No	string	Optional local notes capped by the public schema and sanitized before storage. Notes are not returned in public IDR case 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.

{
  "signature": "example-signature",
  "status": "IDR_INITIATED",
  "providerOfferAmount": 125.5,
  "payerCounterAmount": 1,
  "arbitrationDecision": "example-arbitrationdecision",
  "arbitrationAmount": 125.5,
  "resolvedAmount": 125.5,
  "qualifyingPaymentAmount": 125.5
}

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

IDR case updated

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "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"
    }
  },
  "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

IDR case 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