Endpoint pages

Server-rendered endpoint documentation generated from the OpenAPI contract. Use these pages for crawler-visible descriptions, request fields, and generated examples; use Scalar for interactive exploration.

ADR

7 endpoints
POSTPublic reference baselineFile or artifact/api/v1/adr/requests/{adrId}/documents
Add an ADR document reference
Validates or registers an external document reference for an organization-scoped ADR.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/adr/requests
Create ADR request
Creates a local, claim-linked ADR request after verifying that the claim belongs to the authenticated organization.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.
GETPublic reference baselineRead-only/api/v1/adr/requests/{adrId}
Get ADR request
Returns one ADR request when the ADR identifier resolves inside the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineExternal or credentialed/api/v1/adr/requests
List ADR requests
Returns ADR requests owned by the authenticated API key organization, with filters for status, ADR type, claim, assignee, overdue state, requestor entity, submission method, received date, response deadline, and search text.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/adr/requests/{adrId}/submit
Mark ADR response submitted
Marks an organization-scoped ADR response as submitted and stores the local submission method and optional tracking identifier.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/adr/requests/{adrId}/outcome
Record ADR outcome
Records an approved or denied outcome for an organization-scoped ADR that is already in ADR_SUBMITTED status.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/adr/requests/{adrId}/documents/assemble
Simulate ADR document assembly
Validates an organization-scoped ADR and returns a simulated document assembly plan comparing requested document types with existing document references.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.

Agent Builder

25 endpoints
DELETENeeds publication reviewLocal write/api/v1/agent-builder/definitions/{agentId}
Archive agent definition
Archives an organization-owned Agent Builder definition through the DELETE endpoint and returns safe definition metadata.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/executions/{executionId}/cancel
Cancel agent execution
Requests cancellation for an organization-owned Agent Builder execution and returns safe execution metadata.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/definitions/{agentId}/clone
Clone agent definition
Clones an organization-owned Agent Builder definition into a new draft definition and returns safe metadata for the clone.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/definitions
Create agent definition
Creates a new Agent Builder definition as an organization-scoped database-only write and returns safe definition metadata.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.
POSTNeeds publication reviewQueue or async/api/v1/agent-builder/executions
Create agent execution wrapper
Creates an organization-scoped Agent Builder execution wrapper record with dry-run and queue-only safety controls.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/definitions/{agentId}/schedules
Create agent schedule
Creates an organization-scoped schedule under a non-archived Agent Builder definition.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.
DELETENeeds publication reviewLocal write/api/v1/agent-builder/schedules/{scheduleId}
Delete agent schedule
Deletes an organization-scoped Agent Builder schedule and returns a deletion confirmation.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.
GETNeeds publication reviewRead-only/api/v1/agent-builder/definitions/{agentId}
Get agent definition
Retrieves safe metadata for one Agent Builder definition in the authenticated organization.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewValidate or simulate/api/v1/agent-builder/executions/{executionId}
Get agent execution
Retrieves a detailed, organization-scoped Agent Builder execution record with scrubbed output data and execution metadata.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.
GETNeeds publication reviewRead-only/api/v1/agent-builder/executions/{executionId}/result
Get agent execution result
Retrieves the current organization-scoped execution detail payload for result inspection.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/agent-builder/executions/{executionId}/status
Get agent execution status
Retrieves the current organization-scoped execution detail payload for status polling.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/agent-builder/schedules/{scheduleId}
Get agent schedule
Retrieves safe metadata for one organization-scoped Agent Builder schedule.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/templates/{templateId}/install
Install agent template
Installs a built-in or organization-published template as a new draft Agent Builder definition.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.
GETNeeds publication reviewRead-only/api/v1/agent-builder/definitions
List agent definitions
Returns paginated, organization-scoped metadata for Agent Builder definitions, filtered by lifecycle status, RCM category, application type, or search text.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/agent-builder/executions
List agent executions
Returns paginated, organization-scoped execution metadata for Agent Builder polling and monitoring workflows.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/agent-builder/schedules
List agent schedules
Returns paginated, organization-scoped schedule metadata for Agent Builder schedules.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/agent-builder/templates
List agent templates
Lists built-in and organization-published Agent Builder templates with safe template metadata and pagination.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewExternal or credentialed/api/v1/agent-builder/credentials
List automation credentials
Returns paginated safe metadata for automation credentials that can be referenced by Agent Builder definitions, schedules, template installs, or executions.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/schedules/{scheduleId}/pause
Pause agent schedule
Sets an organization-owned Agent Builder schedule inactive and returns safe schedule metadata.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/definitions/{agentId}/publish-template
Publish agent definition as template
Publishes an organization-owned Agent Builder definition as an organization template and returns safe definition metadata.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.
POSTNeeds publication reviewLocal write/api/v1/agent-builder/schedules/{scheduleId}/resume
Resume agent schedule
Sets an organization-owned Agent Builder schedule active and returns safe schedule metadata.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.
POSTNeeds publication reviewQueue or async/api/v1/agent-builder/executions/{executionId}/retry
Retry agent execution wrapper
Creates a new safe retry execution record for an organization-owned Agent Builder execution using dry-run and queue-only controls.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/agent-builder/schedules/{scheduleId}/webhook-secret/rotate
Rotate schedule webhook secret
Generates a new webhook secret for an organization-owned Agent Builder schedule and returns it once.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.
PUTNeeds publication reviewLocal write/api/v1/agent-builder/definitions/{agentId}
Update agent definition
Updates an existing organization-owned Agent Builder definition after an organization-scoped lookup and returns safe metadata.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.
PUTNeeds publication reviewLocal write/api/v1/agent-builder/schedules/{scheduleId}
Update agent schedule
Updates an organization-owned Agent Builder schedule and returns safe schedule metadata.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.

Appeals

41 endpoints
POSTPublic reference baselineLocal write/api/v1/appeals/reminders/{reminderId}/acknowledge
Acknowledge appeal reminder
Acknowledges an organization-scoped appeal reminder.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.
POSTPublic reference baselineFile or artifact/api/v1/appeals/{appealId}/documents
Add appeal supporting document
Adds a required supporting document placeholder to an appeal.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/appeals/peer-to-peer/{p2pReviewId}/cancel
Cancel peer-to-peer review
Cancels a peer-to-peer review with a required reason.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.
POSTPublic reference baselineLocal write/api/v1/appeals/{appealId}/packet/compile
Compile appeal packet
Compiles an appeal packet workflow and records storage state without returning storage keys.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.
POSTPublic reference baselineLocal write/api/v1/appeals
Create appeal
Creates a first-level appeal for an existing organization-owned denial case.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.
POSTPublic reference baselineFile or artifact/api/v1/appeals/documents/{documentId}/download-url
Create appeal document download URL
Creates a short-lived presigned download URL for a linked appeal document file.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/appeals/documents/{documentId}/upload-url
Create appeal document upload URL
Creates a presigned upload URL and local file record for an appeal supporting document.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/appeals/compliance-rules
Create or update appeal compliance rule
Creates or updates an organization-scoped appeal compliance rule using payer type, jurisdiction state, and appeal level.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
DELETEPublic reference baselineFile or artifact/api/v1/appeals/documents/{documentId}
Delete appeal document
Deletes an organization-scoped appeal supporting document row.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/appeals/templates/{templateId}/duplicate
Duplicate system appeal template
Copies a system appeal template into the authenticated organization for customization.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.
POSTPublic reference baselineLocal write/api/v1/appeals/{appealId}/escalate
Escalate appeal
Creates or returns the next-level appeal when the current appeal is eligible for escalation.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.
POSTPublic reference baselineFile or artifact/api/v1/appeals/{appealId}/documents/checklist
Generate appeal document checklist
Generates required supporting document checklist rows for an appeal.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/appeals/{appealId}
Get appeal
Returns one organization-owned appeal and can include a sanitized timeline and escalation chain.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineFile or artifact/api/v1/appeals/analytics/{reportType}
Get appeal analytics report
Returns a read-only appeal analytics report for a selected report type.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/appeals/calendar
Get appeal calendar
Returns appeal calendar event data for deadlines and peer-to-peer reviews within a date range.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/appeals/compliance-dashboard
Get appeal compliance dashboard
Returns summary appeal compliance metrics and recent events for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/appeals/compliance-events/{eventId}
Get appeal compliance event
Returns one appeal compliance event owned by the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineFile or artifact/api/v1/appeals/compliance-reports/payer
Get appeal payer compliance report
Returns payer-focused appeal compliance report data for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/appeals/templates/for-payer
Get appeal template for payer
Returns the best system appeal template for a payer, falling back to the generic commercial template.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/appeals/deadlines/overdue
Get overdue appeals
Returns active appeals whose deadlines are already past due for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/appeals/peer-to-peer/{p2pReviewId}
Get peer-to-peer review
Returns one organization-scoped peer-to-peer review.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/appeals/deadlines/upcoming
Get upcoming appeal deadlines
Returns upcoming and overdue active appeal deadline data for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineFile or artifact/api/v1/appeals/documents/{documentId}/link-file
Link appeal document file
Links an organization-owned file record to an appeal supporting document.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/appeals/compliance-events
List appeal compliance events
Lists appeal compliance events for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/appeals/compliance-rules
List appeal compliance rules
Lists appeal compliance rules available to the authenticated organization, including organization-specific and global rules.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineFile or artifact/api/v1/appeals/{appealId}/documents
List appeal documents
Lists supporting document rows for an organization-owned appeal.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/appeals
List appeals
Returns appeal summaries owned by the authenticated organization, with filters for pagination, workflow status, appeal level, denial case, claim, outcome, submission method, payer identity/name, deadline range, created range, updated range, and submitted range.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/appeals/peer-to-peer
List peer-to-peer reviews
Lists peer-to-peer review records for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineExternal or credentialed/api/v1/appeals/templates/library
List system appeal templates
Lists global payer-specific appeal templates available to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/appeals/{appealId}/outcome
Record appeal outcome
Records the payer or review outcome for an appeal and optionally captures recovered amount and notes.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/appeals/peer-to-peer/{p2pReviewId}/outcome
Record peer-to-peer outcome
Records status and outcome details for an existing peer-to-peer review.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.
PUTPublic reference baselineLocal write/api/v1/appeals/peer-to-peer/{p2pReviewId}/reschedule
Reschedule peer-to-peer review
Reschedules a peer-to-peer review with a required reason.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.
PUTPublic reference baselineLocal write/api/v1/appeals/compliance-events/{eventId}/resolve
Resolve appeal compliance event
Marks an appeal compliance event as resolved.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.
POSTPublic reference baselineLocal write/api/v1/appeals/compliance-scan
Run appeal compliance scan
Runs local appeal compliance checks and creates compliance event rows for detected issues.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.
POSTPublic reference baselineLocal write/api/v1/appeals/{appealId}/peer-to-peer
Schedule peer-to-peer review
Schedules a peer-to-peer review for an organization-owned appeal.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.
POSTPublic reference baselineLocal write/api/v1/appeals/{appealId}/deadlines
Set appeal deadline
Sets or extends the deadline for an organization-owned appeal.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.
POSTPublic reference baselineExternal or credentialed/api/v1/appeals/{appealId}/submit
Submit appeal
Submits or validates a local appeal workflow using the selected submission method.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/appeals/compliance-rules/{ruleId}
Update appeal compliance rule by id
Updates an organization-scoped appeal compliance rule by rule id.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.
PUTPublic reference baselineFile or artifact/api/v1/appeals/documents/{documentId}/status
Update appeal document status
Reviews, approves, or rejects an appeal supporting document.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/appeals/{appealId}/status
Update appeal status
Updates an appeal's workflow status through the module state machine.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.
POSTPublic reference baselineLocal write/api/v1/appeals/{appealId}/withdraw
Withdraw appeal
Withdraws an active organization-owned appeal with a required reason.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.

