EHR

Update EHR patient insurance

Updates a local patient insurance record after proving both the patient and insurance row belong to the authenticated organization.

PUTNeeds publication reviewExternal or credentialedEHRoperationId: updateEhrPatientInsurancehttps://dev-api.quickintell.com/api/v1/ehr/patients/{patientId}/insurances/{insuranceId}

Needs publication reviewExternal or credentialedIntegrations

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 E7 credential, webhook, and vendor trust 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

External or credentialed

May touch credentials, webhooks, SFTP, EHRs, payers, portals, clearinghouses, or other external systems.

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 integrations contract generated for PUT /api/v1/ehr/patients/{patientId}/insurances/{insuranceId}. 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/ehr/patients/{patientId}/insurances/{insuranceId}, 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	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

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.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

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.

EHR public API.

The Electronic Health Record (EHR) public API exposes organization-scoped QuickRCM patient, appointment, patient-insurance, and appointment eligibility queueing endpoints. These endpoints are local QuickRCM API wrappers: patient, appointment, and insurance writes persist local database records; bulk patient import accepts inline JSON and stays database-only; and appointment eligibility creates a queued local eligibility-check record with `queueOnly: true` instead of contacting a payer, clearinghouse, or external EHR synchronously. Use these endpoints with a tenant-scoped bearer API key. The API key selects the organization; callers should not send `organizationId` as a tenant selector. Lookup/list endpoints require `ehr:read` or `ehr:write`, while create/update/queue endpoints require `ehr:write`. organizationId`. Public responses do not return address JSON, contact JSON, raw EHR payloads, raw payer payloads, raw EDI, credentials, transcripts, uploaded file contents, or other sensitive payloads. Patient names, dates of birth, Medical Record Numbers (MRNs), member identifiers, policy numbers, and contact details are Protected Health Information (PHI) or sensitive coverage data and should be logged only in redacted form. Patient matching behavior differs by endpoint. `findEhrPatientByDemographics` is a narrow lookup by exact trimmed first name, exact trimmed last name, and date-of-birth day. Patient create and bulk create use duplicate-detection helpers that can match same-organization demographics case-insensitively and also consider Medical Record Number (MRN) when supplied.

What this endpoint does

Use case

Use this endpoint when an integration needs to correct payer configuration, member details, relationship metadata, priority, or coverage dates for an existing QuickRCM insurance row.

Before calling

Authenticate with an API key that has `ehr:write`. Confirm the QuickRCM `patientId` and `insuranceId`, and send at least one effective insurance field.

Request and response behavior

Request guidance

`patientId` and `insuranceId` are required path parameters. The body must include at least one update field that changes the insurance row. `payerName` only participates when `payerId` is included for payer-config resolution; a `payerName`-only body is accepted by schema shape but produces no insurance-row update and should be documented as an empty/no-op update that returns 400.

`payerId` triggers payer-config lookup or creation; `payerName` is only meaningful alongside `payerId`.
Send null for nullable fields such as `groupNumber`, `policyNumber`, `relationshipCode`, `effectiveDate`, or `expirationDate` when clearing is intended.
Avoid logging member, group, or policy values.
`payerName` is payer-config display metadata; when sent without `payerId`, it does not by itself identify a payer configuration to update.

Response semantics

A 200 response returns the updated sanitized insurance summary and `meta.organizationId`. The endpoint scopes the insurance lookup through the owning patient before updating.

The response includes sanitized local insurance state and payer display metadata.
No raw payer payload, eligibility response, or clearinghouse transaction is returned.
`payerConfigId` can change when `payerId` resolves to another tenant payer configuration.

Errors and retries

Treat 400 as an empty/no-op or invalid update, 401/403 as credential or tenant authorization issues, 404 as patient or insurance not found in the authenticated organization, and 429 as rate limiting.

404 is tenant-safe and is returned when either the patient or insurance row is not accessible in the authenticated organization.
400 is expected for a body that only includes `payerName` without `payerId` because no persisted insurance field changes.
Do not retry malformed dates or empty updates unchanged.

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
patientId	path	Yes	string	QuickRCM patient identifier from the path.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
insuranceId	path	Yes	string	QuickRCM patient insurance identifier from the path. The row must belong to `patientId` and the authenticated organization.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.

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
payerId	body	No	string	Optional replacement organization payer identifier. When supplied, it resolves or creates the local payer configuration.	Minimum length: 1. Maximum length: 120.
payerName	body	No	string	Optional payer display name used only during payer-config resolution when `payerId` is present.	Minimum length: 1. Maximum length: 200.
memberId	body	No	string	Optional replacement coverage member/subscriber identifier.	Minimum length: 1. Maximum length: 120. Potential PHI; use synthetic examples and avoid logging raw values.
groupNumber	body	No	string	Optional replacement or null coverage group number.	Minimum length: 1. Maximum length: 120.
policyNumber	body	No	string	Optional replacement or null coverage policy number.	Minimum length: 1. Maximum length: 120.
relationship	body	No	string	Optional replacement patient-to-subscriber relationship label.	Minimum length: 1. Maximum length: 60. Potential PHI; use synthetic examples and avoid logging raw values.
relationshipCode	body	No	string	Optional replacement or null relationship code.	Minimum length: 1. Maximum length: 20.
priority	body	No	integer	Optional replacement priority from 1 to 10.	Minimum value: 1. Maximum value: 10. Default: 1.
effectiveDate	body	No	string	Optional replacement or null coverage effective date.	Minimum length: 1.
expirationDate	body	No	string	Optional replacement or null coverage expiration date.	Minimum length: 1.

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.

{
  "payerId": "87726",
  "payerName": "Example ehr_patient_insurance",
  "memberId": "W123456789",
  "groupNumber": "example-groupnumber",
  "policyNumber": "example-policynumber",
  "relationship": "example-relationship",
  "relationshipCode": "example-relationshipcode",
  "priority": 1
}

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

Updated patient insurance summary.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "insurance": {
      "id": "00000000-0000-4000-8000-000000000001",
      "patientId": "00000000-0000-4000-8000-000000000001",
      "payerConfigId": "00000000-0000-4000-8000-000000000001",
      "memberId": "W123456789",
      "groupNumber": "example-groupnumber",
      "policyNumber": "example-policynumber",
      "relationship": "example-relationship",
      "relationshipCode": "example-relationshipcode",
      "priority": 1,
      "effectiveDate": "2026-06-08",
      "expirationDate": "2026-06-08",
      "payer": {
        "payerId": "87726",
        "payerName": "Example ehr_patient_insurance"
      },
      "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.