Patient AR

Create patient AR account

Creates a local Patient AR account after verifying the patient, optional guarantor, and optional facility belong to the authenticated organization.

POSTPublic reference baselineLocal writePatient ARoperationId: createPatientArAccounthttps://dev-api.quickintell.com/api/v1/patient-ar/accounts

Public reference baselineLocal writePatient financials

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. 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 POST /api/v1/patient-ar/accounts. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated POST /api/v1/patient-ar/accounts contract as a local write baseline endpoint.

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

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

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	Request body exposes an endpoint-specific idempotencyKey compatibility field.	Retry only with the documented key location and after checking endpoint state; 409 behavior and retention still need release evidence.
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	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

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	Public reference baseline 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.

Patient AR public API.

Patient AR public APIs expose organization-scoped patient accounts receivable account lookup, local account maintenance, patient-responsibility charge posting, local payment application, payment-plan setup, statement draft creation, deposit-batch reconciliation, and collection-task activity logging. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector; all account, patient, guarantor, facility, claim, charge, payment, plan, statement, deposit-batch, collection-task, activity, and assignee identifiers must resolve inside the authenticated organization. Read endpoints accept `patient-ar:read` or `patient-ar:write`; write endpoints require `patient-ar:write` plus Patient AR RBAC through the existing authorization helper. This public surface is intentionally conservative around money movement and outbound contact. Cash, check, wire, and other non-card payment records can be created locally, then applied to local charges. Card, debit, and ACH payment requests must use validation, dry-run, or queue-only controls and do not call Stripe directly from the public handler. Refund and void endpoints validate or return queue-only acknowledgements; they do not settle refunds, void external payments, or mutate payment rows inline. Statement creation creates a local draft only, and collection endpoints record local task/activity state without sending email, SMS, letters, calls, legal notices, or agency placements. Use synthetic examples only. Account numbers, MRNs, patient or guarantor references, contact details, notes, payment references, check numbers, and collection activity can be PHI or sensitive financial data. Do not include raw EDI, payer portal credentials, tokens, S3 keys, vendor payloads, transcripts, or real payment method identifiers in public examples.

What this endpoint does

Use case

Use this when a patient balance workflow needs a local AR account before charges, statements, payment plans, deposits, or collection tasks can be recorded.

Before calling

Resolve the same-tenant `patientId`; optionally resolve a guarantor patient and facility. Check whether the patient already has a Patient AR account to avoid duplicate-account conflicts.

Request and response behavior

Request guidance

`patientId` is required. `currentBalance` defaults to 0, `collectionStatus` defaults to CURRENT, and `status` defaults to ACTIVE. If `accountNumber` is omitted, the handler generates one from an AR prefix and the idempotency marker or timestamp. Keep `notes` PHI-minimal.

`patientId` must resolve to a patient in the API key organization.
`guarantorId` is another patient identifier and must also resolve in the same organization when supplied.
`idempotencyKey` is stored in local metadata; current evidence does not show idempotent replay or duplicate suppression.

Response semantics

HTTP 201 returns a local write acknowledgement with `resourceType: PatientAccount`, operation-result `status: CREATED`, `externalRisk: LOCAL_ONLY`, and a nested `account` detail. It does not create charges, statements, collection placements, or payment plans.

`externalRisk: LOCAL_ONLY` means the endpoint only created QuickRCM local state.
The returned nested account uses decimal strings for monetary balances.
The operation-result `data.status` differs from nested `account.status`, which is the account lifecycle status.

Errors and retries

Fix 400 validation errors and 404 referenced-resource failures before retrying. The handler can return a duplicate-account conflict when an account already exists for the patient, although the current generated OpenAPI common error set does not list 409. After a timeout, list by patient context before creating another account.

404 can mean the patient, guarantor, or facility was not found in the authenticated organization.
409 duplicate-account behavior is evidenced in the handler but is not currently represented in the common OpenAPI error responses.
Do not blind-retry creates after connection timeouts.

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
patientId	body	Yes	string	Required QuickRCM patient identifier for the account.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
guarantorId	body	No	string	Optional QuickRCM patient identifier used as account guarantor.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
facilityId	body	No	string	Optional facility identifier scoped to the authenticated organization.	Minimum length: 1.
accountNumber	body	No	string	Optional caller-provided account number. Treat as sensitive financial context.	Minimum length: 1. Maximum length: 120.
currentBalance	body	No	number	Initial local account balance. Defaults to 0.	Minimum value: 0. Default: 0. Financial value; preserve decimal precision and avoid real account details.
collectionStatus	body	No	CURRENT \| PAST_DUE \| PRE_COLLECT \| IN_COLLECT \| AGENCY \| LEGAL \| PAYMENT_PLAN \| HARDSHIP	Initial collection workflow status. Defaults to CURRENT.	Enum values are declared in the Type column. Default: CURRENT.
status	body	No	ACTIVE \| ON_HOLD \| IN_COLLECTIONS \| CLOSED \| WRITTEN_OFF	Initial account lifecycle status. Defaults to ACTIVE.	Enum values are declared in the Type column. Default: ACTIVE.
financialClass	body	No	string	Optional local financial class label capped at 80 characters.	Minimum length: 1. Maximum length: 80.
notes	body	No	string	Optional staff note capped at 2000 characters. Avoid secrets and unnecessary PHI.	Minimum length: 1. Maximum length: 2000. Sensitive credential or storage-adjacent value; use placeholders only.
idempotencyKey	body	No	string	Optional caller marker stored in local metadata and used when generating a public account number.	Minimum length: 1. Maximum length: 128. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.

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",
  "guarantorId": "00000000-0000-4000-8000-000000000001",
  "facilityId": "00000000-0000-4000-8000-000000000001",
  "accountNumber": "example-accountnumber",
  "currentBalance": 0,
  "collectionStatus": "CURRENT",
  "status": "ACTIVE",
  "financialClass": "example-financialclass",
  "notes": "Example patient_ar_account note"
}

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

Patient AR public API operation completed.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "resourceType": "example-resourcetype",
    "status": "active",
    "id": "00000000-0000-4000-8000-000000000001",
    "externalRisk": "LOCAL_ONLY"
  },
  "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 parameters.