AR Management

16 endpoints
PUTPublic reference baselineLocal write/api/v1/ar-management/patient-accounts/{accountId}/collection-stage
Advance patient AR collection stage
Advances a patient AR account collection stage and creates a local collection task.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.
PUTPublic reference baselineLocal write/api/v1/ar-management/work-queue-items/bulk-assignment
Bulk assign AR work queue items
Assigns multiple AR work queue items to a tenant user after checking membership and item ownership.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.
POSTPublic reference baselineLocal write/api/v1/ar-management/appeals
Create AR appeal tracking record
Creates a local AR appeal tracking record from an organization-scoped denial or recovery context.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.
POSTPublic reference baselineExternal or credentialed/api/v1/ar-management/follow-ups
Create AR follow-up
Records a payer, patient, agency, or internal AR follow-up and updates linked work queue touch metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ar-management/work-queues
Create AR work queue
Creates a local Accounts Receivable work queue for organizing payer follow-up, patient balance, denial, collection, or appeal work.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/ar-management/work-queue-items
Create AR work queue item
Creates a local AR work queue item after verifying queue, claim, and assignee ownership.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.
POSTPublic reference baselinePayment or credit/api/v1/ar-management/patient-accounts/{accountId}/payment-plans
Create patient AR payment plan
Creates a local patient Accounts Receivable payment plan after account ownership and active-plan checks.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.
POSTPublic reference baselineLocal write/api/v1/ar-management/correspondence
Generate AR correspondence
Generates and stores local AR correspondence metadata and content without external delivery.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.
GETPublic reference baselineRead-only/api/v1/ar-management/work-queue-items
List AR work queue items
Lists Accounts Receivable work items for the authenticated organization with optional queue, status, priority, and pagination filters.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/ar-management/work-queues
List AR work queues
Lists non-deleted Accounts Receivable work queues owned by the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
PUTPublic reference baselineExternal or credentialed/api/v1/ar-management/correspondence/{correspondenceId}/send
Queue AR correspondence send
Records a queued or simulated send status for local AR correspondence without making a live external delivery call.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/ar-management/patient-accounts/{accountId}/financial-assistance
Queue patient AR financial assistance review
Queues a patient financial-assistance review using a PHI-safe local audit record without directly applying discounts.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/ar-management/correspondence/{correspondenceId}/response
Record AR correspondence response
Records response metadata for organization-scoped AR correspondence.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.
PUTPublic reference baselineLocal write/api/v1/ar-management/appeals/{appealId}
Update AR appeal tracking record
Updates an organization-scoped AR appeal tracking record.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.
PUTPublic reference baselineLocal write/api/v1/ar-management/work-queues/{queueId}
Update AR work queue
Updates local configuration for an organization-scoped Accounts Receivable work queue.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.
PUTPublic reference baselineLocal write/api/v1/ar-management/work-queue-items/{itemId}/status
Update AR work queue item status
Updates the status of a local AR work queue item and writes an AR audit entry.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.

Billing

21 endpoints
POSTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/codes
Add billing encounter code
Adds a human-reviewed code to an editable Billing encounter.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.
POSTPublic reference baselineFile or artifact/api/v1/billing/encounters/{encounterId}/files
Add billing encounter files
Links existing organization-owned files to a Billing encounter and queues file processing.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/billing/encounters
Create billing encounter
Creates an INGESTED hospital billing encounter for the authenticated organization without running inline AI processing.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.
POSTPublic reference baselineLocal write/api/v1/billing/cdm/{cdmId}/deactivate
Deactivate billing CDM entry
Soft-deactivates an organization-owned CDM entry and records a CDM audit row.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.
DELETEPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/codes/{codedEntryId}
Delete billing encounter code
Deletes a code from an editable Billing encounter and records a suppression so reprocessing does not restore it.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.
POSTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/finalize
Finalize billing encounter
Moves a HUMAN_REVIEW Billing encounter to FINALIZED and optionally queues claim generation.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.
GETPublic reference baselinePayment or credit/api/v1/billing/cdm/{cdmId}
Get billing CDM entry
Returns one organization-owned Charge Description Master entry by CDM ID.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.
GETPublic reference baselineRead-only/api/v1/billing/encounters/{encounterId}
Get billing encounter
Returns detailed billing status and coding outputs for one encounter in the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselinePayment or credit/api/v1/billing/cdm
List billing CDM entries
Lists Charge Description Master entries for the authenticated organization with search and filter controls.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.
GETPublic reference baselineRead-only/api/v1/billing/encounters
List billing encounters
Lists billing encounters in the authenticated organization with bounded pagination and optional status, encounter type, external encounter ID, and patient filters.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/billing/encounters/{encounterId}/physician-queries
List billing physician queries
Lists physician queries for one Billing encounter in the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineQueue or async/api/v1/billing/import
Queue billing batch import
Queues a Billing encounter batch import for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/billing/cdm/import
Queue billing CDM import
Queues a CDM rate import for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/billing/encounters/{encounterId}/reprocess
Queue billing encounter reprocess
Queues Billing encounter reprocessing for an editable, organization-scoped encounter.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/billing/encounters/bulk-finalize
Queue bulk billing encounter finalization
Queues bulk finalization for multiple HUMAN_REVIEW Billing encounters in the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/billing/encounters/{encounterId}/physician-queries/{queryId}/response
Respond to billing physician query
Records a response to a PENDING or SENT Billing physician query through an organization-scoped parent encounter relation.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/unfinalize
Unfinalize billing encounter
Reopens a FINALIZED Billing encounter by moving it back to HUMAN_REVIEW.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.
PUTPublic reference baselineLocal write/api/v1/billing/cdm/{cdmId}
Update billing CDM entry
Updates fields on an organization-owned CDM entry and records audit rows for changed fields.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.
PUTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}
Update billing encounter
Updates safe claim-form and encounter-reference fields on an editable Billing encounter.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.
PUTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/codes/{codedEntryId}
Update billing encounter code
Updates an existing code on an editable Billing encounter and marks it human-reviewed.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.
PUTPublic reference baselineLocal write/api/v1/billing/encounters/{encounterId}/poa
Update billing encounter POA indicators
Updates Present On Admission indicator data for a Billing encounter.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.

Claims

10 endpoints
POSTPublic reference baselineQueue or async/api/v1/claims/{claimId}/status/check
Check claim status
Queues a safe local claim-status check task for an organization-scoped claim.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/claims/{claimId}/attachments/files
Create attachment file upload
Creates a presigned upload target for a claim attachment file after verifying claim ownership.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/claims/drafts
Create claim draft
Creates a local professional, institutional, or dental claim draft for the authenticated organization.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.
GETPublic reference baselineRead-only/api/v1/claims/{claimId}
Get claim
Returns a single organization-owned claim with line-level and status-check summary context.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineExternal or credentialed/api/v1/claims
List claims
Returns claim records owned by the authenticated organization and lets integrators filter by workflow status, claim type, patient, payer, facility, and service date.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/claims/{claimId}/attachments
Save claim attachment metadata
Stores claim attachment metadata tied to a claim and claim-status context, including payer, patient, subscriber, provider, encounter, and document details.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/claims/{claimId}/submit
Submit claim
Queues a safe local claim submission task for a professional, institutional, or dental claim.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/claims/{claimId}/attachments/{attachmentId}/submit
Submit claim attachment
Queues a safe local attachment-submission task for a file associated with an organization-scoped claim.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/claims/predeterminations
Submit claim predetermination
Queues a safe local predetermination workflow for professional or institutional claim-like data.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/claims/{claimId}/draft
Update claim draft
Updates an existing local claim draft after QuickRCM verifies that the claim belongs to the authenticated organization.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.

Collections

