MANSOQ Frontend module · STATIC DECLARATIONS
Network Api client API reference · mansoq-web
9 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.
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.
Client contract scope
These 9 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.
Operation map
| Client method | HTTP method | Path pattern | Resolution |
|---|---|---|---|
| default.networks | GET | /api/v1/facility/{facilityId}/rcm/networks/ |
literal |
| default.network | GET | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/ |
literal |
| default.coverageMap | GET | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/coverage-map/ |
literal |
| default.removalImpact | POST | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/removal-impact/ |
literal |
| default.replacement | POST | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/replacement/ |
literal |
| default.approve | POST | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/approve/ |
literal |
| default.networkReadiness | GET | /api/v1/facility/{facilityId}/rcm/networks/{networkId}/readiness/ |
literal |
| default.memberships | GET | /api/v1/facility/{facilityId}/rcm/network_memberships/ |
literal |
| default.reconciliations | GET | /api/v1/facility/{facilityId}/rcm/network_reconciliations/ |
literal |
default.networks
GET /api/v1/facility/{facilityId}/rcm/networks/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.
response type: PaginatedRcm<PayerNetwork>. client-side declaration; not proof of accepted server payload.
PaginatedRcm declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | T[] | true | — |
PayerNetwork declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| label | string | true | — |
| insurer_org | RcmRef | null | true | — |
| administrator_org | RcmRef | null | true | — |
| tier | StatedText | true | — |
| territory | object | true | — |
| member_list_completeness | TriStateValue | false | Only present when the request named a date. Tri-state, never a bare bool. |
| as_of | string | false | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.network
GET /api/v1/facility/{facilityId}/rcm/networks/{networkId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
response type: PayerNetwork. client-side declaration; not proof of accepted server payload.
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.coverageMap
GET /api/v1/facility/{facilityId}/rcm/networks/{networkId}/coverage-map/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
response type: CoverageMap. client-side declaration; not proof of accepted server payload.
CoverageMap declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| network | PayerNetwork | true | — |
| as_of | string | true | — |
| specialty | string | null | true | — |
| member_site_count | number | true | — |
| organizations | Array<object> | true | — |
| sibling_inheritance | boolean | true | Always false: a sibling branch never lends its participation. |
| note | string | true | — |
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.removalImpact
POST /api/v1/facility/{facilityId}/rcm/networks/{networkId}/removal-impact/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
request type: RemovalImpactBody. client-side declaration; not proof of accepted server payload.
RemovalImpactBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| membership | string | true | — |
| on_date | string | false | — |
| care_in_progress | string | false | Tri-state on the wire: "yes" | "no" | "unknown". |
response type: RemovalImpact. client-side declaration; not proof of accepted server payload.
RemovalImpact declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| network | RcmRef | true | — |
| membership | NetworkSiteMembership | true | — |
| as_of | string | true | — |
| continuity | ContinuityOutcome | true | — |
| affected_classes | Array<object> | true | — |
| posted_nothing | boolean | true | — |
| open_authorizations | Array<Record<string, unknown>> | false | Not supplied by the current endpoint. Open authorizations, unbilled encounters and submitted claims are reported by this screen as not supplied rather than as zero — see NetworkSettings. |
| unbilled_encounters | Array<Record<string, unknown>> | false | — |
| submitted_claims | Array<Record<string, unknown>> | false | — |
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.replacement
POST /api/v1/facility/{facilityId}/rcm/networks/{networkId}/replacement/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
request type: ReplacementBody. client-side declaration; not proof of accepted server payload.
ReplacementBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| membership | string | true | — |
| replacement_site_id | string | true | — |
| on_date | string | false | — |
| notice_given_at | string | false | — |
response type: NetworkSiteMembership. client-side declaration; not proof of accepted server payload.
NetworkSiteMembership declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| network | RcmRef | true | — |
| provider_org | RcmRef | true | — |
| provider_site_id | string | true | Membership belongs to a site, never to a hospital brand. |
| membership_is_per_site | boolean | true | — |
| specialty_scope | object | true | — |
| care_setting_scope | object | true | — |
| service_scope | object | true | — |
| exclusions | unknown | true | — |
| tier | StatedText | true | — |
| grandfathering_rule | unknown | true | — |
| replacement_site_id | string | null | true | — |
| notice_given_at | string | null | true | — |
| provider_level | StatedText | true | — |
| accreditation | object | true | — |
| service_capability | unknown | true | — |
| telemedicine_capability | TriStateValue | true | — |
| specialist_centre_capability | TriStateValue | true | — |
| national_address | string | true | — |
| urban_rural_class | string | true | — |
| access | MembershipAccess | true | — |
| effective_from | string | null | true | — |
| effective_to | string | null | true | — |
| effective_to_is_inclusive | boolean | true | — |
| entitlement_lost_on | string | false | Also a tri-state, not a flag: entitlement_lost_on() returns "no" for a membership in force and "unknown" otherwise, and never "yes". Render it through triFromString, never as a truthiness test. |
| encounter_network_tier | [string | null, string] | false | — |
| as_of | string | false | — |
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.approve
POST /api/v1/facility/{facilityId}/rcm/networks/{networkId}/approve/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
request type: ApproveBody. client-side declaration; not proof of accepted server payload.
ApproveBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| lock_token | string | true | — |
| change_reason | string | false | — |
| actor_role | string | false | — |
response type: PayerNetwork. client-side declaration; not proof of accepted server payload.
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.networkReadiness
GET /api/v1/facility/{facilityId}/rcm/networks/{networkId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, networkId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ReadinessBlock. client-side declaration; not proof of accepted server payload.
ReadinessBlock declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| subject | string | true | — |
| target_status | string | true | — |
| is_ready | boolean | true | — |
| checked_overlap | boolean | true | — |
| open_gates | string[] | true | — |
| refusals | Refusal[] | true | — |
| screen_refusals | Refusal[] | true | — |
| gates | GateBlock | true | — |
| evidence | EvidenceBlock | true | — |
| lock_token | string | true | — |
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.memberships
GET /api/v1/facility/{facilityId}/rcm/network_memberships/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.
response type: PaginatedRcm<NetworkSiteMembership>. client-side declaration; not proof of accepted server payload.
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
default.reconciliations
GET /api/v1/facility/{facilityId}/rcm/network_reconciliations/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.
response type: PaginatedRcm<NetworkReconciliation>. client-side declaration; not proof of accepted server payload.
NetworkReconciliation declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| network | RcmRef | true | — |
| list_is_complete | TriStateValue | true | Tri-state: an unreconciled list is not an established negative. |
| issued_list_reference | StatedText | true | — |
| issued_member_site_count | StatedValue | true | — |
| reconciled_on | StatedText | true | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.
Pinned source evidence
Links require access to the private source repository.
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:192
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:197
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:202
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:207
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:213
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:219
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:225
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:230
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:235
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:188
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:23
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:106
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:165
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:142
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:172
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:46
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:179
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:167
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/networkApi.ts:88