MANSOQ Backend resource · STATIC DECLARATIONS
Organization Role API reference · mansoq-core
Static source contract for Organization Role: 14 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/organization_roles/. 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-01's role table: which role, under which licence, for which dates.
Operation map
| Method | Path | Action | Evidence |
|---|---|---|---|
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/ |
list | declared/inherited method |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/ |
create | declared/inherited method |
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/ |
retrieve | declared/inherited method |
| PATCH | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/ |
partial_update | declared/inherited method |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/bind-package/ |
bind_package | @action declaration |
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/readiness/ |
readiness | @action declaration |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/transition/ |
transition | @action declaration |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/activate/ |
activate | @action declaration |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/suspend/ |
suspend | @action declaration |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/supersede/ |
supersede | @action declaration |
| POST | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/new-version/ |
new_version | @action declaration |
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/evidence/ |
evidence | @action declaration |
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/gates/ |
gates | @action declaration |
| GET | /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/licence/ |
licence | @action declaration |
list · GET
GET /api/v1/facility/{facility_external_id}/rcm/organization_roles/ — 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/organization_roles/ — 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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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/organization_roles/{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.
licence · GET
GET /api/v1/facility/{facility_external_id}/rcm/organization_roles/{external_id}/licence/ — action licence. 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 | 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: 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.
- repositories/platform/mansoq-core/config/api_router.py:653
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:1217
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:414
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:369
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:409
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:339
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:388
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:365
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:397
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:334
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:588
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:347
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:422
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:601
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:533
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:451
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:440
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:551
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:530
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:626
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:355
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:677
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:1229
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:563
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:554
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:706
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:734
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:766
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:792
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:809
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:824
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:838
- repositories/platform/mansoq-core/mansoq/emr/api/viewsets/rcm/organization.py:1259