18 endpoints
POSTNeeds publication reviewLocal write/api/v1/collections/compliance/check
Check collections compliance
Runs a local pre-contact collections compliance check for the authenticated organization using supplied patient/contact context, active rules, and optional placement enrichment.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.
POSTNeeds publication reviewLocal write/api/v1/collections/placements
Create bad debt placements
Creates one or more local bad debt placement records after validating that the target agency is active in the authenticated organization.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.
POSTNeeds publication reviewLocal write/api/v1/collections/agencies
Create collection agency
Creates a local collection agency record inside the authenticated organization.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.
POSTNeeds publication reviewLocal write/api/v1/collections/compliance/rules
Create collections compliance rule
Creates a local collections compliance rule inside the authenticated organization.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.
DELETENeeds publication reviewLocal write/api/v1/collections/compliance/rules/{ruleId}
Deactivate collections compliance rule
Soft-deactivates a collections compliance rule by marking it inactive after an organization-scoped lookup.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.
GETNeeds publication reviewRead-only/api/v1/collections/placements/{placementId}
Get bad debt placement
Returns one bad debt placement when `placementId` belongs to the authenticated organization.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/collections/agencies/{agencyId}
Get collection agency
Returns one collection agency when `agencyId` resolves inside the authenticated organization.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/collections/compliance/rules/{ruleId}
Get collections compliance rule
Returns one collections compliance rule when `ruleId` belongs to the authenticated organization.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/collections/placements
List bad debt placements
Lists bad debt placement records owned by the authenticated organization, with optional status, agency, patient, and skip/take filters.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/collections/agencies
List collection agencies
Lists collection agency records owned by the organization selected by the bearer API key, with optional agency status and skip/take pagination.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/collections/compliance/rules
List collections compliance rules
Lists collections compliance rules owned by the authenticated organization, optionally filtered by active state and rule type.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewLocal write/api/v1/collections/placements/{placementId}/recall
Recall bad debt placement
Marks an organization-owned bad debt placement as recalled in local QuickRCM collections tracking when its current status is recallable.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.
PUTNeeds publication reviewLocal write/api/v1/collections/placements/{placementId}/recovery
Record bad debt recovery
Records a positive local recovery amount against an organization-owned bad debt placement that is in a recoverable agency-work 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.
POSTNeeds publication reviewLocal write/api/v1/collections/placements/{placementId}/disputes
Record placement dispute
Appends a local dispute note to an organization-owned bad debt placement.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.
PUTNeeds publication reviewLocal write/api/v1/collections/placements/{placementId}/disputes/{disputeId}/resolve
Resolve placement dispute
Appends a local dispute resolution note to an organization-owned placement and can replace the local total balance with a verified amount.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.
PUTNeeds publication reviewLocal write/api/v1/collections/agencies/{agencyId}
Update collection agency
Updates editable fields on an organization-owned collection agency.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.
PUTNeeds publication reviewLocal write/api/v1/collections/compliance/rules/{ruleId}
Update collections compliance rule
Replaces the editable body-backed fields on a collections compliance rule after an organization-scoped rule lookup.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.
POSTNeeds publication reviewCommunication/api/v1/collections/placements/{placementId}/validation-notice
Validate or queue debt validation notice
Validates or queues local debt validation notice evidence for an organization-owned placement without external delivery.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.

Contract Management

10 endpoints
PUTNeeds publication reviewLocal write/api/v1/contract-management/underpayment-cases/{caseId}/assignment
Assign underpayment case
Assigns one organization-owned underpayment case to an active member of the authenticated organization and records local activity/audit evidence.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/contract-management/contracts
Create insurance contract
Creates an organization-scoped insurance contract after validating the body and verifying the referenced payer configuration and optional facility are owned by the authenticated organization.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/contract-management/simulations
Create rate simulation
Creates a local what-if rate simulation draft for an organization-owned payer configuration.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.
POSTNeeds publication reviewValidate or simulate/api/v1/contract-management/underpayments/detect
Detect underpayments
Runs an organization-scoped local scan of paid claims for potential underpayment cases, using `dryRun` by default.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.
GETNeeds publication reviewRead-only/api/v1/contract-management/contracts/{contractId}
Get insurance contract
Returns one organization-owned insurance contract with its active rate schedules.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewExternal or credentialed/api/v1/contract-management/contracts
List insurance contracts
Lists insurance contract summaries owned by the authenticated organization with optional filters for payer configuration, facility, active status, and base reimbursement type.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.
POSTNeeds publication reviewQueue or async/api/v1/contract-management/underpayment-cases/{caseId}/dispute-letter
Record dispute letter request
Records a local dispute-letter request and audit activity for one organization-owned underpayment case.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewLocal write/api/v1/contract-management/underpayment-cases/{caseId}/resolve
Resolve underpayment case
Closes one organization-owned underpayment case with a recovery, write-off, or no-recovery resolution and records local activity/audit evidence.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.
PUTNeeds publication reviewLocal write/api/v1/contract-management/contracts/{contractId}
Update insurance contract
Updates editable fields on one organization-owned insurance contract and records local audit evidence.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.
POSTNeeds publication reviewValidate or simulate/api/v1/contract-management/fee-schedules/import
Validate or import fee schedule
Validates fee schedule rows by default, or imports local fee schedule and rate rows when `validateOnly` is false.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.

Coordination of Benefits

10 endpoints
POSTNeeds publication reviewLocal write/api/v1/cob/secondary-claims/batch-generate
Batch generate COB secondary claims
Attempts to generate local secondary-claim records for 1 to 50 supplied opportunities and returns aggregate counts plus per-primary-claim success or error outcomes.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/cob/secondary-claims/{secondaryClaimId}/status/check
Check COB secondary claim status
Returns the current local secondary-claim status for an organization-owned secondary claim that is already submitted or acknowledged.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/cob/orders/{patientId}
Create or update patient COB order
Creates or updates the local payer-order record for one organization-owned patient, including primary, secondary, optional tertiary insurance identifiers and the determination method.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.
POSTNeeds publication reviewFile or artifact/api/v1/cob/secondary-claim-opportunities/detect
Detect COB secondary claim opportunities
Scans organization-scoped primary remittance data for claims that may need secondary billing and returns sanitized opportunity summaries without patient names, raw X12 835 Electronic Remittance Advice (ERA), or payer payloads.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, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/cob/secondary-claims/generate
Generate COB secondary claim
Creates one local secondary-claim generation record from an organization-owned primary claim, matched remittance, and secondary payer identifier after building and validating the internal secondary claim payload.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.
GETNeeds publication reviewRead-only/api/v1/cob/secondary-claims/{secondaryClaimId}
Get COB secondary claim
Returns one organization-owned Coordination of Benefits (COB) secondary-claim generation record plus a public-safe summary of its primary claim when available.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewExternal or credentialed/api/v1/cob/secondary-claims
List COB secondary claims
Lists local Coordination of Benefits (COB) secondary-claim generation records owned by the organization selected by the bearer API key, with optional status, secondary payer, created-date, and pagination filters.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.
POSTNeeds publication reviewPayment or credit/api/v1/cob/secondary-claims/{secondaryClaimId}/payments
Post COB secondary payment
Updates the local secondary-claim record with a secondary paid amount and derives a local paid-or-denied 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.
POSTNeeds publication reviewExternal or credentialed/api/v1/cob/secondary-claims/{secondaryClaimId}/submit
Queue COB secondary claim submission
Initiates the public secondary-claim submission workflow for a generated local secondary claim and returns queue/submission tracking metadata without exposing the claim payload.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewPayment or credit/api/v1/cob/secondary-claims/{secondaryClaimId}/void
Void COB secondary claim
Voids a non-paid local secondary-claim record for the authenticated organization and records the local workflow transition.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.

Credentialing

28 endpoints
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/attest
Accept credentialing attestation
Records whether the credentialing attestation has been accepted for an organization-scoped session.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/education
Create credentialing education entry
Adds an education history record to an organization-scoped Credentialing session.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/liability-insurance
Create credentialing liability insurance
Adds liability insurance coverage metadata to an organization-scoped Credentialing session.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/licenses
Create credentialing license entry
Adds a professional license identifier record to an organization-scoped Credentialing session.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/references
Create credentialing professional reference
Adds a professional reference record to an organization-scoped Credentialing session.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions
Create credentialing session
Creates a new local Credentialing session in DRAFT status for the organization selected by the bearer API key.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.
POSTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/work-history
Create credentialing work history entry
Adds a work history record to an organization-scoped Credentialing session.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.
DELETENeeds publication reviewLocal write/api/v1/credentialing/education/{educationId}
Delete credentialing education entry
Soft-deletes a local education history record after verifying tenant ownership through the parent Credentialing session.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.
DELETENeeds publication reviewLocal write/api/v1/credentialing/liability-insurance/{insuranceId}
Delete credentialing liability insurance
Soft-deletes liability insurance coverage metadata after verifying tenant ownership through the parent Credentialing session.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.
DELETENeeds publication reviewLocal write/api/v1/credentialing/licenses/{licenseId}
Delete credentialing license entry
Soft-deletes a local professional license record after verifying tenant ownership through the parent Credentialing session.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.
DELETENeeds publication reviewLocal write/api/v1/credentialing/references/{referenceId}
Delete credentialing professional reference
Soft-deletes a professional reference record after verifying tenant ownership through the parent Credentialing session.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.
DELETENeeds publication reviewLocal write/api/v1/credentialing/work-history/{workHistoryId}
Delete credentialing work history entry
Soft-deletes a local work history record after verifying tenant ownership through the parent Credentialing session.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.
GETNeeds publication reviewFile or artifact/api/v1/credentialing/sessions/{sessionId}
Get credentialing session
Returns one organization-owned Credentialing session with local document metadata when the session belongs to the API-key organization and is not soft-deleted.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.
POSTCompatibility-limitedExternal or credentialed/api/credentialing/update-status
Legacy update credentialing status callback
Provides a deprecated compatibility callback for updating a local Credentialing session status through the public API authentication path.Compatibility-limited; not for happy-path guides. Requires versioning and compatibility-route classification before broad use. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETNeeds publication reviewRead-only/api/v1/credentialing/sessions
List credentialing sessions
Returns paginated credentialing session summaries owned by the organization selected by the bearer API key, optionally filtered by credentialing session status.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewExternal or credentialed/api/v1/credentialing/sessions/{sessionId}/submit
Queue credentialing application submit
Validates Credentialing application readiness and returns a safe workflow response without payer portal submission.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewFile or artifact/api/v1/credentialing/documents/{documentId}/process
Queue credentialing document processing
Validates ownership of a local credentialing document and returns a simulated document-processing workflow response.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewFile or artifact/api/v1/credentialing/sessions/{sessionId}/documents
Queue credentialing document upload
Validates a credentialing document upload request for a tenant-owned session and returns a simulated queue response.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewFile or artifact/api/v1/credentialing/sessions/{sessionId}/signature
Save credentialing signature reference
Links an existing organization-owned QuickRCM File record as the signature reference for a Credentialing session.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/credentialing/sessions/{sessionId}/caqh
Update credentialing CAQH info
Creates or updates non-secret CAQH metadata for an organization-scoped Credentialing session.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/education/{educationId}
Update credentialing education entry
Updates a local education history record after verifying it belongs to a session in the API-key organization.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/liability-insurance/{insuranceId}
Update credentialing liability insurance
Updates liability insurance coverage metadata after verifying it belongs to a session in the API-key organization.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/licenses/{licenseId}
Update credentialing license entry
Updates a professional license record after verifying it belongs to a session in the API-key organization.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/references/{referenceId}
Update credentialing professional reference
Updates a professional reference record after verifying it belongs to a session in the API-key organization.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/provider-info
Update credentialing provider info
Creates or updates structured provider profile fields for an organization-scoped Credentialing session.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/credentialing/sessions/{sessionId}
Update credentialing session
Updates public-safe session metadata for an organization-scoped Credentialing session, including status notes, display provider name, assignment, and selected payer configurations.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/sessions/{sessionId}/status
Update credentialing session status
Updates the local status of a tenant-owned Credentialing session after validating the transition against the shared credentialing status machine.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.
PUTNeeds publication reviewLocal write/api/v1/credentialing/work-history/{workHistoryId}
Update credentialing work history entry
Updates a local work history record after verifying it belongs to a session in the API-key organization.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.

