← Technical API reference

Backend resource · STATIC DECLARATIONS

Rcm Import API reference · mansoq-core

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

/api/v1/facility/{facility_external_id}/rcm/imports/.

Reading needs can_read_rcm_configuration; staging, the dry run, publication and rollback need can_import_rcm_configuration.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/rcm/imports/ list declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/ retrieve declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/imports/registers/ registers @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/imports/registers/{register_key}/template/ template @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/imports/stage/ stage @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/issues\.csv/ issues @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/dry-run/ dry_run @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/publish/ publish @action declaration
POST /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/rollback/ rollback @action declaration

list · GET

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

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.

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/imports/{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

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: NotFound (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

registers · GET

GET /api/v1/facility/{facility_external_id}/rcm/imports/registers/ — action registers. 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

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.

template · GET

GET /api/v1/facility/{facility_external_id}/rcm/imports/registers/{register_key}/template/ — action template. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path register_key string/default converter true
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

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; NotFound (dynamic detail; inspect source).

stage · POST

POST /api/v1/facility/{facility_external_id}/rcm/imports/stage/ — action stage. 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
file file not declared at read site not established
body register_key not declared at read site not established
query {computed field name} not declared at read site not established

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

Declared refusal/error evidence: UploadRefusedError: file_missing; UploadRefusedError: file_name_missing; PermissionDenied: Cannot import RCM configuration; NotFound (dynamic detail; inspect source); PermissionDenied (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

issues · GET

GET /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/issues.csv/ — action issues. 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

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: NotFound (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration.

dry_run · POST

POST /api/v1/facility/{facility_external_id}/rcm/imports/{external_id}/dry-run/ — action dry_run. 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

Observed authorization checks: can_import_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 import RCM configuration; ImportStagingError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration; PermissionDenied (dynamic detail; inspect source).

publish · POST

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

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

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

rollback · POST

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

Observed authorization checks: can_import_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 import RCM configuration; ImportStagingError (dynamic detail; inspect source); PermissionDenied: Cannot read RCM configuration; PermissionDenied (dynamic detail; inspect source).

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.