Good Faith Estimates

Create a Good Faith Estimate

Creates a local Good Faith Estimate for an existing organization-owned patient, computes line totals and total estimated cost, assigns a generated estimate number, calculates a delivery deadline, and attempts PDF generation.

POSTNeeds publication reviewFile or artifactGood Faith EstimatesoperationId: createGoodFaithEstimatehttps://dev-api.quickintell.com/api/v1/gfe/estimates

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 POST /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 POST /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. Mutating behavior still needs side-effect and retry evidence.

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	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	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.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
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 Idempotency 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 when an integration has the required patient, provider, facility, service-date, and line-item inputs needed to create a GFE record before delivery and patient acknowledgment workflows.

Before calling

Authenticate with `gfe:write`. Resolve `patientId` in the same organization. Resolve optional `appointmentId` and `facilityId` before sending them; the current create operation visibly verifies patient ownership, not optional appointment or facility ownership.

Request and response behavior

Request guidance

`patientId`, `providerName`, `providerNpi`, `providerTin`, `serviceDate`, and `lineItems` are required. `appointmentId`, `facilityName`, `facilityId`, `deliveryMethod`, and `signature` are optional in the public schema. Each line item requires a CPT or HCPCS-style code string of 4 to 7 characters, description, positive quantity, and positive unit charge. Keep provider TIN and line descriptions out of logs and examples unless they are synthetic.

`providerNpi` must match exactly 10 digits.
`providerTin` is required by the request schema but is not returned in the public estimate response.
`serviceDate` accepts `YYYY-MM-DD` or ISO datetime input.
The create path rate-limits GFE generation at 100 estimates per organization per hour.

Response semantics

A successful 201 response returns `data.estimate` and `meta.organizationId`. The operation creates local estimate status `GFE_GENERATED`, computes `totalEstimatedCost` and `patientResponsibility` from line items, and may create an underlying PDF asset. The response does not include provider TIN, patient demographics, a PDF download URL, or a storage key; use `getGoodFaithEstimatePdfUrl` for access when needed.

The response is a local QuickRCM GFE, not proof of patient delivery or acknowledgment.
Line item totals are computed server-side from quantity and unit charge.
PDF generation can exist separately from immediate PDF URL retrieval.

Errors and retries

Fix validation errors before retrying. A 404 means the supplied patient was not found in the authenticated organization. A 429 can occur when the organization exceeds the GFE generation rate limit. After a timeout, list by patient or service date before creating another estimate because no idempotency key is declared.

400 can indicate missing required fields, invalid provider NPI/TIN, invalid service date, empty line items, or non-positive quantities or charges.
404 means the patient identifier did not resolve in the API key organization.
429 means the module-level generation limit was reached.

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

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 create. It is not returned and should not be described as bearer authentication.	Minimum length: 1.
patientId	body	Yes	string	Required QuickRCM patient identifier. The patient must belong to the API key organization.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
appointmentId	body	No	string	Optional QuickRCM appointment identifier to associate with the estimate. Resolve it in the same organization before sending.	Minimum length: 1.
providerName	body	Yes	string	Required provider display name used on the estimate.	Minimum length: 1. Maximum length: 255.
providerNpi	body	Yes	string	Required 10-digit provider National Provider Identifier.	Pattern constraint declared in OpenAPI.
providerTin	body	Yes	string	Required provider tax identifier accepted by the request schema. It is not included in public estimate responses.	Minimum length: 9. Maximum length: 11.
facilityName	body	No	string	Optional facility display name.	Minimum length: 1. Maximum length: 255.
facilityId	body	No	string	Optional QuickRCM facility identifier stored on the estimate when supplied. Resolve it in the same organization before sending.	Minimum length: 1.
serviceDate	body	Yes	string	Required planned service date as `YYYY-MM-DD` or ISO datetime input.	Minimum length: 1.
deliveryMethod	body	No	GFE_DEL_EMAIL \| GFE_DEL_PORTAL \| GFE_DEL_MAIL \| GFE_DEL_HAND_DELIVERY \| GFE_DEL_FAX	Optional intended or recorded delivery method enum.	Enum values are declared in the Type column.
lineItems	body	Yes	object[]	Required array of 1 through 100 estimate line items.	OpenAPI does not declare additional validation metadata.
lineItems[].cptCode	body	Yes	string	Current Procedural Terminology (CPT) or CPT-like procedure code used by Contract Management simulation and fee schedule import entries. The public schema caps this at 20 characters.	Minimum length: 4. Maximum length: 7.
lineItems[].description	body	Yes	string	Human-readable description of the queue, workflow, or record. Avoid secrets and unnecessary PHI.	Minimum length: 1. Maximum length: 1000. Sensitive credential or storage-adjacent value; use placeholders only.
lineItems[].quantity	body	Yes	number	Positive service quantity for a line item.	OpenAPI does not declare additional validation metadata.
lineItems[].unitCharge	body	Yes	number	Positive unit charge for a line item. Server-side logic computes `totalCharge`.	Financial value; preserve decimal precision and avoid real account details.

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.

{
  "patientId": "00000000-0000-4000-8000-000000000001",
  "providerName": "Example good_faith_estimate",
  "providerNpi": "1234567893",
  "providerTin": "example-providertin",
  "serviceDate": "2026-06-08",
  "lineItems": [
    {
      "cptCode": "example-cptcode",
      "description": "Example good_faith_estimate note",
      "quantity": 1.25,
      "unitCharge": 125.5
    }
  ],
  "signature": "example-signature",
  "appointmentId": "00000000-0000-4000-8000-000000000001",
  "facilityName": "Example good_faith_estimate",
  "facilityId": "00000000-0000-4000-8000-000000000001",
  "deliveryMethod": "GFE_DEL_EMAIL"
}

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.

201

Good Faith Estimate created

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 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"
    }
  },
  "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