Denial Management

10 endpoints
POSTNeeds publication reviewLocal write/api/v1/denial-management/cases/{denialCaseId}/appeals
Create denial appeal draft
Creates a local draft appeal for an organization-owned denial case, or returns the existing draft appeal for that case.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.
POSTNeeds publication reviewLocal write/api/v1/denial-management/queue-rules
Create denial queue rule
Creates a local Denial Management routing rule after validating that the target queue and any action references belong to the authenticated organization.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.
GETNeeds publication reviewRead-only/api/v1/denial-management/cases/{denialCaseId}
Get denial case
Returns one denial case when the case identifier belongs to the organization selected by the bearer API key.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewLocal write/api/v1/denial-management/cases/{denialCaseId}/remittances/{remittanceId}
Link remittance to denial case
Associates an organization-owned remittance record with an organization-owned denial case by storing the remittance identifier on the case.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.
GETNeeds publication reviewExternal or credentialed/api/v1/denial-management/cases
List denial cases
Lists denial cases owned by the organization selected by the bearer API key, with optional filters for local status, denial category, severity, payer, claim, patient, queue, owner user, and pagination.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.
GETNeeds publication reviewRead-only/api/v1/denial-management/queue-rules
List denial queue configuration
Returns Denial Management queues and queue routing rules configured for the organization selected by the bearer API key.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
PUTNeeds publication reviewLocal write/api/v1/denial-management/cases/{denialCaseId}/route
Reroute denial case
Moves one organization-owned denial case to another organization-owned Denial Management queue, updates queue counters when the queue changes, and records a local reroute activity.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.
PUTNeeds publication reviewLocal write/api/v1/denial-management/cases/{denialCaseId}/status
Update denial case status
Updates the local status of one organization-owned denial case after validating the requested transition and writes a DenialActivity audit record.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.
PUTNeeds publication reviewLocal write/api/v1/denial-management/queue-rules/{ruleId}
Update denial queue rule
Updates one organization-owned Denial Management routing rule after validating the rule exists and any merged action references remain organization-scoped.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.
POSTNeeds publication reviewFile or artifact/api/v1/denial-management/documents/extract
Validate denial document extraction
Validates or dry-runs a denial document extraction request using metadata only; public API callers cannot trigger OCR, LLM extraction, storage writes, queueing, or payer calls through this endpoint.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, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

EHR

11 endpoints
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/patients/bulk
Bulk create EHR patients
Creates up to 100 local QuickRCM patient rows from inline JSON and returns per-row counts plus sanitized patient summaries.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/appointments
Create EHR appointment
Creates a local QuickRCM appointment for an organization-scoped patient and returns the sanitized appointment summary.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/patients
Create EHR patient
Creates a local QuickRCM patient in the authenticated organization using a database-only write and duplicate detection on demographics and MRN.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/patients/{patientId}/insurances
Create EHR patient insurance
Creates a local patient insurance record for an organization-scoped patient after resolving or creating the tenant payer configuration.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/find-patient
Find EHR patient by demographics
Finds one local QuickRCM patient ID by exact trimmed first name, exact trimmed last name, and date-of-birth day within the organization selected by the bearer API key.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.
GETNeeds publication reviewExternal or credentialed/api/v1/ehr/patients/{patientId}/appointments
List EHR patient appointments
Lists local appointment summaries for one patient after first verifying the patient belongs to the authenticated organization.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/ehr/appointments/{appointmentId}/eligibility/check
Queue appointment eligibility check
Creates a local queued eligibility-check record for an organization-scoped appointment and patient insurance record without calling a payer or clearinghouse synchronously.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewExternal or credentialed/api/v1/ehr/appointments/{appointmentId}
Update EHR appointment
Updates local appointment scheduling fields after an organization-scoped appointment lookup.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/ehr/appointments/{appointmentId}/status
Update EHR appointment status
Updates only the local appointment status after verifying the appointment belongs to the authenticated organization.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/ehr/patients/{patientId}
Update EHR patient
Updates safe local patient demographic fields after verifying the patient belongs to the authenticated organization.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/ehr/patients/{patientId}/insurances/{insuranceId}
Update EHR patient insurance
Updates a local patient insurance record after proving both the patient and insurance row belong to the authenticated organization.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.

EHR Integration

15 endpoints
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/config/activate
Activate EHR integration configuration
Sets the authenticated organization's local EHR integration configuration to active and returns sanitized config metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/config
Create or update EHR integration configuration
Creates or updates the authenticated organization's local EHR integration configuration using redacted setup metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/mappings
Create or update EHR mapping
Creates or updates a FIELD or FACILITY mapping after verifying parent resources belong to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/config/deactivate
Deactivate EHR integration configuration
Sets the authenticated organization's local EHR integration configuration to inactive and returns sanitized config metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
DELETEPublic reference baselineExternal or credentialed/api/v1/ehr-integration/mappings/{mappingId}
Delete EHR mapping
Deletes a FIELD or FACILITY mapping after an organization-scoped ownership lookup.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/ehr-integration/config
Get EHR integration configuration summary
Returns the authenticated organization's sanitized EHR integration configuration summary, or null when no configuration exists.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/ehr-integration/mappings
List EHR mappings
Lists sanitized FIELD or FACILITY mappings for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/ehr-integration/conflicts
List EHR sync conflicts
Lists sanitized EHR sync conflicts for the authenticated organization with entityType, resolution, and pagination filters.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/ehr-integration/sync-logs
List EHR sync logs
Lists sanitized EHR sync-log metadata for the authenticated organization with filters for log id, entity type, status, direction, date range, summaryOnly, and pagination.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/syncs
Queue EHR manual sync
Queues a local manual EHR sync job for one supported entity type and returns the summary sync-log id.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/syncs/epic-bulk-import
Queue Epic bulk import
Queues an Epic Bulk FHIR import job and returns local queue metadata without making an external Epic request in the HTTP handler.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/conflicts/{conflictId}/resolve
Resolve EHR sync conflict
Records a local resolution state for a pending EHR sync conflict and returns sanitized conflict metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/config/test
Validate EHR connection-test request
Validates a redacted EHR connection-test request shape and credential-status metadata without calling an external EHR adapter.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/ehr-integration/syncs/full-resync/validate
Validate EHR full resync
Dry-run validates a full-resync request and counts organization-scoped EHR id mappings that would be affected for the configured external system and entity type.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/ehr-integration/syncs/record/validate
Validate EHR record sync
Dry-run validates a single EHR record-sync request and reports whether a matching local EHR id mapping exists.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

Eligibility

5 endpoints
POSTPublic reference baselineValidate or simulate/api/v1/eligibility/batches
Create bulk eligibility batch
Validates and creates a safe organization-scoped bulk eligibility batch wrapper for CSV-backed or Amazon S3-backed batch input.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.
POSTPublic reference baselineLocal write/api/v1/eligibility/checks
Create eligibility check
Creates an eligibility verification workflow for the authenticated organization and returns a sanitized eligibilityCheck summary.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.
GETPublic reference baselineRead-only/api/v1/eligibility/batches/{batchId}
Get bulk eligibility batch
Returns sanitized bulk eligibility batch progress and aggregate check status for a batch owned by the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/eligibility/checks/{eligibilityCheckId}
Get eligibility check
Returns one sanitized eligibilityCheck summary when eligibilityCheckId belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineQueue or async/api/v1/eligibility/batches/{batchId}/queue
Queue bulk eligibility batch
Marks an existing organization-scoped bulk eligibility batch as queued for local worker pickup, with a dry-run response option.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.

Enhanced claim status

