Good Faith Estimates

Get a Good Faith Estimate PDF URL

Returns PDF availability for a Good Faith Estimate and, outside simulation mode, PDF download access when a stored PDF key exists.

GETNeeds publication reviewFile or artifactGood Faith EstimatesoperationId: getGoodFaithEstimatePdfUrlhttps://dev-api.quickintell.com/api/v1/gfe/estimates/{gfeId}/pdf-url

Needs publication reviewFile or artifactPatient 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 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 patient financials contract generated for GET /api/v1/gfe/estimates/{gfeId}/pdf-url. 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/{gfeId}/pdf-url, 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

Raw file contents, storage keys, signed URLs, and generated artifacts are not public from this page.

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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
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	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 after creating or retrieving an estimate when a client needs to download or hand off the generated GFE PDF.

Before calling

Authenticate with `gfe:read` or `gfe:write` and resolve `gfeId` from the same organization. Use `simulateOnly=true` when checking whether a PDF key exists without receiving a live download URL.

Request and response behavior

Request guidance

`simulateOnly` is an optional query string value of `true` or `false`. There is no request body. Do not log or persist live `downloadUrl` values; they are temporary access links or sensitive data URLs, not stable file identifiers.

`simulateOnly` is a query string, unlike deliver's body boolean.
Live S3 download URLs expire after 300 seconds; local fallback data URLs should still be handled as sensitive PDF content.
No PDF storage key is returned.

Response semantics

Simulation mode checks only the estimate's stored PDF key presence and returns `mode: simulated`, `pdfAvailable`, `downloadUrl: null`, and `expiresInSeconds: null`. Live mode calls the PDF download operation and returns `mode: live`, `pdfAvailable: true`, a download URL, and `expiresInSeconds: 300`. For local fallback keys, live mode reads the local PDF and returns a `data:application/pdf;base64,...` URL; if that local file is missing, the endpoint returns 404. For S3-backed keys, live mode issues a presigned URL for the stored key and does not prove that the remote object will download successfully. The response never exposes the underlying PDF storage key.

`downloadUrl` is null in simulation mode.
`pdfAvailable` in simulation mode only reflects stored PDF-key presence, not a live file read or remote-object retrieval.
Treat live URLs and PDF data URLs as sensitive temporary access values.
For S3-backed keys, a successful API response means a presigned URL was issued; the endpoint does not prove the downstream object download will succeed.

Errors and retries

A 404 can mean the estimate is missing or outside the authenticated organization, no PDF key has been generated for the estimate, or a local fallback PDF file cannot be read. S3-backed live responses issue a presigned URL for the stored key and do not verify remote object availability before returning. Retry transient server or storage-configuration failures with backoff, but do not retry missing-PDF cases until the estimate or PDF generation state changes.

404 can indicate `Good Faith Estimate not found`, `PDF not generated for this GFE`, or `PDF file not found for this GFE` for local fallback reads.
Do not document S3-object absence as an API-level 404 condition unless the implementation adds an object-existence check.
A missing or misconfigured S3 bucket is a server/storage configuration failure, not a caller-correctable request error.
401 and 403 require credential, scope, or tenant-context correction.

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

Name	Location	Required	Type	Description	Validation and safety notes
simulateOnly	query	No	true \| false	Optional query string. Use `true` to check PDF-key presence without returning a live URL.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.

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 PDF URL result

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "estimateId": "00000000-0000-4000-8000-000000000001",
    "mode": "simulated",
    "pdfAvailable": true,
    "downloadUrl": "https://example.quickintell.com/resource",
    "expiresInSeconds": 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
}

404

Good Faith Estimate PDF 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}

POSTNeeds publication reviewLocal write

Initiate a GFE dispute

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

GETNeeds publication reviewRead-only

List Good Faith Estimates

/api/v1/gfe/estimates

All endpoint pages Open Scalar reference