← Technical API reference

Backend resource · STATIC DECLARATIONS

Configuration Override API reference · mansoq-core

Static source contract for Configuration Override: 5 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/overrides/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Scope, reason, approver, expiry and retrospective review. All five.

The service refuses a global scope, a self-approval, an absent or past expiry and a review due before the expiry, and writes the act as an append-only audit event. The queryable row is written alongside it so the expiry can be swept rather than found by somebody reading events.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/rcm/overrides/ list declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/overrides/ create declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/overrides/{external_id}/ retrieve declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/overrides/{external_id}/expire/ expire @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/overrides/{external_id}/complete_review/ complete_review @action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/overrides/ — 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 review_queue_key not declared at read site not established
query review_outstanding not declared at read site not established
query live not declared at read site not established

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

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

create · POST

Record an urgent override, or refuse it for the reason it fails.

POST /api/v1/facility/{facility_external_id}/rcm/overrides/ — action create. 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 review_queue_key not declared at read site not established
query review_outstanding not declared at read site not established
query live not declared at read site not established

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

Explicit response statuses in observed code: 201. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: Cannot edit RCM configuration; ValidationError: Request body must be an object; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/overrides/{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 review_queue_key not declared at read site not established
query review_outstanding not declared at read site not established
query live not declared at read site not established

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

Declared refusal/error evidence: PermissionDenied: Cannot read RCM configuration.

expire · POST

Close the override and route the expiry into its own review queue.

POST /api/v1/facility/{facility_external_id}/rcm/overrides/{external_id}/expire/ — action expire. 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 review_queue_key not declared at read site not established
query review_outstanding not declared at read site not established
query live not declared at read site not established

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

Declared refusal/error evidence: ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot edit RCM configuration; ValidationError: Request body must be an object; PermissionDenied: Cannot read RCM configuration.

complete_review · POST

Complete the retrospective review. A signature is not a review.

Two refusals, both from ch. 31's sentence that an override with no retrospective review "is a permanent exception that nobody ever reads again":

  • A live override cannot be reviewed. The model already refuses a review_due_at earlier than the expiry, "so it would review an exception still running"; completing the review early reaches the same place by a different door. Expire it, or wait for the expiry.
  • A completed review is not re-completed. Overwriting the reviewer, the instant and the note destroys the record of the review that was actually performed.

POST /api/v1/facility/{facility_external_id}/rcm/overrides/{external_id}/complete_review/ — action complete_review. 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 review_queue_key not declared at read site not established
query review_outstanding not declared at read site not established
query live not declared at read site not established

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

Declared refusal/error evidence: publication.OverrideDisciplineError (dynamic detail; inspect source); PermissionDenied: Cannot edit RCM configuration; ValidationError: Request body must be an object; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

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.