8 endpoints
GETNeeds publication reviewRead-only/api/v1/claim-status/inquiries/{id}
Get inquiry processing state
Requires claim-status:read scope. Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/claim-status/inquiries/{id}/raw
Get restricted raw response history
Requires claim-status:raw scope. Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewFile or artifact/api/v1/claim-status/inquiries/{id}/result
Get saved canonical or mapped result
Requires claim-status:read scope. Default view is canonical. For mapped reports use view=mapped; rows are at data.data.rows. processingState describes worker progress; outcome describes payer/result success. Inspect errors even on HTTP 200. retryable=false means do not blindly resubmit.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, E3 async and idempotency policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETNeeds publication reviewRead-only/api/v1/claim-status/profiles
List organization mapping profiles
Requires claim-status:read scope. Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewLocal write/api/v1/claim-status/profiles/{id}/publish
Publish immutable mapping version
Requires claim-status:mappings scope. 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.
POSTNeeds publication reviewExternal or credentialed/api/v1/claim-status/inquiries/{id}/reprocess
Replay saved responses without a payer call
Requires claim-status:write scope. 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.
POSTNeeds publication reviewLocal write/api/v1/claim-status/profiles
Save mapping draft
Requires claim-status:mappings scope. 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.
POSTNeeds publication reviewExternal or credentialed/api/v1/claim-status/inquiries
Start enhanced claim status search
Requires claim-status:write scope. Idempotency-Key is optional. If omitted, every submission creates a fresh inquiry with a generated UUID returned as idempotencyKey. Reuse the returned or supplied key for retries of the same request. The latest published mappingProfileId version is pinned at creation.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

EOB to ERA

7 endpoints
PUTPublic reference baselineLocal write/api/v1/eob2era/conversions/bulk
Bulk update EOB to ERA conversions
Bulk-updates safe public fields on Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion records whose IDs belong to the authenticated organization.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.
POSTPublic reference baselineValidate or simulate/api/v1/eob2era/conversions/{conversionId}/classify
Classify EOB to ERA conversion
Classifies caller-supplied safe Electronic Remittance Advice (ERA) summary fields for one organization-owned Explanation of Benefits (EOB) to ERA conversion and optionally persists only the resulting ERA 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.
POSTPublic reference baselineFile or artifact/api/v1/eob2era/conversions
Create EOB to ERA conversion
Validates an Explanation of Benefits (EOB) upload request or creates a local EOB-to-ERA conversion record from an existing organization-owned File row.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/eob2era/conversions/{conversionId}
Get EOB to ERA conversion
Returns one sanitized Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion record when it belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/eob2era/conversions
List EOB to ERA conversions
Lists sanitized Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion records owned by the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineQueue or async/api/v1/eob2era/conversions/{conversionId}/process
Trigger EOB processing safely
Simulates processing or records a safe local PROCESSING status transition for one organization-owned Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/eob2era/conversions/{conversionId}
Update EOB to ERA conversion
Updates safe public fields on one organization-owned Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion.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.

ERA

2 endpoints

Good Faith Estimates

10 endpoints
POSTNeeds publication reviewLocal write/api/v1/gfe/estimates/{gfeId}/acknowledge
Acknowledge a Good Faith Estimate
Records patient acknowledgment for an organization-owned Good Faith Estimate that is currently in delivered 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.
POSTNeeds publication reviewFile or artifact/api/v1/gfe/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.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.
POSTNeeds publication reviewValidate or simulate/api/v1/gfe/estimates/{gfeId}/deliver
Deliver a Good Faith Estimate
Marks a local Good Faith Estimate as delivered, or returns a no-write simulation response when `simulateOnly` is true.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.
GETNeeds publication reviewRead-only/api/v1/gfe/estimates/{gfeId}
Get a Good Faith Estimate
Returns one organization-scoped Good Faith Estimate summary, including public line items and a linked IDR case summary when the estimate detail query includes one.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewFile or artifact/api/v1/gfe/estimates/{gfeId}/pdf-url
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.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.
POSTNeeds publication reviewLocal write/api/v1/gfe/estimates/{gfeId}/disputes
Initiate a GFE dispute
Creates a local IDR case for an acknowledged Good Faith Estimate when the billed amount exceeds the estimate by at least the module's dispute threshold.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.
GETNeeds publication reviewRead-only/api/v1/gfe/estimates
List Good Faith Estimates
Lists Good Faith Estimate records owned by the organization selected by the bearer API key, with optional filters for local GFE status, patient, service-date range, overdue flag, and page-based pagination.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
PUTNeeds publication reviewLocal write/api/v1/gfe/idr-cases/{idrCaseId}
Update a GFE IDR case
Updates local status and safe financial tracking fields on an organization-owned GFE IDR case.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.
PUTNeeds publication reviewLocal write/api/v1/gfe/estimates/{gfeId}
Update a Good Faith Estimate
Updates editable fields on an organization-owned Good Faith Estimate when the current estimate is still in an editable local 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.
POSTNeeds publication reviewPayment or credit/api/v1/gfe/estimates/{gfeId}/void
Void a Good Faith Estimate
Voids a local Good Faith Estimate in a voidable status and records the void reason in local audit context.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.

Insurance Discovery

7 endpoints
PUTPublic reference baselineLocal write/api/v1/insurance-discovery/searches/{searchId}/dismiss
Dismiss discovered coverage
Marks a found discovery result as dismissed inside the authenticated organization.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.
GETPublic reference baselineRead-only/api/v1/insurance-discovery/searches/{searchId}
Get insurance discovery search
Returns one local insurance discovery search when it belongs to the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/insurance-discovery/searches
List insurance discovery searches
Lists local insurance discovery search records owned by the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineLocal write/api/v1/insurance-discovery/searches/{searchId}/retry
Retry failed insurance discovery search
Retries a failed insurance discovery search in simulated mode inside the authenticated organization.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.
POSTPublic reference baselineLocal write/api/v1/insurance-discovery/searches
Run insurance discovery search
Creates and runs a single insurance discovery search for a patient in the authenticated organization.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.
POSTPublic reference baselineLocal write/api/v1/insurance-discovery/batches
Start batch insurance discovery
Starts a simulated batch insurance discovery workflow for unique patients in the authenticated organization.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.
POSTPublic reference baselineLocal write/api/v1/insurance-discovery/searches/{searchId}/verify
Verify discovered coverage
Verifies discovered coverage and applies local QuickRCM database updates inside the authenticated organization.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.

Medical Coding

18 endpoints
PUTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/codes/{codeId}
Accept, reject, or update a coded item
Accepts, rejects, or updates one coded item in the local extracted coding data for an organization-scoped CodingJob.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/medical-coding/jobs/{codingJobId}/clarifications
Answer clarifications or queue safe reprocess
Stores clarification answers for a CodingJob or records a simulated clarification reprocess request.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/cdi-queries
Create a CDI query
Creates an organization-scoped Clinical Documentation Improvement (CDI) query from public API-safe fields.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs
Create a queued medical coding job
Creates an organization-scoped CodingJob from supplied medical-record text and optional same-organization linkages, then records local public API queue metadata.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/automation-rules
Create or update a coding automation rule
Creates or updates an organization-scoped coding automation rule with local conditions and actions JSON.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewFile or artifact/api/v1/medical-coding/outpatient/batches
Create outpatient billing batch
Creates a local outpatient billing batch for one or more upload IDs already scoped to the authenticated organization.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewFile or artifact/api/v1/medical-coding/outpatient/uploads
Create outpatient billing upload metadata
Creates organization-scoped outpatient billing upload metadata from file descriptors without uploading file bytes.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETNeeds publication reviewRead-only/api/v1/medical-coding/jobs/{codingJobId}
Get medical coding job
Returns one organization-scoped CodingJob summary without raw clinical note text or the full extractedData payload.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/medical-coding/jobs
List medical coding jobs
Lists CodingJob summaries owned by the organization selected by the bearer API key, with optional local filters for status and linked appointment, claim, or scribe job.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/medical-coding/code-systems
List supported medical coding code systems
Returns the static list of medical coding code systems accepted by the async outpatient coding API.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/claims-queue
Queue coding job claims handoff
Records a claims-queue handoff marker in CodingJob metadata without creating or submitting a claim.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/extract
Queue or simulate coding extraction
Validates or records a safe simulated extraction request for an existing organization-scoped CodingJob.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/rerun
Queue or simulate coding rerun
Validates or records a safe simulated rerun request for an existing organization-scoped CodingJob.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/import
Record a simulated coding import
Creates a local CodingBatchImport record for a simulated medical-coding import batch.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/outpatient/checks
Run a safe outpatient billing check
Validates or creates a local outpatient billing check run for an organization-scoped CodingJob without external processing.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}/outpatient/draft
Save an outpatient billing draft
Validates or saves local outpatient billing draft selections for an organization-scoped CodingJob and records a coder decision row on save.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewQueue or async/api/v1/medical-coding/jobs/{codingJobId}
Update a medical coding job
Updates safe local workflow fields on an organization-scoped CodingJob and returns the updated public job summary.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTNeeds publication reviewQueue or async/api/v1/medical-coding/cdi-queries/{queryId}/status
Update CDI query lifecycle status
Updates local lifecycle status fields for an organization-scoped Clinical Documentation Improvement (CDI) query.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.

OIG Exclusion

5 endpoints
POSTPublic reference baselineExternal or credentialed/api/v1/oig-exclusion/checks
Create OIG exclusion check
Submits one organization-scoped provider OIG screening request and returns the sanitized local check result. The runtime can return an existing recent matching check instead of creating a new row or performing a fresh federal-source lookup.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/oig-exclusion/checks/{checkId}
Get OIG exclusion check
Returns one OIG exclusion check when the check belongs to the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/oig-exclusion/checks
List OIG exclusion checks
Returns a paginated list of OIG exclusion checks owned by the organization selected by the bearer API key, with optional filters for local status, checked-at date bounds, entity-name search text, and sort order.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
PUTPublic reference baselineLocal write/api/v1/oig-exclusion/checks/{checkId}/resolution
Resolve OIG exclusion match
Records a human false-positive or confirmed-excluded decision for an organization-owned OIG exclusion check in a resolvable 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.
POSTPublic reference baselineValidate or simulate/api/v1/oig-exclusion/checks/bulk
Simulate organization-wide OIG exclusion check
Returns an organization-scoped dry-run summary for screenable employees and providers, including latest run metadata, without calling LEIE or SAM.gov sources.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.

