← Technical API reference

Backend resource · STATIC DECLARATIONS

Benefit Class API reference · mansoq-core

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

SET-05.

Core actions: compare side by side, show inherited value, override, simulate. Evidence before activation: resolved benefits with source, period and explicit precedence. The failure it prevents: a blank inherited cell read as zero or unlimited.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/rcm/classes/ list declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/classes/ create declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/ retrieve declared/inherited method
PATCH /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/ partial_update declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/bind-package/ bind_package @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/readiness/ readiness @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/transition/ transition @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/activate/ activate @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/suspend/ suspend @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/supersede/ supersede @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/new-version/ new_version @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/evidence/ evidence @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/gates/ gates @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/compare/ compare @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/compare/ compare @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/resolved-value/ resolved_value @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/override/ override @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/simulate/ simulate @action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/ — 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 {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin 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

POST /api/v1/facility/{facility_external_id}/rcm/classes/ — 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 {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin 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; PermissionDenied: Cannot read RCM configuration.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{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 {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin 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.

partial_update · PATCH

PATCH /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/ — action partial_update. 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 {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin 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: PermissionDenied: Cannot edit RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

bind_package · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/bind-package/ — action bind_package. 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 package not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin not declared at read site not established

Observed authorization checks: can_publish_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: 409. Other branches/framework exception handling may differ.

Declared refusal/error evidence: StaleConfigurationError (dynamic detail; inspect source); ValidationError: Choose a validated package from this facility; PermissionDenied: Cannot approve, activate or publish RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

readiness · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/readiness/ — action readiness. 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 target_status not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on 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.

transition · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/transition/ — action transition. 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 to_status not declared at read site not established
body change_reason not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin not declared at read site not established

Observed authorization checks: can_publish_rcm_configuration_in_facility, 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: PermissionDenied: Cannot approve, activate or publish RCM configuration; PermissionDenied: Cannot edit RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

activate · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/activate/ — action activate. 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 target_status not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin not declared at read site not established

Observed authorization checks: can_publish_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: 409. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: Cannot approve, activate or publish RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

suspend · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/suspend/ — action suspend. 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 change_reason not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin not declared at read site not established

Observed authorization checks: can_publish_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: PermissionDenied: Cannot approve, activate or publish RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

supersede · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/supersede/ — action supersede. 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 change_reason not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin not declared at read site not established

Observed authorization checks: can_publish_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: PermissionDenied: Cannot approve, activate or publish RCM configuration; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

new_version · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/new-version/ — action new_version. 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 change_reason not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on not declared at read site not established
query origin 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; PermissionDenied: Cannot read RCM configuration.

evidence · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/evidence/ — action evidence. 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 {computed field name} not declared at read site not established
query effective_on 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.

gates · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/gates/ — action gates. 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 target_status not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on 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.

compare · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/compare/ — action compare. 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 {computed field name} not declared at read site not established
query effective_on 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.

compare · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/compare/ — action compare. 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 {computed field name} not declared at read site not established
query effective_on 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.

resolved_value · GET

GET /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/resolved-value/ — action resolved_value. 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 field_path not declared at read site not established
query on_date not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on 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: ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

override · POST

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/override/ — action override. 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 inherits not declared at read site not established
body authority_org not declared at read site direct indexing; validation may be upstream
body override_value not declared at read site not established
body benefit_rule not declared at read site not established
body field_path not declared at read site not established
body override_state not declared at read site not established
body effective_from not declared at read site not established
body effective_to not declared at read site not established
body mandatory_floor_respected not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on 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: ValidationError: Published or in-review benefit configuration is immutable; create new draft class and rule versions before overriding; ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot edit RCM configuration; PermissionDenied: Cannot read RCM configuration.

simulate · POST

The honest answer to "what does this copay change do".

Delegates to :func:~mansoq.emr.rcm.services.publication.simulate, which runs the whole comparison inside a transaction it then rolls back — so "posts nothing" is a property of the mechanism, not a promise in a docstring. The representative-settings rule is the service's too: a case set missing outpatient, pharmacy or inpatient is a simulation of part of the change and is refused as such.

POST /api/v1/facility/{facility_external_id}/rcm/classes/{external_id}/simulate/ — action simulate. 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 cases not declared at read site not established
body proposed not declared at read site not established
body currency not declared at read site not established
query {computed field name} not declared at read site not established
query effective_on 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: 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.