MANSOQ Frontend module · STATIC DECLARATIONS
Benefit Table Api client API reference · mansoq-web
17 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 17 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.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.templates | GET | /api/v1/facility/{facilityId}/rcm/benefit_templates/ |
literal |
| default.rules | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/ |
literal |
| default.rule | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/ |
literal |
| default.grid | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/grid/ |
literal |
| default.gridRow | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/grid/ |
literal |
| default.validateContradictions | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/validate-contradictions/ |
literal |
| default.previewEstimate | POST | /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/preview-estimate/ |
literal |
| default.ruleReadiness | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/readiness/ |
literal |
| default.ruleGates | GET | /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/gates/ |
literal |
| default.ruleAuthorizationRequirements | GET | /api/v1/facility/{facilityId}/rcm/authorization_requirements/ |
literal |
| default.exclusions | GET | /api/v1/facility/{facilityId}/rcm/exclusions/ |
literal |
| default.exclusion | GET | /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/ |
literal |
| default.exclusionReadiness | GET | /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/readiness/ |
literal |
| default.addException | POST | /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/add-exception/ |
literal |
| default.exclusionExceptions | GET | /api/v1/facility/{facilityId}/rcm/exclusion_exceptions/ |
literal |
| default.limits | GET | /api/v1/facility/{facilityId}/rcm/limits/ |
literal |
| default.costShareComponents | GET | /api/v1/facility/{facilityId}/rcm/cost_share_components/ |
literal |
default.templates
GET /api/v1/facility/{facilityId}/rcm/benefit_templates/. 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<BenefitTemplate>. client-side declaration; not proof of accepted server payload.
PaginatedRcm declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | T[] | true | — |
BenefitTemplate declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| name | string | true | — |
| program | RcmRef | null | true | — |
| precedence_direction | object | true | — |
| decision_type_order | string[] | 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.
default.rules
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/. 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<BenefitRule>. client-side declaration; not proof of accepted server payload.
BenefitRule declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| benefit_code | string | true | — |
| label | string | true | — |
| domain | RcmRef | null | true | — |
| precedence | number | true | — |
| scope | BenefitRuleScope | true | — |
| decision | object | true | — |
| requires_clinical_review | TriStateValue | true | — |
| settlement_mode | string | true | — |
| manual_review_condition | unknown | true | — |
| source_clause | string | true | — |
| source_language | string | true | — |
| original_wording | string | true | — |
| unresolved_interpretation | string | 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.
default.rule
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, ruleId. Transport strings are declared here; semantic identifier types require the server contract.
response type: BenefitRule. 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.grid
The authoring grid: eight separate columns, paginated.
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/grid/. 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<BenefitGridRow>. client-side declaration; not proof of accepted server payload.
One authoring-grid row: eight independent columns, never one badge.
BenefitGridRow declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| benefit_rule | RcmRef | true | — |
| benefit_code | string | true | — |
| precedence | number | true | — |
| columns | string[] | true | — |
| coverage | object | true | — |
| limit | Array<object> | true | — |
| patient_share | Array<object> | true | — |
| referral | TriStateValue | true | — |
| authorization | TriStateValue | true | — |
| network | object | true | — |
| exceptions | Array<object> | true | — |
| evidence | EvidenceBlock | true | — |
| unresolved | string[] | true | — |
| qualified | boolean | true | Deliberately not called "covered". |
| 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.gridRow
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/grid/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, ruleId. Transport strings are declared here; semantic identifier types require the server contract.
response type: BenefitGridRow. 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.validateContradictions
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/validate-contradictions/. 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: ContradictionReport. client-side declaration; not proof of accepted server payload.
ContradictionReport declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| rules_checked | number | true | — |
| findings | ContradictionFinding[] | true | — |
| clean | boolean | true | — |
| posted_nothing | boolean | true | — |
| 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.previewEstimate
POST /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/preview-estimate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, ruleId. Transport strings are declared here; semantic identifier types require the server contract.
request type: PreviewEstimateBody. client-side declaration; not proof of accepted server payload.
PreviewEstimateBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| eligible_pretax | string | true | Required: the preview prices a charge the caller supplies. |
| currency | string | true | Required: an amount without a currency is not an amount. |
| service_date | string | true | Required: a pricing date is never defaulted to today. |
| referral_id | string | false | — |
| visit_id | string | false | — |
| episode_id | string | false | — |
| admission_id | string | false | — |
| claim_id | string | false | — |
| policy_period_id | string | false | — |
response type: MemberEstimatePreview. client-side declaration; not proof of accepted server payload.
MemberEstimatePreview declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| grid | BenefitGridRow | true | — |
| outcome | string | true | — |
| estimate_certainty | string | false | — |
| requires_financial_clearance | boolean | false | — |
| currency | string | false | — |
| eligible_pretax_total | string | false | — |
| patient_share_total | string | null | false | null on an unresolved run, and never "0.00". |
| insurer_share_total | string | null | false | — |
| unresolved | Array<object> | false | — |
| reason | string | false | — |
| reservations_posted | number | false | — |
| posted_nothing | boolean | true | — |
| note | 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.ruleReadiness
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, ruleId. 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.ruleGates
Which decision gates this rule names, and what each one blocks (ch. 32).
GET /api/v1/facility/{facilityId}/rcm/benefit_rules/{ruleId}/gates/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, ruleId. Transport strings are declared here; semantic identifier types require the server contract.
response type: GateBlock. client-side declaration; not proof of accepted server payload.
GateBlock declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| named | string[] | true | — |
| blocking | string[] | true | — |
| blocks_activation | boolean | true | — |
| blocks_development | boolean | true | — |
| detail | GateDetail[] | 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.ruleAuthorizationRequirements
GET /api/v1/facility/{facilityId}/rcm/authorization_requirements/. 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<AuthorizationRequirement>. client-side declaration; not proof of accepted server payload.
AuthorizationRequirement declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| benefit_rule | RcmRef | true | — |
| authorization_required | TriStateValue | true | — |
| referral_required | TriStateValue | true | — |
| amount_threshold | StatedValue | true | — |
| quantity_threshold | StatedValue | true | — |
| threshold_comparison | string | true | — |
| threshold_aggregation_scope | StatedText | true | — |
| urgency_exemption | unknown | true | — |
| required_evidence | unknown | true | — |
| allowed_exceptions | unknown | true | — |
| emergency_exception | TriStateValue | true | — |
| emergency_notification_rule | unknown | true | — |
| routes_to_review | boolean | true | — |
| evidence | EvidenceBlock | true | — |
| effective_from | string | null | true | — |
| effective_to | string | null | 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.exclusions
GET /api/v1/facility/{facilityId}/rcm/exclusions/. 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<ExclusionRule>. client-side declaration; not proof of accepted server payload.
ExclusionRule declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| exclusion_code | string | true | — |
| program | RcmRef | null | true | — |
| benefit_class | RcmRef | null | true | — |
| precedence | StatedValue | true | — |
| care_setting | StatedText | true | — |
| network_tier | string | null | true | — |
| text_ar | string | true | — |
| text_en | string | true | — |
| authoritative_language | string | true | Which language governs. The other one is a translation, not a second rule. |
| translation_discrepancy | string | true | Kept as data, never reconciled away (ch. 1). |
| patient_criteria | unknown | true | — |
| outcome | string | true | — |
| named_exceptions_state | object | true | — |
| source_clause | string | true | — |
| exceptions | ExclusionException[] | 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.exclusion
GET /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, exclusionId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ExclusionRule. 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.exclusionReadiness
GET /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, exclusionId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ReadinessBlock. 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.addException
The only way this screen creates an exception. The clause is part of the URL, so an exception cannot be attached to an unrelated clause.
POST /api/v1/facility/{facilityId}/rcm/exclusions/{exclusionId}/add-exception/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, exclusionId. Transport strings are declared here; semantic identifier types require the server contract.
request type: AddExceptionBody. client-side declaration; not proof of accepted server payload.
AddExceptionBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | true | — |
| outcome | string | true | Required. What an exception yields is never defaulted to "covered". |
| text_ar | string | false | — |
| text_en | string | false | — |
| criteria | Record<string, unknown> | false | — |
| source_clause | string | false | — |
| authority_org | string | false | — |
| effective_from | string | false | — |
| effective_to | string | false | — |
response type: ExclusionException. client-side declaration; not proof of accepted server payload.
ExclusionException declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| exclusion | RcmRef | true | — |
| label | string | true | — |
| text_ar | string | true | — |
| text_en | string | true | — |
| criteria | unknown | true | — |
| outcome | string | true | — |
| authority_org | RcmRef | null | true | — |
| source_clause | string | true | — |
| effective_from | string | null | true | — |
| effective_to | string | null | true | — |
| effective_to_is_inclusive | boolean | 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.exclusionExceptions
GET /api/v1/facility/{facilityId}/rcm/exclusion_exceptions/. 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<ExclusionException>. 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.limits
GET /api/v1/facility/{facilityId}/rcm/limits/. 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<LimitDefinition>. client-side declaration; not proof of accepted server payload.
LimitDefinition declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| label | string | true | — |
| measure | string | true | — |
| cap_value | StatedValue | true | — |
| is_unlimited | object | true | — |
| unit | StatedText | true | — |
| currency | string | true | — |
| subject | string | true | — |
| parent_limit | RcmRef | null | true | — |
| pooled_with | string[] | true | — |
| period_code | string | true | — |
| reset_event | string | true | — |
| rolling_window_days | StatedValue | true | — |
| prorates_on_midterm_join | TriStateValue | true | — |
| transfer_on_renewal | TriStateValue | true | — |
| transfer_on_upgrade | TriStateValue | true | — |
| basis | StatedText | true | — |
| tax_consumes_limit | TriStateValue | true | — |
| aggregation_mode | StatedText | true | — |
| family_cap_value | StatedValue | 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.
default.costShareComponents
GET /api/v1/facility/{facilityId}/rcm/cost_share_components/. 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<CostShareComponent>. client-side declaration; not proof of accepted server payload.
CostShareComponent declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| label | string | true | — |
| kind | string | true | — |
| value_amount | StatedValue | true | — |
| value_percent | StatedValue | true | — |
| currency | string | true | — |
| scope | string | true | — |
| basis | StatedText | true | — |
| apply_order | number | true | — |
| interaction | string | true | — |
| supersedes_component | RcmRef | null | true | — |
| rounding_method | string | true | — |
| consumes_limit | RcmRef | null | true | — |
| referral_dependency | TriStateValue | true | — |
| deductible_balance_source | string | 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/benefitTableApi.ts:306
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:311
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:316
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:322
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:327
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:332
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:337
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:343
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:349
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:354
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:359
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:364
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:369
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:378
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:384
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:389
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:394
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:188
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:27
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:48
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:165
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:222
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:265
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:230
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:167
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:124
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:109
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:144
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:252
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:129
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:68
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/benefitTableApi.ts:91