Patient AR

18 endpoints
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/accounts/{accountId}/adjustments
Adjust patient AR charge
Applies a local positive adjustment amount to a charge on the selected Patient AR account and decrements the account current balance.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.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/payments/{paymentId}/applications
Apply patient AR payment
Applies an existing organization-scoped patient payment to one or more local charges on the payment account and updates charge and account balances.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.
POSTPublic reference baselineLocal write/api/v1/patient-ar/deposit-batches/{batchId}/close
Close patient AR deposit batch
Closes a local deposit batch and records actual amount, variance, closure metadata, and balanced/unbalanced 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.
POSTPublic reference baselineLocal write/api/v1/patient-ar/accounts
Create patient AR account
Creates a local Patient AR account after verifying the patient, optional guarantor, and optional facility belong to the authenticated organization.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.
POSTPublic reference baselineLocal write/api/v1/patient-ar/collection-tasks
Create patient AR collection task
Creates a local PENDING collection task for an organization-scoped Patient AR account.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.
POSTPublic reference baselineLocal write/api/v1/patient-ar/deposit-batches
Create patient AR deposit batch
Creates a local deposit batch for cash/check-style Patient AR reconciliation in the authenticated organization.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.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/payments
Create patient AR payment
Creates a local non-card Patient AR payment record or validates/dry-runs/returns a queue-only acknowledgement for card, debit, and ACH payment requests without calling Stripe directly.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.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/payment-plans
Create patient AR payment plan
Creates a local DRAFT payment plan and scheduled payment rows for an organization-scoped Patient AR account.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.
POSTPublic reference baselineLocal write/api/v1/patient-ar/statements
Create patient AR statement draft
Creates a local Patient AR statement draft for an organization-scoped account.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.
GETPublic reference baselineRead-only/api/v1/patient-ar/accounts/{accountId}
Get patient AR account
Returns one organization-scoped Patient AR account with the same account detail shape used by list responses.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/patient-ar/accounts
List patient AR accounts
Lists patient accounts receivable accounts owned by the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineLocal write/api/v1/patient-ar/collection-tasks/{taskId}/activities
Log patient AR collection activity
Logs a local collection activity on an organization-scoped collection task and updates the task contact rollup.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.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/accounts/{accountId}/charges
Post patient AR charge
Posts a local patient-responsibility charge to an organization-scoped Patient AR account and increments the account current balance.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.
PUTPublic reference baselineLocal write/api/v1/patient-ar/accounts/{accountId}
Update patient AR account
Updates safe local account status, collection status, collection score, hardship, charity amount, financial class, and note fields on an organization-scoped Patient AR account.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.
PUTPublic reference baselineLocal write/api/v1/patient-ar/collection-tasks/{taskId}
Update patient AR collection task
Updates local status, outcome, priority, due date, promise-to-pay fields, and notes on an organization-scoped collection task.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.
PUTPublic reference baselinePayment or credit/api/v1/patient-ar/payment-plans/{planId}
Update patient AR payment plan
Updates local payment-plan status, installment amount, next payment date, or cancellation reason for an organization-scoped payment plan.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.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/payments/{paymentId}/refund
Validate or queue patient AR refund
Validates or returns a queue-only acknowledgement for a patient payment refund request for an organization-scoped payment without calling Stripe or mutating payment rows directly.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselinePayment or credit/api/v1/patient-ar/payments/{paymentId}/void
Validate or queue patient AR void
Validates or returns a queue-only acknowledgement for a patient payment void request for an organization-scoped payment without calling Stripe or mutating payment rows directly.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.

Payer Enrollment

16 endpoints
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/assignment
Assign payer enrollment application
Assigns an active payer enrollment application to a user who is a member of the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/status/bulk
Bulk update payer enrollment application status
Attempts to apply one local status transition to up to 100 active payer enrollment applications in the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/clone
Clone payer enrollment application
Creates a local DRAFT application for a different organization-scoped target payer by copying selected data from a source application.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications
Create payer enrollment application
Creates a local DRAFT payer enrollment application for an organization-owned provider profile and payer configuration.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/provider-profiles
Create payer enrollment provider profile
Creates a local provider enrollment profile and initializes local payer enrollment stubs for the organization's configured payers.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}
Get payer enrollment application
Returns one active payer enrollment application when it belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications
List payer enrollment applications
Lists active payer enrollment applications owned by the organization selected by the bearer API key.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/deficiencies
Record payer enrollment deficiency
Creates a local deficiency record for an active payer enrollment application and may move the application to DEFICIENCY_RECEIVED when that transition is valid.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/follow-ups
Record payer enrollment follow-up
Records a local follow-up note for an active organization-scoped payer enrollment application and updates local follow-up counters on the application.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/deficiencies/{deficiencyId}/resolve
Resolve payer enrollment deficiency
Marks a local payer enrollment deficiency as RESOLVED when its parent application belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/enrollments/{enrollmentId}
Update payer enrollment
Updates local payer enrollment fields on one organization-scoped payer enrollment row.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}
Update payer enrollment application field
Updates one field in the local application data object for an active organization-scoped payer enrollment application.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/status
Update payer enrollment application status
Applies a valid local status transition to an active payer enrollment application.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/provider-profiles/sync-from-credentialing
Validate credentialing profile sync
Validates whether an organization-scoped credentialing session has provider information suitable for profile sync, without writing provider enrollment data.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/{applicationId}/submit
Validate payer enrollment application submission
Validates that an active application could move toward submitted workflow and returns a simulated-only submission response.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/payer-enrollment/applications/bulk-import
Validate payer enrollment bulk import
Dry-runs a bulk payer enrollment import by validating provider NPIs and payer names against organization-scoped QuickRCM records.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

Payment Posting

11 endpoints
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/payers/refresh
Dry-run payer ID refresh
Finds organization-owned remittances whose local `payerId` is `UNKNOWN` and returns sanitized refresh candidates without fetching files or parsing EDI payloads.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, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
GETNeeds publication reviewPayment or credit/api/v1/payment-posting/payments/{paymentId}
Get posted payment
Returns one payment posting record when it is linked through a remittance in the authenticated organization, including sanitized remittance, remittance-claim, claim-control, line-payment, and adjustment summaries.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.
GETNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances
List payment posting remittances
Returns a paginated list of sanitized remittance summaries owned by the organization selected by the bearer API key, with optional filters for local remittance status, payer name, and inclusive check-date bounds.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.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}/match
Match remittance claims
Runs local claim matching for one organization-owned remittance, updates local remittance-claim match state and remittance statistics, and returns aggregate matched/total counts.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.
PUTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}
Update remittance metadata
Updates non-PHI metadata on one organization-owned remittance and returns the refreshed sanitized remittance summary.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.
PUTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}/status
Update remittance status
Updates the local workflow status on one organization-owned remittance and returns the refreshed sanitized remittance summary.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.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittance-claims/{remittanceClaimId}/post-payment
Validate direct payment posting
Validates direct post-payment input against one organization-scoped remittance claim and returns a safe simulated acceptance response without creating Payment records or mutating claim balances.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/import
Validate or queue ERA remittance import
Validates ERA import metadata for the authenticated organization and checks for a duplicate remittance by exact organization, check number, parsed check date, and payer name. The public wrapper does not download files, parse raw X12 835 EDI, or create remittance rows.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, E3 async and idempotency policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}/confirm
Validate or queue payment posting confirmation
Validates or safely simulates confirm-posting readiness for one organization-owned remittance by counting locally staged payments.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}/stage
Validate payment staging
Dry-runs payment staging for one organization-owned remittance and reports how many remittance claims are currently MATCHED.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.
POSTNeeds publication reviewPayment or credit/api/v1/payment-posting/remittances/{remittanceId}/finalize
Validate remittance finalization
Validates or safely simulates public remittance finalization for one organization-owned remittance without invoking internal HMAC worker endpoints.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.

Prevention

