Backend resource · STATIC DECLARATIONS

Claim Workbench API reference · mansoq-core

Static source contract for Claim Workbench: 6 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/facility/{facility_external_id}/rcm/claims/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

One claim, the eight facts that price it, and the encounter above it.

Operation map

Method	Path	Action	Evidence
GET	`/api/v1/facility/{facility_external_id}/rcm/claims/`	list	declared/inherited method
GET	`/api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/`	retrieve	declared/inherited method
GET	`/api/v1/facility/{facility_external_id}/rcm/claims/by-encounter/`	by_encounter	@action declaration
GET	`/api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/lines/`	lines	@action declaration
GET	`/api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/attachments/`	attachments	@action declaration
POST	`/api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/classify-response/`	classify_response	@action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/claims/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/ — action retrieve. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

by_encounter · GET

Every claim produced by one encounter, with the local invoices apart.

One encounter can produce several claims. This is the surface that says so, rather than letting a one-row-per-encounter list imply otherwise.

GET /api/v1/facility/{facility_external_id}/rcm/claims/by-encounter/ — action by_encounter. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: ValidationError: encounter is required; PermissionDenied: Cannot read revenue-cycle records.

lines · GET

The line grid: charge, contractual, authorization, tax, liability.

GET /api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/lines/ — action lines. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

attachments · GET

Required supporting information, and what is still missing.

GET /api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/attachments/ — action attachments. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

classify_response · POST

Where a response belongs: adjudication, denial, error queue or polling.

Exposed as its own endpoint because the rule is worth asserting directly: complete + rejected never routes to the error queue.

POST /api/v1/facility/{facility_external_id}/rcm/claims/{external_id}/classify-response/ — action classify_response. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location	Parameter	Type	Required
path	facility_external_id	router lookup string; semantic ID validation requires handler/schema review	true
path	external_id	router lookup string; semantic ID validation requires handler/schema review	true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location	Field	Declared/inferred read type	Requiredness evidence
body	`processing_outcome`	not declared at read site	not established
body	`adjudication_outcome`	not declared at read site	not established
query	`encounter`	not declared at read site	not established
query	`{computed field name}`	not declared at read site	not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.