MANSOQ Frontend module · STATIC DECLARATIONS
Api client API reference · mansoq-web
60 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 60 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.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.organizations.list | GET | /api/v1/facility/{facilityId}/rcm/organizations/ |
literal |
| default.organizations.get | GET | /api/v1/facility/{facilityId}/rcm/organizations/{id}/ |
literal |
| default.organizations.create | POST | /api/v1/facility/{facilityId}/rcm/organizations/ |
literal |
| default.organizations.update | PATCH | /api/v1/facility/{facilityId}/rcm/organizations/{id}/ |
literal |
| default.organizations.readiness | GET | /api/v1/facility/{facilityId}/rcm/organizations/{id}/readiness/ |
literal |
| default.organizations.evidence | GET | /api/v1/facility/{facilityId}/rcm/organizations/{id}/evidence/ |
literal |
| default.organizations.gates | GET | /api/v1/facility/{facilityId}/rcm/organizations/{id}/gates/ |
literal |
| default.organizations.duplicates | POST | /api/v1/facility/{facilityId}/rcm/organizations/duplicates/ |
literal |
| default.organizations.verify | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/verify/ |
literal |
| default.organizations.activate | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/activate/ |
literal |
| default.organizations.suspend | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/suspend/ |
literal |
| default.organizations.transition | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/transition/ |
literal |
| default.organizations.supersede | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/supersede/ |
literal |
| default.organizations.newVersion | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/new-version/ |
literal |
| default.organizations.markDuplicateOf | POST | /api/v1/facility/{facilityId}/rcm/organizations/{id}/mark-duplicate-of/ |
literal |
| default.roles.list | GET | /api/v1/facility/{facilityId}/rcm/organization_roles/ |
literal |
| default.roles.create | POST | /api/v1/facility/{facilityId}/rcm/organization_roles/ |
literal |
| default.roles.update | PATCH | /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/ |
literal |
| default.roles.licence | GET | /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/licence/ |
literal |
| default.roles.activate | POST | /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/activate/ |
literal |
| default.roles.suspend | POST | /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/suspend/ |
literal |
| default.identifiers.list | GET | /api/v1/facility/{facilityId}/rcm/organization_identifiers/ |
literal |
| default.identifiers.create | POST | /api/v1/facility/{facilityId}/rcm/organization_identifiers/ |
literal |
| default.identifiers.update | PATCH | /api/v1/facility/{facilityId}/rcm/organization_identifiers/{id}/ |
literal |
| default.contacts.list | GET | /api/v1/facility/{facilityId}/rcm/organization_contacts/ |
literal |
| default.contacts.create | POST | /api/v1/facility/{facilityId}/rcm/organization_contacts/ |
literal |
| default.contacts.update | PATCH | /api/v1/facility/{facilityId}/rcm/organization_contacts/{id}/ |
literal |
| default.agreements.list | GET | /api/v1/facility/{facilityId}/rcm/agreements/ |
literal |
| default.agreements.get | GET | /api/v1/facility/{facilityId}/rcm/agreements/{id}/ |
literal |
| default.agreements.create | POST | /api/v1/facility/{facilityId}/rcm/agreements/ |
literal |
| default.agreements.update | PATCH | /api/v1/facility/{facilityId}/rcm/agreements/{id}/ |
literal |
| default.agreements.readiness | GET | /api/v1/facility/{facilityId}/rcm/agreements/{id}/readiness/ |
literal |
| default.agreements.overlapSimulation | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/overlap-simulation/ |
literal |
| default.agreements.signOff | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/sign-off/ |
literal |
| default.agreements.publish | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/publish/ |
literal |
| default.agreements.suspend | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/suspend/ |
literal |
| default.agreements.transition | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/transition/ |
literal |
| default.agreements.newVersion | POST | /api/v1/facility/{facilityId}/rcm/agreements/{id}/new-version/ |
literal |
| default.delegations.list | GET | /api/v1/facility/{facilityId}/rcm/agreement_delegations/ |
literal |
| default.delegations.create | POST | /api/v1/facility/{facilityId}/rcm/agreement_delegations/ |
literal |
| default.delegations.update | PATCH | /api/v1/facility/{facilityId}/rcm/agreement_delegations/{id}/ |
literal |
| default.contracts.list | GET | /api/v1/facility/{facilityId}/rcm/provider_contracts/ |
literal |
| default.contracts.get | GET | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/ |
literal |
| default.contracts.create | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/ |
literal |
| default.contracts.update | PATCH | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/ |
literal |
| default.contracts.readiness | GET | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/readiness/ |
literal |
| default.contracts.amendments | GET | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/amendments/ |
literal |
| default.contracts.compareAmendments | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/compare-amendments/ |
literal |
| default.contracts.versions | GET | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/versions/ |
literal |
| default.contracts.tariffImport | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/tariff-import/ |
literal |
| default.contracts.approve | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/approve/ |
literal |
| default.contracts.activate | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/activate/ |
literal |
| default.contracts.suspend | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/suspend/ |
literal |
| default.contracts.transition | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/transition/ |
literal |
| default.contracts.newVersion | POST | /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/new-version/ |
literal |
| default.tariffs.list | GET | /api/v1/facility/{facilityId}/rcm/tariffs/ |
literal |
| default.contractSites.list | GET | /api/v1/facility/{facilityId}/rcm/provider_contract_sites/ |
literal |
| default.contractDocuments.list | GET | /api/v1/facility/{facilityId}/rcm/provider_contract_documents/ |
literal |
| default.contractDocuments.create | POST | /api/v1/facility/{facilityId}/rcm/provider_contract_documents/ |
literal |
| default.contractDocuments.update | PATCH | /api/v1/facility/{facilityId}/rcm/provider_contract_documents/{id}/ |
literal |
default.organizations.list
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<RcmOrganizationRead>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
RcmOrganizationRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| internal_code | string | true | — |
| legal_name_ar | string | true | — |
| legal_name_en | string | true | — |
| legal_name | string | true | — |
| legal_name_language | StatedText | true | — |
| bilingual_display_complete | boolean | true | — |
| legal_entity_type | string | true | — |
| country_code | string | true | — |
| registered_address | Record<string, unknown> | null | true | — |
| organization_type | StatedText | true | — |
| organization_type_system | string | true | — |
| payer_category | StatedText | true | — |
| payer_class | PayerClassValue | true | — |
| regulator | StatedText | true | — |
| operational_language | string | true | — |
| display_brand | NonRoutableName | true | — |
| aliases | NonRoutableNames | true | — |
| portal_url | string | true | — |
| roles | OrganizationRoleRead[] | false | Present on retrieve only. |
| identifiers | OrganizationIdentifierRead[] | false | — |
| contacts | OrganizationContactRead[] | false | — |
Composed/inherited schema references: ConfigurationRow. 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.organizations.get
GET /api/v1/facility/{facilityId}/rcm/organizations/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: RcmOrganizationRead. 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.organizations.create
POST /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.
request type: OrganizationWrite. client-side declaration; not proof of accepted server payload.
OrganizationWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| legal_name_ar | string | false | — |
| legal_name_en | string | false | — |
| legal_name | string | false | — |
| legal_name_language | string | null | false | — |
| legal_name_language_state | ValueState | false | — |
| internal_code | string | false | — |
| legal_entity_type | string | false | — |
| country_code | string | false | — |
| organization_type | string | null | false | — |
| organization_type_state | ValueState | false | — |
| organization_type_system | string | false | — |
| payer_category | string | null | false | — |
| payer_category_state | ValueState | false | — |
| payer_class | PayerClassValue | false | — |
| regulator | string | null | false | — |
| regulator_state | ValueState | false | — |
| operational_language | string | false | — |
| aliases | string[] | false | — |
| display_brand | string | false | — |
| portal_url | string | false | — |
| evidence_state | EvidenceStateValue | false | — |
| source_document | string | null | false | — |
| activation_blocked_by | string[] | false | — |
| effective_from | string | null | false | — |
| effective_to | string | null | false | — |
| lock_token | string | false | — |
| change_reason | string | false | — |
response type: RcmOrganizationRead. 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.organizations.update
PATCH /api/v1/facility/{facilityId}/rcm/organizations/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: OrganizationWrite. client-side declaration; not proof of accepted server payload.
response type: RcmOrganizationRead. 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.organizations.readiness
GET /api/v1/facility/{facilityId}/rcm/organizations/{id}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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 | ConfigStatus | true | — |
| is_ready | boolean | true | — |
| checked_overlap | boolean | true | — |
| open_gates | string[] | true | — |
| refusals | Refusal[] | true | — |
| screen_refusals | Refusal[] | false | — |
| maker_checker | Record<string, unknown> | false | — |
| gates | GateBlock | false | — |
| evidence | EvidenceBlock | false | — |
| lock_token | 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.organizations.evidence
GET /api/v1/facility/{facilityId}/rcm/organizations/{id}/evidence/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: object. client-side declaration; not proof of accepted server payload.
What proves a row, stated beside it (report ch. 31).
EvidenceBlock declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| evidence_state | EvidenceStateValue | true | — |
| is_activation_grade | boolean | true | — |
| activation_grade_states | string[] | true | — |
| source_document | SourceDocumentRef | null | true | — |
| links | EvidenceLinkRead[] | true | — |
default.organizations.evidence.response declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| subject | string | true | — |
| evidence | EvidenceBlock | 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.organizations.gates
GET /api/v1/facility/{facilityId}/rcm/organizations/{id}/gates/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: GateBlock. client-side declaration; not proof of accepted server payload.
Which gate blocks this row and why — never a generic validation error.
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.organizations.duplicates
Duplicate detection. Runs on role-qualified identifiers only.
POST /api/v1/facility/{facilityId}/rcm/organizations/duplicates/. 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: object. client-side declaration; not proof of accepted server payload.
default.organizations.duplicates.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | false | — |
| identifiers | object[] | false | — |
response type: DuplicateReport. client-side declaration; not proof of accepted server payload.
DuplicateReport declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| matched_on | string | true | — |
| never_matched_on | string[] | true | — |
| exact_identifier_matches | DuplicateMatch[] | true | — |
| same_value_different_system_or_environment | DuplicateMatch[] | true | — |
| name_similarity_only | object | true | — |
| merge_supported | boolean | true | — |
| resolution | 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.organizations.verify
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/verify/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite & object. client-side declaration; not proof of accepted server payload.
Every configuration write carries the token the editor loaded the row with.
LockedWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| lock_token | string | true | — |
| change_reason | string | false | — |
| actor_role | string | false | — |
response type: VerifyVerdict. client-side declaration; not proof of accepted server payload.
VerifyVerdict declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| verified | boolean | true | — |
| as_of | string | null | true | — |
| refusals | Refusal[] | true | — |
| evidence | EvidenceBlock | true | — |
| gates | GateBlock | true | — |
| organization | RcmOrganizationRead | true | — |
| errors | 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.organizations.activate
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/activate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ActivateBody. client-side declaration; not proof of accepted server payload.
ActivateBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| target_status | ConfigStatus | false | — |
Composed/inherited schema references: LockedWrite. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: RcmOrganizationRead. 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.organizations.suspend
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/suspend/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: RcmOrganizationRead & object. 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.organizations.transition
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/transition/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LifecycleTransitionBody. client-side declaration; not proof of accepted server payload.
LifecycleTransitionBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| to_status | ConfigStatus | true | — |
Composed/inherited schema references: LockedWrite. Exact generic composition is retained in the structured reference and requires server-side confirmation.
response type: RcmOrganizationRead. 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.organizations.supersede
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/supersede/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: RcmOrganizationRead. 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.organizations.newVersion
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/new-version/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.organizations.newVersion.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| change_reason | string | false | — |
| actor_role | string | false | — |
response type: RcmOrganizationRead. 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.organizations.markDuplicateOf
Supersede this row naming the survivor. Nothing is merged.
POST /api/v1/facility/{facilityId}/rcm/organizations/{id}/mark-duplicate-of/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite & object. client-side declaration; not proof of accepted server payload.
response type: object. client-side declaration; not proof of accepted server payload.
default.organizations.markDuplicateOf.response declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| retired | RcmOrganizationRead | true | — |
| survivor | RcmOrganizationRead | true | — |
| merged | 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.roles.list
GET /api/v1/facility/{facilityId}/rcm/organization_roles/. 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<OrganizationRoleRead>. client-side declaration; not proof of accepted server payload.
OrganizationRoleRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | RowRef | true | — |
| role | OrganizationRoleType | true | — |
| licence_authority | string | true | — |
| licence_number | string | true | — |
| licence_status | LicenceStatus | true | — |
| licence_status_established | boolean | true | — |
| licence_valid_from | string | null | true | — |
| licence_valid_to | string | null | true | — |
| licence_required | TriStateValue | true | — |
| licence_is_current | boolean | false | Only when the request supplied as_of. |
| as_of | string | false | — |
Composed/inherited schema references: ConfigurationRow. 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.roles.create
POST /api/v1/facility/{facilityId}/rcm/organization_roles/. 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: OrganizationRoleWrite. client-side declaration; not proof of accepted server payload.
OrganizationRoleWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | false | — |
| role | OrganizationRoleType | false | — |
| licence_authority | string | false | — |
| licence_number | string | false | — |
| licence_status | LicenceStatus | false | — |
| licence_valid_from | string | null | false | — |
| licence_valid_to | string | null | false | — |
| licence_required | TriState | false | — |
| evidence_state | EvidenceStateValue | false | — |
| source_document | string | null | false | — |
| effective_from | string | null | false | — |
| effective_to | string | null | false | — |
| lock_token | string | false | — |
| change_reason | string | false | — |
response type: OrganizationRoleRead. 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.roles.update
PATCH /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: OrganizationRoleWrite. client-side declaration; not proof of accepted server payload.
response type: OrganizationRoleRead. 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.roles.licence
GET /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/licence/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: LicenceVerdict. client-side declaration; not proof of accepted server payload.
LicenceVerdict declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| role | OrganizationRoleRead | true | — |
| withdrawing_statuses | LicenceStatus[] | true | — |
| routes_live_traffic | 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.roles.activate
POST /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/activate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ActivateBody. client-side declaration; not proof of accepted server payload.
response type: OrganizationRoleRead. 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.roles.suspend
POST /api/v1/facility/{facilityId}/rcm/organization_roles/{id}/suspend/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: OrganizationRoleRead. 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.identifiers.list
GET /api/v1/facility/{facilityId}/rcm/organization_identifiers/. 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<OrganizationIdentifierRead>. client-side declaration; not proof of accepted server payload.
OrganizationIdentifierRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| organization | RowRef | true | — |
| id_type | string | true | — |
| id_system | string | true | — |
| id_value | string | true | — |
| issuer_name | string | true | — |
| environment | Environment | null | true | — |
| national_insurance_code | StatedText | true | — |
| field_dictionary_slice | StatedText | true | — |
| value_set_expansion | StatedText | true | — |
| expansion_conflict | TriStateValue | true | — |
| valid_from | string | null | true | — |
| valid_to | string | null | true | — |
| valid_to_is_inclusive | boolean | true | — |
| evidence | EvidenceBlock | true | — |
| is_valid_on | boolean | 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.identifiers.create
POST /api/v1/facility/{facilityId}/rcm/organization_identifiers/. 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: OrganizationIdentifierWrite. client-side declaration; not proof of accepted server payload.
OrganizationIdentifierWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | false | — |
| id_type | string | false | — |
| id_system | string | false | — |
| id_value | string | false | — |
| issuer_name | string | false | — |
| environment | Environment | null | false | — |
| expansion_conflict | TriState | false | — |
| valid_from | string | null | false | — |
| valid_to | string | null | false | — |
| evidence_state | EvidenceStateValue | false | — |
| source_document | string | null | false | — |
response type: OrganizationIdentifierRead. 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.identifiers.update
PATCH /api/v1/facility/{facilityId}/rcm/organization_identifiers/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: OrganizationIdentifierWrite. client-side declaration; not proof of accepted server payload.
response type: OrganizationIdentifierRead. 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.contacts.list
GET /api/v1/facility/{facilityId}/rcm/organization_contacts/. 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<OrganizationContactRead>. client-side declaration; not proof of accepted server payload.
OrganizationContactRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| organization | RowRef | true | — |
| purpose | string | true | — |
| name | string | true | — |
| string | true | — | |
| phone | string | true | — |
| hours | string | true | — |
| holiday_calendar | RowRef | null | true | — |
| notes | 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.contacts.create
POST /api/v1/facility/{facilityId}/rcm/organization_contacts/. 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: OrganizationContactWrite. client-side declaration; not proof of accepted server payload.
OrganizationContactWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| organization | string | false | — |
| purpose | string | false | — |
| name | string | false | — |
| string | false | — | |
| phone | string | false | — |
| hours | string | false | — |
| notes | string | false | — |
response type: OrganizationContactRead. 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.contacts.update
PATCH /api/v1/facility/{facilityId}/rcm/organization_contacts/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: OrganizationContactWrite. client-side declaration; not proof of accepted server payload.
response type: OrganizationContactRead. 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.agreements.list
GET /api/v1/facility/{facilityId}/rcm/agreements/. 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<AdministrationAgreementRead>. client-side declaration; not proof of accepted server payload.
AdministrationAgreementRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| agreement_number | string | true | — |
| insurer_org | RowRef | true | — |
| administrator_org | RowRef | null | true | — |
| is_self_administered | boolean | true | — |
| signatories | unknown | true | — |
| contracting_party_roles | unknown | true | — |
| delegated_authority_document | RowRef | null | true | — |
| covered | object | true | — |
| covered_services | unknown | true | — |
| transaction_scope | string[] | true | — |
| scope_is_explicit | TriStateValue | true | — |
| scope_is_unbounded | boolean | true | — |
| routing_effective_basis | RoutingEffectiveBasis | true | — |
| routing_identifier | OrganizationIdentifierRead | null | true | — |
| settlement_owner | RowRef | null | true | Ch. 6: who owns settlement and who bears the liability are two fields. |
| settlement_liability_party | RowRef | null | true | — |
| termination_handling | string | true | — |
| termination_date | string | null | true | — |
| termination_reason | string | true | — |
| termination_notice | string | true | — |
| runoff_administrator_org | RowRef | null | true | — |
| replacement_agreement | RowRef | null | true | — |
| delegations | AdministrationDelegationRead[] | false | — |
| routing_rules | RoutingRuleRead[] | false | — |
Composed/inherited schema references: ConfigurationRow. 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.agreements.get
GET /api/v1/facility/{facilityId}/rcm/agreements/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: AdministrationAgreementRead. 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.agreements.create
POST /api/v1/facility/{facilityId}/rcm/agreements/. 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: AgreementWrite. client-side declaration; not proof of accepted server payload.
AgreementWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| insurer_org | string | false | — |
| administrator_org | string | null | false | — |
| agreement_number | string | false | — |
| transaction_scope | string[] | false | — |
| scope_is_explicit | TriState | false | — |
| routing_effective_basis | RoutingEffectiveBasis | false | — |
| settlement_owner | string | null | false | — |
| settlement_liability_party | string | null | false | — |
| covered_program_ids | string[] | false | — |
| covered_policy_ids | string[] | false | — |
| covered_product_ids | string[] | false | — |
| covered_class_ids | string[] | false | — |
| covered_facility_ids | string[] | false | — |
| termination_handling | string | false | — |
| termination_date | string | null | false | — |
| termination_reason | string | false | — |
| termination_notice | string | false | — |
| signatories | unknown | false | — |
| evidence_state | EvidenceStateValue | false | — |
| source_document | string | null | false | — |
| effective_from | string | null | false | — |
| effective_to | string | null | false | — |
| lock_token | string | false | — |
| change_reason | string | false | — |
response type: AdministrationAgreementRead. 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.agreements.update
PATCH /api/v1/facility/{facilityId}/rcm/agreements/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: AgreementWrite. client-side declaration; not proof of accepted server payload.
response type: AdministrationAgreementRead. 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.agreements.readiness
GET /api/v1/facility/{facilityId}/rcm/agreements/{id}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.agreements.overlapSimulation
The overlap simulator. Posts nothing.
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/overlap-simulation/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.agreements.overlapSimulation.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| environment | string | true | — |
| on_date | string | false | — |
| transaction_types | string[] | false | — |
| scenarios | object[] | false | — |
response type: OverlapSimulation. client-side declaration; not proof of accepted server payload.
OverlapSimulation declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| agreement | string | true | — |
| as_of | string | true | — |
| environment | Environment | true | — |
| transaction_types | string[] | true | — |
| scenarios | string[] | true | — |
| cells | OverlapCell[] | true | — |
| refusals | OverlapCell[] | true | — |
| competing_agreements | object[] | true | — |
| publishable | boolean | true | — |
| posted_nothing | 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.agreements.signOff
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/sign-off/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: AdministrationAgreementRead. 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.agreements.publish
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/publish/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ActivateBody. client-side declaration; not proof of accepted server payload.
response type: AdministrationAgreementRead. 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.agreements.suspend
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/suspend/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: AdministrationAgreementRead & object. 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.agreements.transition
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/transition/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LifecycleTransitionBody. client-side declaration; not proof of accepted server payload.
response type: AdministrationAgreementRead. 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.agreements.newVersion
POST /api/v1/facility/{facilityId}/rcm/agreements/{id}/new-version/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.agreements.newVersion.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| change_reason | string | false | — |
| actor_role | string | false | — |
response type: AdministrationAgreementRead. 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.delegations.list
GET /api/v1/facility/{facilityId}/rcm/agreement_delegations/. 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<AdministrationDelegationRead>. client-side declaration; not proof of accepted server payload.
AdministrationDelegationRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| agreement | RowRef | true | — |
| function | DelegatedFunction | true | — |
| is_delegated | TriStateValue | true | — |
| conditions | unknown | 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.delegations.create
POST /api/v1/facility/{facilityId}/rcm/agreement_delegations/. 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: DelegationWrite. client-side declaration; not proof of accepted server payload.
DelegationWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| agreement | string | false | — |
| function | DelegatedFunction | false | — |
| is_delegated | TriState | false | — |
| effective_from | string | null | false | — |
| effective_to | string | null | false | — |
response type: AdministrationDelegationRead. 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.delegations.update
PATCH /api/v1/facility/{facilityId}/rcm/agreement_delegations/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: DelegationWrite. client-side declaration; not proof of accepted server payload.
response type: AdministrationDelegationRead. 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.contracts.list
GET /api/v1/facility/{facilityId}/rcm/provider_contracts/. 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<ProviderContractRead>. client-side declaration; not proof of accepted server payload.
ProviderContractRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract_number | string | true | — |
| contract_type | ProviderContractType | true | — |
| provider_org | RowRef | true | — |
| counterparty_org | RowRef | true | — |
| contracting_authority_agreement | RowRef | null | true | — |
| signatories | unknown | true | — |
| program_scope | string[] | true | — |
| payer_scope | string[] | true | — |
| scope_is_explicit | TriStateValue | true | — |
| unified_contract_document | RowRef | null | true | — |
| runoff_until | StatedText | true | — |
| pricing_method | StatedText | true | — |
| pricing_date_rule | StatedText | true | — |
| network | RowRef | null | true | — |
| tariff | RowRef | null | true | — |
| billing_rules | unknown | true | — |
| submission_requirements | unknown | true | — |
| dispute_process | string | true | — |
| settlement_terms | unknown | true | — |
| business_calendar | RowRef | null | true | — |
| deadline_rules | Record<RemedyWindow, RowRef | null> & object | true | — |
| authorization_sla_minutes | StatedValue | true | — |
| emergency_notice_hours | StatedValue | true | — |
| free_followup_days | StatedValue | true | — |
| tax_recipient_org | RowRef | null | true | — |
| billing_customer_role | StatedText | true | — |
| underpayment_tolerance | StatedValue | true | — |
| underpayment_tolerance_currency | string | true | — |
| underpayment_tolerance_percent | StatedValue | true | — |
| sites | ProviderContractSiteRead[] | false | — |
| documents | ProviderContractDocumentRead[] | false | — |
Composed/inherited schema references: ConfigurationRow. 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.contracts.get
GET /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: ProviderContractRead. 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.contracts.create
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/. 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: ContractWrite. client-side declaration; not proof of accepted server payload.
ContractWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract_number | string | false | — |
| contract_type | ProviderContractType | false | — |
| provider_org | string | false | — |
| counterparty_org | string | false | — |
| contracting_authority_agreement | string | null | false | — |
| program_scope | string[] | false | — |
| payer_scope | string[] | false | — |
| scope_is_explicit | TriState | false | — |
| pricing_method | string | null | false | — |
| pricing_method_state | ValueState | false | — |
| pricing_date_rule | string | null | false | — |
| pricing_date_rule_state | ValueState | false | — |
| tax_recipient_org | string | null | false | — |
| billing_customer_role | string | null | false | — |
| billing_customer_role_state | ValueState | false | — |
| dispute_process | string | false | — |
| authorization_sla_minutes | string | null | false | — |
| authorization_sla_minutes_state | ValueState | false | — |
| emergency_notice_hours | string | null | false | — |
| emergency_notice_hours_state | ValueState | false | — |
| free_followup_days | string | null | false | — |
| free_followup_days_state | ValueState | false | — |
| evidence_state | EvidenceStateValue | false | — |
| source_document | string | null | false | — |
| effective_from | string | null | false | — |
| effective_to | string | null | false | — |
| lock_token | string | false | — |
| change_reason | string | false | — |
response type: ProviderContractRead. 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.contracts.update
PATCH /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ContractWrite. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead. 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.contracts.readiness
GET /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.contracts.amendments
GET /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/amendments/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: AmendmentChain. client-side declaration; not proof of accepted server payload.
AmendmentChain declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract | RowRef | true | — |
| documents | ProviderContractDocumentRead[] | true | — |
| chain_integrity | object | 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.contracts.compareAmendments
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/compare-amendments/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.contracts.compareAmendments.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| from_document | string | true | — |
| to_document | string | true | — |
| as_of | string | false | — |
response type: AmendmentComparison. client-side declaration; not proof of accepted server payload.
AmendmentComparison declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract | RowRef | true | — |
| from_document | ProviderContractDocumentRead | true | — |
| to_document | ProviderContractDocumentRead | true | — |
| diff | object | true | — |
| supersedes_declared | boolean | true | — |
| version_in_force | VersionInForce | null | 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.contracts.versions
GET /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/versions/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
response type: ContractVersions. client-side declaration; not proof of accepted server payload.
ContractVersions declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract_number | string | true | — |
| versions | (VersionInForce & object)[] | true | — |
| in_force | VersionInForce | 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.contracts.tariffImport
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/tariff-import/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite & object. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead. 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.contracts.approve
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/approve/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead. 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.contracts.activate
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/activate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ActivateBody. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead. 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.contracts.suspend
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/suspend/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LockedWrite. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead & object. 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.contracts.transition
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/transition/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: LifecycleTransitionBody. client-side declaration; not proof of accepted server payload.
response type: ProviderContractRead. 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.contracts.newVersion
POST /api/v1/facility/{facilityId}/rcm/provider_contracts/{id}/new-version/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. 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.contracts.newVersion.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| change_reason | string | false | — |
| actor_role | string | false | — |
response type: ProviderContractRead. 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.tariffs.list
GET /api/v1/facility/{facilityId}/rcm/tariffs/. 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<TariffOption>. client-side declaration; not proof of accepted server payload.
Only what SET-03's tariff import needs. SET-07 owns the tariff screen and its full payload; this screen reads the three facts the import refuses on — which organization owns the tariff, which agreement gave it its authority, and whether it is published.
TariffOption declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| code | string | true | — |
| label | string | true | — |
| currency | string | true | — |
| owner_org | RowRef | true | — |
| authority_agreement | RowRef | null | true | — |
| is_published | boolean | 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.contractSites.list
GET /api/v1/facility/{facilityId}/rcm/provider_contract_sites/. 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<ProviderContractSiteRead>. client-side declaration; not proof of accepted server payload.
ProviderContractSiteRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| contract | RowRef | true | — |
| provider_site_id | string | true | — |
| specialty_scope | unknown | 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.contractDocuments.list
GET /api/v1/facility/{facilityId}/rcm/provider_contract_documents/. 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<ProviderContractDocumentRead>. client-side declaration; not proof of accepted server payload.
ProviderContractDocumentRead declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| contract | RowRef | true | — |
| document_kind | ContractDocumentKind | true | — |
| sequence | number | true | — |
| title | string | true | — |
| signed_date | string | null | true | Ch. 1: receipt is not commencement. These two never merge. |
| received_date | string | null | true | — |
| affects_scope | Record<string, unknown> | null | true | — |
| source_document | RowRef | null | true | — |
| content_sha256 | string | true | — |
| supersedes | object | 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.contractDocuments.create
POST /api/v1/facility/{facilityId}/rcm/provider_contract_documents/. 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: ContractDocumentWrite. client-side declaration; not proof of accepted server payload.
ContractDocumentWrite declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| contract | string | false | — |
| document_kind | ContractDocumentKind | false | — |
| sequence | number | false | — |
| title | string | false | — |
| signed_date | string | null | false | — |
| received_date | string | null | false | — |
| source_document | string | false | — |
| supersedes | string | null | false | — |
| affects_scope | Record<string, unknown> | false | — |
response type: ProviderContractDocumentRead. 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.contractDocuments.update
PATCH /api/v1/facility/{facilityId}/rcm/provider_contract_documents/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.
request type: ContractDocumentWrite. client-side declaration; not proof of accepted server payload.
response type: ProviderContractDocumentRead. 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.
Pinned source evidence
Links require access to the private source repository.
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:50
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:55
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:60
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:66
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:72
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:77
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:82
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:88
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:102
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:108
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:114
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:120
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:126
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:132
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:139
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:153
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:158
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:164
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:170
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:175
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:181
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:190
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:195
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:201
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:210
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:215
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:221
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:231
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:236
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:241
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:247
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:253
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:259
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:270
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:276
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:282
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:288
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:294
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:303
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:308
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:314
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:324
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:329
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:334
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:340
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:346
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:351
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:356
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:366
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:371
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:377
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:383
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:389
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:395
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:401
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:411
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:419
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:427
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:432
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:438
- repositories/platform/mansoq-web/src/Utils/request/types.ts:66
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:252
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:658
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:185
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:115
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:80
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:143
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:92
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:365
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:644
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:379
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:654
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:650
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:136
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:142
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:277
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:688
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:389
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:292
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:705
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:312
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:719
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:409
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:729
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:263
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:483
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:298
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:443
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:756
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:519
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:764
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:601
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:360
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:616
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:630
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/api.ts:405
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:559
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:570
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:580
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/parties/types.ts:795