25 endpoints
PUTPublic reference baselineLocal write/api/v1/prevention/alerts/{alertId}
Acknowledge prevention alert
Acknowledges an organization-owned prevention alert or dismisses it when `dismiss` is true.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.
POSTPublic reference baselineQueue or async/api/v1/prevention/findings/{findingId}/auto-fix/apply
Apply a prevention auto-fix
Applies an approved local auto-fix for an eligible organization-owned prevention finding.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/rules/{ruleId}/approve
Approve a prevention rule
Approves an organization-owned prevention rule and sets its lifecycle target to `PILOT` or `ENFORCE`.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/prevention/claims/{claimId}/clear
Clear a scrubbed claim for submission
Marks the latest organization-scoped scrub for a claim as cleared for submission when the clear gate allows it.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/rules
Create a prevention rule
Creates a local prevention rule draft for the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/education
Create provider education content
Creates provider education content for the authenticated organization without invoking external generation.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/alerts/{alertId}/dismiss
Dismiss a prevention alert
Dismisses an organization-owned prevention alert with a required reason.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/prevention/alerts/{alertId}
Get prevention alert
Returns one prevention alert after verifying that `alertId` belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineQueue or async/api/v1/prevention/work-items/{workItemId}
Get prevention work item status
Returns the status of a queued public prevention work item when it belongs to the authenticated organization. Metadata is not returned.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/prevention/alerts
List prevention alerts
Lists prevention claim-creation alerts owned by the authenticated organization, with filters for lifecycle status, severity, alert type, claim, claim line, user, created date range, and pagination.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineQueue or async/api/v1/prevention/findings/{findingId}/auto-fix/preview
Preview a prevention auto-fix
Builds a local auto-fix preview for an eligible organization-owned prevention finding without mutating claim line data.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineExternal or credentialed/api/v1/prevention/learned-rules/{learnedRuleId}/promote
Promote a learned payer rule
Promotes an organization-owned learned payer rule into a draft local prevention rule workflow.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/claims/{claimId}/scrub
Queue a prevention claim scrub
Validates an organization-owned claim and either validates, simulates, or queues a local prevention scrub work item.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/predictions
Queue denial risk prediction
Validates an organization-owned claim and either validates, simulates, or queues a local denial-risk prediction work item.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/claims/batch-scrub
Queue prevention claim scrubs in batch
Validates a bounded batch of organization-owned claims and either validates, simulates, or queues local prevention scrub work items for them.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/education/generate
Queue provider education generation
Validates provider and denial-pattern inputs, analyzes a bounded set of matching local denial cases, and returns safe workflow state without invoking a large language model (LLM) in the public handler.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/claims/{claimId}/recall
Recall a cleared claim
Moves a recently cleared organization-owned claim scrub back into prevention review.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/alerts/{alertId}/act
Record action on a prevention alert
Records that an organization-owned prevention alert was acted upon and stores a required action note.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/predictions/{predictionId}/outcome
Record denial prediction outcome
Records the actual outcome for an organization-owned denial prediction to support feedback and accuracy tracking.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/education/{educationContentId}/delivery
Record provider education delivery
Records local delivery or engagement status for organization-owned provider education content.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineExternal or credentialed/api/v1/prevention/findings/{findingId}/status
Resolve a prevention finding
Updates the workflow status and resolution metadata for an organization-owned pre-submission finding.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/auto-fixes/{autoFixRunId}/revert
Revert a prevention auto-fix
Reverts a prior applied auto-fix run when it belongs to the organization and contains reversible rollback data.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineQueue or async/api/v1/prevention/rules/{ruleId}/simulate
Simulate a prevention rule
Runs a local simulation for an organization-owned prevention rule over a bounded historical claim sample without changing production claim state.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineQueue or async/api/v1/prevention/rules/{ruleId}
Update a prevention rule
Updates an organization-owned prevention rule and records a new version snapshot in current handler behavior.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineQueue or async/api/v1/prevention/education/{educationContentId}
Update provider education content
Updates organization-owned provider education content and local workflow metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.

Prior Authorization

17 endpoints
PUTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations/bulk/status
Bulk update prior authorization status
Bulk-updates status values for prior authorization cases within the authenticated organization.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/prior-auth/requirements/check
Check prior authorization requirement
Checks whether a service appears to require prior authorization for the organization selected by the bearer API key, using payer, service, diagnosis, and optional provider/member/place-of-service context.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.
POSTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations
Create prior authorization
Creates a prior authorization case for the authenticated organization and returns a sanitized case summary.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.
POSTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations/{priorAuthId}/appeals
Create prior authorization appeal
Creates a local appeal for a denied prior authorization in the authenticated organization.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.
POSTNeeds publication reviewFile or artifact/api/v1/prior-auth/authorizations/{priorAuthId}/documents
Create prior authorization document upload
Creates a local prior authorization document record and returns a scoped presigned upload URL.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/prior-auth/authorizations/{priorAuthId}/renew
Create prior authorization renewal
Creates a local renewal case from an approved or expired prior authorization and returns the renewal case summary.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
GETNeeds publication reviewRead-only/api/v1/prior-auth/authorizations/{priorAuthId}
Get prior authorization
Returns one prior authorization summary when the `priorAuthId` belongs to the organization selected by the bearer API key.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewFile or artifact/api/v1/prior-auth/batches/{batchId}
Get prior authorization batch status
Returns status for one prior authorization bulk upload batch in the authenticated organization.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.
POSTNeeds publication reviewFile or artifact/api/v1/prior-auth/batches
Queue prior authorization bulk upload
Creates a bulk upload processing batch for an already-uploaded prior authorization file. The public OpenAPI description requires public callers to use `queueOnly: true`.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, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/prior-auth/authorizations/bulk/submit
Queue prior authorization submissions
Queues prior authorization submissions for asynchronous processing. The public OpenAPI description requires public callers to use `queueOnly: true`.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations/drafts
Save prior authorization draft
Creates or updates a draft prior authorization for the authenticated organization according to the public operation description.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.
PUTNeeds publication reviewExternal or credentialed/api/v1/prior-auth/authorizations/{priorAuthId}/submit
Submit prior authorization
Submits an existing prior authorization case for payer review according to the public OpenAPI description and returns the updated local case summary.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.
PUTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations/{priorAuthId}
Update prior authorization
Updates editable prior authorization fields for an organization-scoped case. The route uses PUT because generated Wasp public API routes do not support PATCH.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.
PUTNeeds publication reviewLocal write/api/v1/prior-auth/appeals/{appealId}
Update prior authorization appeal
Updates a local prior authorization appeal and any related local case status according to the public operation description.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.
PUTNeeds publication reviewLocal write/api/v1/prior-auth/authorizations/{priorAuthId}/status
Update prior authorization status
Updates only the status of one organization-scoped prior authorization case, with an optional reason.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.
POSTNeeds publication reviewFile or artifact/api/v1/prior-auth/documents/bulk/submit
Validate bulk prior authorization document submissions
Validates bulk prior authorization document submission requests with organization-scoped local reads. The public OpenAPI description requires `dryRun: true`; vendor submission is skipped.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, E3 async and idempotency policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewFile or artifact/api/v1/prior-auth/authorizations/{priorAuthId}/documents/{documentId}/submit
Validate prior authorization document submission
Validates a prior authorization document submission request with organization-scoped local reads. The public OpenAPI description requires `dryRun: true`; vendor submission is skipped.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, E3 async and idempotency policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.

Reports

2 endpoints

Revenue Integrity

16 endpoints
POSTNeeds publication reviewPayment or credit/api/v1/revenue-integrity/charge-reconciliations
Create a charge reconciliation session
Creates a local charge reconciliation session and explicit source procedure items after validating the facility and each patient belongs to the authenticated organization.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/revenue-integrity/contracts
Create an insurance contract
Creates an organization-owned insurance contract with optional facility scope and optional rate schedule rows after validating payer and facility references.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.
POSTNeeds publication reviewPayment or credit/api/v1/revenue-integrity/charge-lag-reports
Generate a charge lag report
Creates a local charge lag report record for the requested period and optional facility.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.
GETNeeds publication reviewPayment or credit/api/v1/revenue-integrity/dashboard
Get revenue integrity dashboard metrics
Returns organization-scoped Revenue Integrity dashboard metrics grouped by charge reconciliation, coding validation, underpayment recovery, overall revenue at risk, and recovered revenue.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.
GETNeeds publication reviewExternal or credentialed/api/v1/revenue-integrity/underpayment-cases
List underpayment cases
Lists organization-owned underpayment recovery cases with optional filters for status, underpayment type, payer configuration, assignee, and page-based pagination.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/revenue-integrity/contract-rate-validations
Queue a contract rate validation
Validates organization ownership for a claim and optional payer configuration, then records a local contract-rate validation workflow request.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/revenue-integrity/underpayment-checks/manual
Queue a manual underpayment check
Verifies claim ownership and records a local manual underpayment-check workflow request in validated, dry-run, or queued mode.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/revenue-integrity/rate-validations/bulk
Queue bulk rate validation
Validates optional payer/facility ownership and records a local bulk rate validation workflow request over a date range.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/revenue-integrity/underpayment-cases/{caseId}/appeal
Queue underpayment appeal generation
Verifies an underpayment case belongs to the authenticated organization and records a local appeal-generation workflow request in validated, dry-run, or queued mode.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewPayment or credit/api/v1/revenue-integrity/or-reconciliations
Reconcile operating room charges
Creates a local operating room charge reconciliation session from operating room log entries after validating facility and patient ownership.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/revenue-integrity/underpayment-cases/{caseId}/appeal/submit
Record underpayment appeal submission
Records local appeal submission metadata for an organization-owned underpayment case.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.
POSTNeeds publication reviewLocal write/api/v1/revenue-integrity/underpayment-cases/{caseId}/recovery
Record underpayment recovery
Adds a recovered amount to a tenant-owned underpayment case and records local recovery metadata.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.
PUTNeeds publication reviewPayment or credit/api/v1/revenue-integrity/charge-reconciliations/{sessionId}/items/{itemId}/resolve
Resolve a charge reconciliation item
Marks one organization-scoped charge reconciliation item as resolved with a resolution action and optional notes.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.
POSTNeeds publication reviewPayment or credit/api/v1/revenue-integrity/charge-audits
Run a charge capture audit
Creates a local charge capture audit record after validating supplied patient, claim, facility, and billing encounter references when present.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.
POSTNeeds publication reviewLocal write/api/v1/revenue-integrity/implant-recoveries
Track implant recovery
Creates a local underpayment case of type IMPLANT_COST for an organization-owned claim and records local underpayment workflow activity.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.
POSTNeeds publication reviewValidate or simulate/api/v1/revenue-integrity/coding-validations
Validate coding data
Creates a local coding validation result from structured diagnosis and procedure code inputs, with optional claim, billing encounter, patient, Diagnosis-Related Group, encounter-type, Present on Admission, and length-of-stay request context.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.

Risk Adjustment

