← Technical API reference

Backend resource · STATIC DECLARATIONS

Issued Policy API reference · mansoq-core

Static source contract for Issued Policy: 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/policies/. 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-04.

Core actions: draft, verify schedule, import members, renew, endorse, cancel. Evidence before activation: the source schedule, its version and the policy-specific classes. The edge case it must allow: provisional coverage capture while the configuration is still under review.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/rcm/policies/ list declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/policies/ create declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/ retrieve declared/inherited method
PATCH /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/ partial_update declared/inherited method
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/bind-package/ bind_package @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/readiness/ readiness @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/transition/ transition @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/activate/ activate @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/suspend/ suspend @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/supersede/ supersede @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/new-version/ new_version @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/evidence/ evidence @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/gates/ gates @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/verify-schedule/ verify_schedule @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/import-members/ import_members @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/renew/ renew @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/endorse/ endorse @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/cancel/ cancel @action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/policies/ — 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 as_of 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/policies/ — 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 as_of 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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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 as_of 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/policies/{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/policies/{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.

verify_schedule · POST

POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/verify-schedule/ — action verify_schedule. 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 advance 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
body change_reason not declared at read site not established
query as_of 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: 409. Other branches/framework exception handling may differ.

Declared refusal/error evidence: PermissionDenied: Cannot edit RCM configuration; PermissionDenied: Cannot read RCM configuration; ValidationError (dynamic detail; inspect source).

import_members · POST

Validate a member batch's class references before anything is written.

Ch. 31: "Bulk Excel import needs a staging area ... A partially failed import must not be able to activate an incomplete tariff or contract relationship". The same rule applies here, which is why this is a dry run and why every row that names an unknown class is reported with its row number rather than being coerced onto the nearest class. The member rows themselves belong to the enrolment screen (SET-09); this endpoint answers only the question SET-04 owns — do the classes these rows name exist.

POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/import-members/ — action import_members. 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 members 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.

renew · POST

POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/renew/ — action renew. 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
body effective_from not declared at read site not established
body received_date not declared at read site not established
body accumulator_transition not declared at read site not established
body effective_to not declared at read site not established
body reprocessing_scope not declared at read site not established
body change_reason not declared at read site not established
body document_reference not declared at read site not established
body content_sha256 not declared at read site not established
body accumulator_transition_state not declared at read site not established

Observed authorization checks: can_read_rcm_configuration_in_facility, can_edit_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 (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration; PermissionDenied: Cannot edit RCM configuration.

endorse · POST

POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/endorse/ — action endorse. 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
body effective_from not declared at read site not established
body received_date not declared at read site not established
body accumulator_transition not declared at read site not established
body effective_to not declared at read site not established
body reprocessing_scope not declared at read site not established
body change_reason not declared at read site not established
body document_reference not declared at read site not established
body content_sha256 not declared at read site not established
body accumulator_transition_state not declared at read site not established

Observed authorization checks: can_read_rcm_configuration_in_facility, can_edit_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 (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration; PermissionDenied: Cannot edit RCM configuration.

cancel · POST

POST /api/v1/facility/{facility_external_id}/rcm/policies/{external_id}/cancel/ — action cancel. 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
body effective_from not declared at read site not established
body received_date not declared at read site not established
body accumulator_transition not declared at read site not established
body effective_to not declared at read site not established
body reprocessing_scope not declared at read site not established
body change_reason not declared at read site not established
body document_reference not declared at read site not established
body content_sha256 not declared at read site not established
body accumulator_transition_state not declared at read site not established
query as_of not declared at read site not established

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