MANSOQ Frontend module · STATIC DECLARATIONS
Coverage Api client API reference · mansoq-web
33 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 33 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.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.listOrganizations | GET | /api/v1/facility/{facilityId}/rcm/organizations/ |
literal |
| default.listPrograms | GET | /api/v1/facility/{facilityId}/rcm/programs/ |
literal |
| default.listProducts | GET | /api/v1/facility/{facilityId}/rcm/products/ |
literal |
| default.listPolicies | GET | /api/v1/facility/{facilityId}/rcm/policies/ |
literal |
| default.retrievePolicy | GET | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/ |
literal |
| default.createPolicy | POST | /api/v1/facility/{facilityId}/rcm/policies/ |
literal |
| default.updatePolicy | PATCH | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/ |
literal |
| default.policyReadiness | GET | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/readiness/ |
literal |
| default.verifyPolicySchedule | POST | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/verify-schedule/ |
literal |
| default.importPolicyMembers | POST | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/import-members/ |
literal |
| default.renewPolicy | POST | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/renew/ |
literal |
| default.endorsePolicy | POST | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/endorse/ |
literal |
| default.cancelPolicy | POST | /api/v1/facility/{facilityId}/rcm/policies/{policyId}/cancel/ |
literal |
| default.listPolicyVersions | GET | /api/v1/facility/{facilityId}/rcm/policy_versions/ |
literal |
| default.createPolicyVersion | POST | /api/v1/facility/{facilityId}/rcm/policy_versions/ |
literal |
| default.listClasses | GET | /api/v1/facility/{facilityId}/rcm/classes/ |
literal |
| default.retrieveClass | GET | /api/v1/facility/{facilityId}/rcm/classes/{classId}/ |
literal |
| default.classReadiness | GET | /api/v1/facility/{facilityId}/rcm/classes/{classId}/readiness/ |
literal |
| default.compareClass | GET | /api/v1/facility/{facilityId}/rcm/classes/{classId}/compare/ |
literal |
| default.resolveClassValue | GET | /api/v1/facility/{facilityId}/rcm/classes/{classId}/resolved-value/ |
literal |
| default.overrideClassValue | POST | /api/v1/facility/{facilityId}/rcm/classes/{classId}/override/ |
literal |
| default.simulateClass | POST | /api/v1/facility/{facilityId}/rcm/classes/{classId}/simulate/ |
literal |
| default.listBenefitOverrides | GET | /api/v1/facility/{facilityId}/rcm/benefit_overrides/ |
literal |
| default.listClassNetworkAssignments | GET | /api/v1/facility/{facilityId}/rcm/class_network_assignments/ |
literal |
| default.listCoverages | GET | /api/v1/facility/{facilityId}/rcm/enrollment/ |
literal |
| default.retrieveCoverage | GET | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/ |
literal |
| default.discoveryLadder | GET | /api/v1/facility/{facilityId}/rcm/enrollment/discovery-ladder/ |
literal |
| default.discoverCoverage | POST | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/discover/ |
literal |
| default.verifyCoverage | POST | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/verify/ |
literal |
| default.coverageEligibility | GET | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/eligibility/ |
literal |
| default.resolveCoverageConflict | POST | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/resolve-conflict/ |
literal |
| default.endorseCoverage | POST | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/endorse/ |
literal |
| default.coverageEstimateRestriction | GET | /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/estimate-restriction/ |
literal |
default.listOrganizations
GET /api/v1/facility/{facilityId}/rcm/organizations/. 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: PaginatedResponse<OrganizationOption>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
Minimal read shape of a SET-01 organization, for pickers on these screens.
OrganizationOption declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| internal_code | string | true | — |
| legal_name | string | true | — |
| legal_name_en | string | true | — |
| legal_name_ar | string | true | — |
| payer_class | string | true | — |
| lifecycle | LifecycleBlock | 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.listPrograms
GET /api/v1/facility/{facilityId}/rcm/programs/. 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: PaginatedResponse<InsuranceProgram>. client-side declaration; not proof of accepted server payload.
InsuranceProgram declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| code | string | true | — |
| name_ar | Stated | true | — |
| name_en | string | true | — |
| eligible_population | Record<string, unknown> | true | — |
| eligibility_obligation_trigger | Stated | true | — |
| coverage_start_trigger | Stated | true | — |
| baseline_schedule_ref | string | true | — |
| entitlement_cap | object | true | — |
| instrument | object | true | — |
| lifecycle | LifecycleBlock | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | 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.listProducts
GET /api/v1/facility/{facilityId}/rcm/products/. 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: PaginatedResponse<InsuranceProduct>. client-side declaration; not proof of accepted server payload.
InsuranceProduct declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| insurer_org | RowRef | null | true | — |
| program | RowRef | null | true | — |
| product_code | string | true | — |
| product_name | string | true | — |
| jurisdiction | string | true | — |
| marketing_tier | object | true | Display only. engine_readable is always false — a brand never decides cover. |
| regulator_product_code | string | true | — |
| coverage_template | RowRef | null | true | — |
| lifecycle | LifecycleBlock | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | 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.listPolicies
GET /api/v1/facility/{facilityId}/rcm/policies/. 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: PaginatedResponse<IssuedPolicy>. client-side declaration; not proof of accepted server payload.
IssuedPolicy declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| insurer_org | RowRef | null | true | — |
| policyholder | object | true | — |
| program | RowRef | null | true | — |
| product | object | true | The product FK is legitimately nullable. A hospital routinely holds a policy number and a member card without the insurer's catalogue, and mapping_is_pending is what keeps that visible as pending rather than as "no product". |
| external_policy_number | string | true | Text, and it stays text: leading zeros are significant. |
| external_policy_system | string | true | — |
| issuance_evidence | Record<string, unknown> | true | — |
| currency | string | true | — |
| verification_source | string | true | — |
| emergency | object | true | — |
| lifecycle | LifecycleBlock | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | true | — |
| versions | PolicyVersion[] | false | — |
| classes | BenefitClass[] | 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.retrievePolicy
GET /api/v1/facility/{facilityId}/rcm/policies/{policyId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
response type: IssuedPolicy. 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.createPolicy
POST /api/v1/facility/{facilityId}/rcm/policies/. 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.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: IssuedPolicy. 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.updatePolicy
PATCH /api/v1/facility/{facilityId}/rcm/policies/{policyId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: IssuedPolicy. 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.policyReadiness
GET /api/v1/facility/{facilityId}/rcm/policies/{policyId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. 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 | ConfigStatusName | 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.verifyPolicySchedule
POST /api/v1/facility/{facilityId}/rcm/policies/{policyId}/verify-schedule/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: object. client-side declaration; not proof of accepted server payload.
default.verifyPolicySchedule.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| advance | boolean | false | — |
| lock_token | string | false | — |
| change_reason | string | false | — |
response type: ScheduleVerdict. client-side declaration; not proof of accepted server payload.
ScheduleVerdict declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| verified | boolean | true | — |
| refusals | Refusal[] | true | — |
| advisories | Refusal[] | true | — |
| provisional_capture_permitted | boolean | true | — |
| note | string | true | — |
| policy | IssuedPolicy | false | — |
| errors | Array<object> | 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.importPolicyMembers
POST /api/v1/facility/{facilityId}/rcm/policies/{policyId}/import-members/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: object. client-side declaration; not proof of accepted server payload.
default.importPolicyMembers.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| members | Array<Record<string, unknown>> | true | — |
response type: MemberImportReport. client-side declaration; not proof of accepted server payload.
MemberImportReport declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| policy | RowRef | true | — |
| rows_read | number | true | — |
| rows_resolvable | number | true | — |
| row_errors | Array<object> | true | — |
| publishable | boolean | true | — |
| posted_nothing | boolean | true | — |
| member_rows_owned_by | 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.renewPolicy
POST /api/v1/facility/{facilityId}/rcm/policies/{policyId}/renew/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: PolicyVersion. client-side declaration; not proof of accepted server payload.
PolicyVersion declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| policy | RowRef | true | — |
| version | number | true | — |
| change_kind | PolicyChangeKind | true | — |
| change_reason | string | true | — |
| effective_from | string | null | true | When the change takes effect. Never merged with received_date. |
| effective_to | string | null | true | — |
| effective_to_is_inclusive | boolean | true | — |
| received_date | string | null | true | When the provider received it. Receipt is not commencement (ch. 1, ch. 8). |
| document_reference | string | true | — |
| content_sha256 | string | true | — |
| predecessor | string | null | true | — |
| superseded_at | string | null | true | — |
| reprocessing_scope | Record<string, unknown> | true | — |
| accumulator_transition | Stated | 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.endorsePolicy
POST /api/v1/facility/{facilityId}/rcm/policies/{policyId}/endorse/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: PolicyVersion. 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.cancelPolicy
POST /api/v1/facility/{facilityId}/rcm/policies/{policyId}/cancel/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, policyId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: object. client-side declaration; not proof of accepted server payload.
default.cancelPolicy.response declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| version | PolicyVersion | true | — |
| policy | IssuedPolicy | 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.listPolicyVersions
GET /api/v1/facility/{facilityId}/rcm/policy_versions/. 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: PaginatedResponse<PolicyVersion>. 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.createPolicyVersion
Issue, reinstatement and retroactive correction have no dedicated policy
action; they are recorded here with an explicit change_kind. Renewal,
endorsement and cancellation go through their own endpoints because they
carry side effects the child route does not.
POST /api/v1/facility/{facilityId}/rcm/policy_versions/. 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.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: PolicyVersion. 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.listClasses
GET /api/v1/facility/{facilityId}/rcm/classes/. 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: PaginatedResponse<BenefitClass>. client-side declaration; not proof of accepted server payload.
BenefitClass declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| insurer_class_code | string | true | The payer's opaque code. Everything resolves by this, never by label. |
| display_label | object | true | — |
| product | RowRef | null | true | — |
| policy | RowRef | null | true | — |
| tier_mapping | Stated | true | — |
| tier_mapping_evidence | SourceDocumentRef | null | true | — |
| source_schedule_ref | string | true | — |
| currency | string | true | — |
| accommodation | object | true | — |
| network | RowRef | null | true | — |
| benefit_template | RowRef | null | true | — |
| direct_billing_permitted | TriState | true | — |
| emergency | object | true | — |
| lifecycle | LifecycleBlock | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | true | — |
| inheritance | object | false | — |
| network_assignments | ClassNetworkAssignment[] | false | — |
| overrides | BenefitOverride[] | 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.retrieveClass
GET /api/v1/facility/{facilityId}/rcm/classes/{classId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. Transport strings are declared here; semantic identifier types require the server contract.
response type: BenefitClass. 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.classReadiness
GET /api/v1/facility/{facilityId}/rcm/classes/{classId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. 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.compareClass
GET /api/v1/facility/{facilityId}/rcm/classes/{classId}/compare/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ClassComparison. client-side declaration; not proof of accepted server payload.
ClassComparison declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| class | BenefitClass | true | — |
| parent | BenefitClass | null | true | — |
| dimensions | string[] | true | — |
| cells | ComparisonCell[] | true | — |
| networks | Array<object> | false | — |
| exclusions | Array<object> | false | — |
| controlling_documents | Array<object> | false | — |
| unresolved_conflicts | Array<object> | true | — |
| activation_blocked_by_conflicts | boolean | false | — |
| 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.resolveClassValue
GET /api/v1/facility/{facilityId}/rcm/classes/{classId}/resolved-value/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ResolvedValue. client-side declaration; not proof of accepted server payload.
ResolvedValue declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| class | RowRef | true | — |
| field_path | string | true | — |
| as_of | string | true | — |
| resolved | boolean | true | — |
| value | unknown | true | — |
| value_state | ValueStateName | true | — |
| origin | OriginBlock | 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.overrideClassValue
POST /api/v1/facility/{facilityId}/rcm/classes/{classId}/override/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: BenefitOverride. client-side declaration; not proof of accepted server payload.
One layer's answer for one property path. Inheriting and overriding are
mutually exclusive states: override.holds_value is the discriminator, and
an inheriting row carries no value at all.
BenefitOverride declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| layer | "template" | "class" | "member_endorsement" | true | — |
| benefit_rule | RowRef | true | — |
| benefit_template | RowRef | null | true | — |
| benefit_class | RowRef | null | true | — |
| member_coverage | RowRef | null | true | — |
| field_path | string | true | — |
| inherits | boolean | true | — |
| override | object | object | true | — |
| authority_org | RowRef | null | true | — |
| source_document | SourceDocumentRef | null | true | — |
| received_date | Stated | true | — |
| mandatory_floor_respected | TriState | 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.simulateClass
POST /api/v1/facility/{facilityId}/rcm/classes/{classId}/simulate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, classId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: SimulationReport. client-side declaration; not proof of accepted server payload.
SimulationReport declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| label | string | true | — |
| simulated_at | string | null | true | — |
| posted_nothing | boolean | true | — |
| cases | Array<object> | true | — |
| affected_policies | string[] | true | — |
| affected_services | string[] | true | — |
| open_encounters | string[] | true | — |
| findings | Array<object> | true | — |
| has_unresolved | 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.listBenefitOverrides
GET /api/v1/facility/{facilityId}/rcm/benefit_overrides/. 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: PaginatedResponse<BenefitOverride>. 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.listClassNetworkAssignments
GET /api/v1/facility/{facilityId}/rcm/class_network_assignments/. 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: PaginatedResponse<ClassNetworkAssignment>. client-side declaration; not proof of accepted server payload.
ClassNetworkAssignment declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| benefit_class | RowRef | true | — |
| network | RowRef | true | — |
| assignment_code | string | true | — |
| precedence | number | true | — |
| territories | object | true | An empty values means "not scoped on this dimension", never "all". |
| emergency | TriState | true | — |
| requires_referral | TriState | true | — |
| service_codes | object | true | — |
| scope_is_explicit | boolean | true | — |
| is_unscoped | boolean | true | — |
| lifecycle | LifecycleBlock | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | 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.listCoverages
GET /api/v1/facility/{facilityId}/rcm/enrollment/. 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: PaginatedResponse<MemberCoverage>. client-side declaration; not proof of accepted server payload.
MemberCoverage declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| patient | string | true | — |
| kind | "insurance" | "self_pay" | "other" | string | true | — |
| status | string | true | — |
| roles | object | true | — |
| policy | string | null | true | — |
| benefit_class | string | null | true | — |
| program | string | null | true | — |
| network | string | null | true | — |
| relationship | OperationsStated | true | — |
| eligibility_date | OperationsStated | true | — |
| activation_date | OperationsStated | true | — |
| coverage_period | object | true | — |
| coordination | object | true | — |
| mapping | CoverageMapping | true | — |
| presented_evidence | Array<Record<string, unknown>> | false | — |
| estimate_restriction | EstimateRestriction | 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.retrieveCoverage
GET /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
response type: MemberCoverage. 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.discoveryLadder
GET /api/v1/facility/{facilityId}/rcm/enrollment/discovery-ladder/. 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: DiscoveryLadder. client-side declaration; not proof of accepted server payload.
DiscoveryLadder declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| config_package | string | true | — |
| ladder_ref | string | true | — |
| rank_labels | string[] | true | — |
| rungs | DiscoveryRung[] | 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.discoverCoverage
POST /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/discover/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: DiscoveryResult. client-side declaration; not proof of accepted server payload.
DiscoveryResult declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| coverage | string | true | — |
| outcome | DiscoveryOutcome | true | — |
| work_queues | WorkQueueRef[] | true | — |
| mapping | CoverageMapping | 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.verifyCoverage
POST /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/verify/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: VerificationResult. client-side declaration; not proof of accepted server payload.
VerificationResult declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| verification | CoverageVerification | true | — |
| site_outcome_catalogue | SiteOutcomeCatalogueEntry[] | true | — |
| site_statement | SiteStatement | null | true | — |
| per_coverage_site_statements | SiteStatement[] | true | — |
| guarantees_payment | boolean | true | — |
| residual_denial_risks | string[] | true | — |
| opens_work_items | boolean | true | — |
| work_queues | WorkQueueRef[] | true | — |
| blocking_gates | Array<Record<string, unknown>> | 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.coverageEligibility
GET /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/eligibility/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
response type: EligibilitySurface. client-side declaration; not proof of accepted server payload.
EligibilitySurface declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| coverage | MemberCoverage | true | — |
| site_outcome_catalogue | SiteOutcomeCatalogueEntry[] | true | — |
| answer_axes | AnswerAxisKey[] | true | — |
| latest_response | CoverageVerification | null | true | — |
| financial_clearance_context | ClearanceContext | null | true | — |
| responses_disagree | boolean | true | — |
| residual_denial_risks | 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.resolveCoverageConflict
POST /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/resolve-conflict/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: ConflictResolution. client-side declaration; not proof of accepted server payload.
ConflictResolution declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| coverage | string | true | — |
| agree | boolean | true | — |
| retained | Array<object> | true | — |
| discarded | unknown[] | true | Always empty by construction: nothing is discarded (ch. 21). |
| coordination | object | null | true | — |
| work_queues | WorkQueueRef[] | 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.endorseCoverage
POST /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/endorse/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, unknown>. client-side declaration; not proof of accepted server payload.
response type: MemberCoverage. 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.coverageEstimateRestriction
GET /api/v1/facility/{facilityId}/rcm/enrollment/{coverageId}/estimate-restriction/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, coverageId. Transport strings are declared here; semantic identifier types require the server contract.
response type: EstimateRestriction. client-side declaration; not proof of accepted server payload.
EstimateRestriction declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| coverage | string | true | — |
| mapping | CoverageMapping | true | — |
| may_present_amount | boolean | true | — |
| certainty | "certain" | "restricted" | true | — |
| restrictions | Array<object> | true | — |
| latest_verification | 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.
Pinned source evidence
Links require access to the private source repository.
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:35
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:41
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:48
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:55
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:60
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:65
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:71
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:77
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:82
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:92
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:98
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:104
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:110
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:122
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:133
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:141
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:146
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:151
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:156
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:161
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:166
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:172
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:178
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:183
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:190
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:195
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:200
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:205
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:211
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:217
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:222
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:228
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:234
- repositories/platform/mansoq-web/src/Utils/request/types.ts:66
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:232
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:246
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:262
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:298
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:208
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:86
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:339
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:96
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:349
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:278
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageApi.ts:113
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:368
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:531
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:562
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:436
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:573
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:408
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:623
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:664
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:802
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:790
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:780
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:809
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/coverage/coverageTypes.ts:614