7 endpoints
POSTPublic reference baselineFile or artifact/api/v1/risk-adjustment/jobs/bulk
Bulk create risk adjustment jobs
Validates patient-document pairs and creates queued risk adjustment jobs in bulk for the authenticated organization when not running validation only.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/risk-adjustment/jobs/{jobId}/cancel
Cancel risk adjustment job
Cancels an active queued or processing risk adjustment job in the authenticated organization.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.
POSTPublic reference baselineFile or artifact/api/v1/risk-adjustment/jobs
Create risk adjustment job
Validates a patient-document pair and creates a queued risk adjustment job for the authenticated organization when not running validation only.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
GETPublic reference baselineRead-only/api/v1/risk-adjustment/jobs/{jobId}
Get risk adjustment job
Returns one tenant-scoped risk adjustment job with sanitized HCC result summaries when the job belongs to the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/risk-adjustment/jobs
List risk adjustment jobs
Lists paginated risk adjustment jobs for the organization selected by the bearer API key, with optional status and patient filters.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineQueue or async/api/v1/risk-adjustment/jobs/{jobId}/reprocess
Reprocess risk adjustment job
Validates or resets a terminal risk adjustment job and queues it for reprocessing in the authenticated organization.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/risk-adjustment/jobs/{jobId}/hcc-codes/{codeId}/review
Review risk adjustment HCC code
Records a human review decision for one HCC code on a tenant-scoped risk adjustment job without returning raw evidence text or review notes.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.

Scribe

10 endpoints
POSTPublic reference baselineFile or artifact/api/v1/scribe/jobs/{jobId}/files
Attach scribe job file
Records metadata for an already-uploaded organization-scoped scribe audio file, links that audio reference to the job, sets the job status to `UPLOADING`, and returns sanitized file and job metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/scribe/jobs/{jobId}/attest
Attest scribe job
Marks a completed or already-attested organization-scoped scribe job as `ATTESTED`, optionally recording an attestation note, and returns sanitized job metadata.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineFile or artifact/api/v1/scribe/jobs
Create scribe job
Creates an organization-scoped scribe job in `UPLOADING` status, validates that the templateId and optional patientId belong to the authenticated organization, stores the supplied audio reference, and immediately attempts to enqueue asynchronous scribe processing.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
POSTPublic reference baselineLocal write/api/v1/scribe/templates
Create scribe template
Creates an organization-scoped scribe template for public API job creation, storing reusable prompt text from `structurePrompt` when supplied or from `template` otherwise.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.
GETPublic reference baselineRead-only/api/v1/scribe/jobs/{jobId}
Get scribe job
Returns one organization-scoped scribe job and its generated finalNote field when available.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/scribe/jobs
List scribe jobs
Returns paginated scribe job summaries owned by the organization selected by the bearer API key, with optional filters for job status, patient, appointment, and template.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
GETPublic reference baselineRead-only/api/v1/scribe/templates
List scribe templates
Returns paginated organization-scoped reusable scribe templates available for public API job creation.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication.
POSTPublic reference baselineFile or artifact/api/v1/scribe/jobs/{jobId}/process
Queue scribe job processing
Queues asynchronous processing for an existing organization-scoped scribe job that already has an attached audio reference, updates local status to `TRANSCRIBING`, and returns HTTP 202 queue acknowledgement.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy, E3 async and idempotency policy, and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineFile or artifact/api/v1/scribe/jobs/{jobId}
Update scribe job
Updates safe public fields on an organization-scoped scribe job, including status, finalNote, templateId, audioDurationSeconds, and executionMode.Baseline reference only. Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy and E4 file and artifact governance before production recipes, SDK inclusion, or try-out access.
PUTPublic reference baselineLocal write/api/v1/scribe/templates/{templateId}
Update scribe template
Updates an organization-scoped scribe template, including reusable prompt text from `structurePrompt` when supplied or from `template` otherwise.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.

SFTP EDI

1 endpoints

Specialty Billing

29 endpoints
POSTNeeds publication reviewCommunication/api/v1/specialty-billing/hospice/notices/{noticeId}/acknowledgement
Acknowledge hospice notice
Records a local hospice notice acknowledgement and updates local notice acknowledgement state.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.
GETNeeds publication reviewRead-only/api/v1/specialty-billing/home-health/claims/{claimId}/status
Check home-health claim status
Returns local claim status information for an organization-scoped home-health claim.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
GETNeeds publication reviewRead-only/api/v1/specialty-billing/hospice/claims/{claimId}/status
Check hospice claim status
Returns local claim status information for an organization-scoped hospice claim.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/home-health/authorizations
Create home-health authorization
Creates a local home-health prior authorization tracker after verifying the episode and optional payer config.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.
POSTNeeds publication reviewPayment or credit/api/v1/specialty-billing/home-health/episodes
Create home-health episode
Creates a local home-health episode, a draft certification, and two initial open payment periods for the authenticated organization.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.
POSTNeeds publication reviewLocal write/api/v1/specialty-billing/home-health/referrals
Create home-health referral
Creates a local home-health referral intake record for the authenticated organization.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.
POSTNeeds publication reviewLocal write/api/v1/specialty-billing/hospice/elections
Create hospice election
Creates a local hospice election and initial benefit periods for the authenticated organization.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.
POSTNeeds publication reviewCommunication/api/v1/specialty-billing/hospice/notices
Create hospice notice
Creates a local hospice notice payload for an organization-scoped election without submitting it to a clearinghouse.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.
POSTNeeds publication reviewCommunication/api/v1/specialty-billing/home-health/episodes/{episodeId}/noa
Generate home-health NOA
Validates a home-health Notice of Admission payload by default, or creates a local NOA record when `validateOnly` is explicitly false.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.
GETNeeds publication reviewRead-only/api/v1/specialty-billing/overview
Get specialty billing overview
Returns aggregate case counts and revenue totals for the authenticated organization across anesthesia, ASC, DME, laboratory, and behavioral-health specialty billing records.Needs publication review. Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use.
POSTNeeds publication reviewPayment or credit/api/v1/specialty-billing/home-health/payment-periods/{paymentPeriodId}/claim-draft
Preview home-health claim draft
Validates and previews home-health claim-draft readiness for a local payment period.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/hospice/census/imports/preview
Preview hospice census import
Validates hospice census import rows without writing ledger entries or syncing to an EHR.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.
POSTNeeds publication reviewValidate or simulate/api/v1/specialty-billing/hospice/benefit-periods/{benefitPeriodId}/claim-draft
Preview hospice claim draft
Validates and previews hospice claim-draft readiness for a local benefit period.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.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/home-health/claims/{claimId}/submit
Queue home-health claim submission
Queues a local home-health institutional claim submission marker and writes a local claim status check.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/home-health/episodes/{episodeId}/noa/submit
Queue home-health NOA submission
Queues a local home-health NOA submission attempt and updates the local NOA to pending acknowledgement.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/home-health/oasis/{assessmentId}/submit
Queue home-health OASIS submission
Marks a local home-health OASIS assessment as submitted/queued without calling EHR or CMS systems inline.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewQueue or async/api/v1/specialty-billing/hospice/census/imports/{batchId}/commit
Queue hospice census import commit
Queues a local hospice census import commit marker for an existing batch.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 E3 async and idempotency policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewExternal or credentialed/api/v1/specialty-billing/hospice/claims/{claimId}/submit
Queue hospice claim submission
Queues a local hospice institutional claim submission marker and writes a local claim status check.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewCommunication/api/v1/specialty-billing/hospice/notices/{noticeId}/submit
Queue hospice notice submission
Queues a local hospice notice submission attempt and updates the notice to pending acknowledgement.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, E3 async and idempotency policy, and E7 credential, webhook, and vendor trust policy before production recipes, SDK inclusion, or try-out access.
POSTNeeds publication reviewLocal write/api/v1/specialty-billing/hospice/elections/{electionId}/discharge
Record hospice discharge
Records a local hospice discharge date and sets the local election status to `DISCHARGED`.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.
POSTNeeds publication reviewLocal write/api/v1/specialty-billing/hospice/elections/{electionId}/revocation
Record hospice revocation
Records a local hospice revocation date and sets the local election status to `REVOKED`.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.
PUTNeeds publication reviewLocal write/api/v1/specialty-billing/home-health/authorizations/{authorizationId}/usage
Update home-health authorization usage
Applies integer deltas to local used-visit and used-unit counters for a home-health authorization.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.
PUTNeeds publication reviewLocal write/api/v1/specialty-billing/home-health/episodes/{episodeId}
Update home-health episode
Updates safe local fields on an organization-scoped home-health episode.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.
PUTNeeds publication reviewLocal write/api/v1/specialty-billing/home-health/referrals/{referralId}/status
Update home-health referral status
Updates the local status and optional metadata for an organization-scoped home-health referral.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.
PUTNeeds publication reviewLocal write/api/v1/specialty-billing/hospice/elections/{electionId}
Update hospice election
Updates safe local fields on an organization-scoped hospice election.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.
POSTNeeds publication reviewValidate or simulate/api/v1/specialty-billing/home-health/claims/{claimId}/adrs
Validate home-health ADR creation
Validates a home-health ADR request for a local claim without creating cross-module ADR side effects.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.
POSTNeeds publication reviewValidate or simulate/api/v1/specialty-billing/home-health/denials/{denialCaseId}/appeals
Validate home-health appeal creation
Validates home-health appeal creation inputs for an organization-scoped denial case.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.
POSTNeeds publication reviewValidate or simulate/api/v1/specialty-billing/hospice/claims/{claimId}/adrs
Validate hospice ADR creation
Validates a hospice ADR request for a local claim without creating cross-module ADR side effects.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.
POSTNeeds publication reviewValidate or simulate/api/v1/specialty-billing/hospice/denials/{denialCaseId}/appeals
Validate hospice appeal creation
Validates hospice appeal creation inputs for an organization-scoped denial case.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.

Support

3 endpoints
POSTNeeds publication reviewCommunication/api/v1/support/tickets
Create support ticket
Creates a local SupportTicket record inside the organization selected by the bearer API key and owned by the synthetic public API actor selected by current authentication behavior.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.
GETNeeds publication reviewCommunication/api/v1/support/tickets/{ticketId}
Get support ticket
Returns one local SupportTicket snapshot when the path `ticketId` belongs to both the bearer-key organization and the synthetic public API actor selected by current authentication behavior.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.
GETNeeds publication reviewCommunication/api/v1/support/tickets
List support tickets
Returns local Support ticket snapshots for the bearer-key organization and the synthetic public API actor selected by current public API authentication behavior.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.