← Technical API reference

Frontend module · STATIC DECLARATIONS

Governance Api client API reference · mansoq-web

35 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 35 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/governanceApi.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.qualifyPackage POST /api/v1/facility/{facilityId}/rcm/rule_publishing/qualify-candidate/ literal
default.listPackages GET /api/v1/facility/{facilityId}/rcm/rule_publishing/ literal
default.retrievePackage GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/ literal
default.publishPackage POST /api/v1/facility/{facilityId}/rcm/rule_publishing/ literal
default.correctPackage POST /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/correct/ literal
default.packageManifest GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/manifest/ literal
default.packageGates GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/gates/ literal
default.validateRow POST /api/v1/facility/{facilityId}/rcm/rule_publishing/validate/ literal
default.approveRow POST /api/v1/facility/{facilityId}/rcm/rule_publishing/approve/ literal
default.activateRow POST /api/v1/facility/{facilityId}/rcm/rule_publishing/activate/ literal
default.supersedeRow POST /api/v1/facility/{facilityId}/rcm/rule_publishing/supersede/ literal
default.simulate POST /api/v1/facility/{facilityId}/rcm/rule_publishing/simulate/ literal
default.decisionPackage GET /api/v1/facility/{facilityId}/rcm/rule_publishing/decision_package/ literal
default.listOverrides GET /api/v1/facility/{facilityId}/rcm/overrides/ literal
default.createOverride POST /api/v1/facility/{facilityId}/rcm/overrides/ literal
default.expireOverride POST /api/v1/facility/{facilityId}/rcm/overrides/{overrideId}/expire/ literal
default.completeOverrideReview POST /api/v1/facility/{facilityId}/rcm/overrides/{overrideId}/complete_review/ literal
default.listGates GET /api/v1/facility/{facilityId}/rcm/gates/ literal
default.retrieveGate GET /api/v1/facility/{facilityId}/rcm/gates/{gateId}/ literal
default.closeGate POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/close/ literal
default.acceptGateRisk POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/accept_risk/ literal
default.markGateNotApplicable POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/not_applicable/ literal
default.gateSweep GET /api/v1/facility/{facilityId}/rcm/gates/sweep/ literal
default.listTraces GET /api/v1/facility/{facilityId}/rcm/traces/ literal
default.retrieveTrace GET /api/v1/facility/{facilityId}/rcm/traces/{traceId}/ literal
default.explainTrace GET /api/v1/facility/{facilityId}/rcm/traces/explain/ literal
default.listEndpoints GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/ literal
default.retrieveEndpoint GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/ literal
default.endpointCertificate GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/certificate/ literal
default.testConnection POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/test_connection/ literal
default.replayExchange POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/replay/ literal
default.endpointErrors GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/errors/ literal
default.rotateCertificate POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/rotate_certificate/ literal
default.exportIntegration GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/export/ literal
default.activationStates GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/activation_states/ literal

default.qualifyPackage

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/qualify-candidate/. 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.qualifyPackage.request declared fields:

Field Type Required Description
label string true —
corrects string | null false —

response type: PackageQualification. client-side declaration; not proof of accepted server payload.

PackageQualification declared fields:

Field Type Required Description
id string true —
contract_version number true —
label string true —
corrects string | null true —
manifest_hash string true —
passed boolean true —
checked_rows number true —
expires_at string true —
checks string[] true —
open_gates string[] true —
blockers object[] true —
government_or_customer_uat_verified false 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.listPackages

GET /api/v1/facility/{facilityId}/rcm/rule_publishing/. 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<ConfigPackage>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field Type Required Description
count number true —
results TItem[] true —

ConfigPackage declared fields:

Field Type Required Description
id string true —
label string true —
sequence number true —
content_sha256 string true —
open_gates_at_cut_time string[] true The gates that were open when this package was cut. A package cut with a gate open is legitimately publishable and legitimately marked so.
published_at string | null true —
published_by UserIdentity | null true —
approved_by UserIdentity | null true —
validation_passed boolean true —
test_run_reference string true —
corrects ConfigRowReference | null true —
is_immutable true true —
correction_path string true —
manifest_entry_count number false —
manifest_statuses 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.retrievePackage

GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, packageId. Transport strings are declared here; semantic identifier types require the server contract.

response type: ConfigPackage. 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.publishPackage

Publish: cut an immutable, sequenced package. approved_by is the approver's approval code for action create, field approved_by.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/. 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.publishPackage.request declared fields:

Field Type Required Description
label string true —
approved_by string true —
validation_run_id string true —
actor_role string false —

response type: ConfigPackage. 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.correctPackage

A correction is a new sequence. The corrected package is untouched. approved_by is an approval code for action correct.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/correct/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, packageId. 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.correctPackage.request declared fields:

Field Type Required Description
label string true —
approved_by string true —
validation_run_id string true —
actor_role string false —

response type: object. client-side declaration; not proof of accepted server payload.

default.correctPackage.response declared fields:

Field Type Required Description
corrects ConfigPackage true —
package ConfigPackage 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.packageManifest

GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/manifest/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, packageId. Transport strings are declared here; semantic identifier types require the server contract.

response type: ManifestResponse. client-side declaration; not proof of accepted server payload.

ManifestResponse declared fields:

Field Type Required Description
package ConfigPackage true —
statuses string[] true —
entries ManifestEntry[] true —
entry_count number 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.packageGates

The gates that were open when the package was cut, joined against their live status: "open at cut time" and "open now" stay two separate facts.

GET /api/v1/facility/{facilityId}/rcm/rule_publishing/{packageId}/gates/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, packageId. Transport strings are declared here; semantic identifier types require the server contract.

response type: PackageGatesResponse. client-side declaration; not proof of accepted server payload.

PackageGatesResponse declared fields:

Field Type Required Description
package ConfigPackage true —
gates PackageGateRow[] 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.validateRow

Every reason a named configuration row may not activate — all of them.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/validate/. 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.validateRow.request declared fields:

Field Type Required Description
model_label string true —
row string true —
target_status string false —
category string false —
amount string false —
require_test_run_reference boolean false —
require_source_document boolean false —
maker_checker Record<string, unknown> false —

response type: ValidateResponse. client-side declaration; not proof of accepted server payload.

ValidateResponse declared fields:

Field Type Required Description
row ConfigRowReference true —
readiness ActivationReadiness 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.approveRow

Move a row along the machine. draft -> active has no shortcut.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/approve/. 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.approveRow.request declared fields:

Field Type Required Description
model_label string true —
row string true —
target_status string true —
lock_token string false —
change_reason string false —
actor_role string false —

response type: TransitionResponse. client-side declaration; not proof of accepted server payload.

TransitionResponse declared fields:

Field Type Required Description
row ConfigRowReference true —
status ConfigStatus | string true —
lock_token string true —
approved_by UserIdentity | null false —
approved_at string | null false —
retained_for_historical_dates boolean 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.activateRow

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/activate/. 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.activateRow.request declared fields:

Field Type Required Description
model_label string true —
row string true —
lock_token string false —
target_status string false —
category string false —
amount string false —
actor_role string false —
require_test_run_reference boolean false —
require_source_document boolean false —
maker_checker Record<string, unknown> false —

response type: TransitionResponse. 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.supersedeRow

Retire a version without deleting it, with a reason on the record.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/supersede/. 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.supersedeRow.request declared fields:

Field Type Required Description
model_label string true —
row string true —
change_reason string true —
lock_token string false —
actor_role string false —

response type: TransitionResponse. 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.simulate

Replay representative cases and post nothing.

POST /api/v1/facility/{facilityId}/rcm/rule_publishing/simulate/. 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.

One representative case, as the simulate request body carries it.

SimulationCaseInput declared fields:

Field Type Required Description
case_key string true —
setting string true —
description string false —
subject_reference string false —
before Record<string, unknown> true —
after Record<string, unknown> true —

default.simulate.request declared fields:

Field Type Required Description
label string true —
cases SimulationCaseInput[] true —

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 The contract, not a comment: simulate posts nothing.
has_unresolved boolean true —
cases SimulationCaseComparison[] true —
findings SimulationFinding[] true —
affected_policies string[] | null true —
affected_policies_were_enumerated boolean true —
affected_services string[] | null true —
affected_services_were_enumerated boolean true —
open_encounters string[] | null true —
open_encounters_were_enumerated 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.decisionPackage

Which immutable package governed a given decision.

GET /api/v1/facility/{facilityId}/rcm/rule_publishing/decision_package/. 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: DecisionPackageResponse. client-side declaration; not proof of accepted server payload.

DecisionPackageResponse declared fields:

Field Type Required Description
trace DecisionTrace true —
config_package ConfigPackage 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.listOverrides

GET /api/v1/facility/{facilityId}/rcm/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<ConfigurationOverride>. client-side declaration; not proof of accepted server payload.

ConfigurationOverride declared fields:

Field Type Required Description
id string true —
scope object true —
reason string true —
requested_by UserIdentity | null true —
approved_by UserIdentity | null true —
recorded_at string | null true —
expires_at string | null true —
expired_at string | null true —
has_lapsed boolean true —
review object true —
audit_event_id string | null true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

default.createOverride

approved_by is the approver's approval code for action create.

POST /api/v1/facility/{facilityId}/rcm/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.

request type: object. client-side declaration; not proof of accepted server payload.

default.createOverride.request declared fields:

Field Type Required Description
scope_table string true —
scope_reference string true —
reason string true —
approved_by string true —
expires_at string true —
review_queue_key string true —
review_due_at string true —
actor_role string false —

response type: ConfigurationOverride. 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.expireOverride

POST /api/v1/facility/{facilityId}/rcm/overrides/{overrideId}/expire/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, overrideId. 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.expireOverride.request declared fields:

Field Type Required Description
actor_role string false —

response type: OverrideExpireResponse. client-side declaration; not proof of accepted server payload.

OverrideExpireResponse declared fields:

Field Type Required Description
override ConfigurationOverride true —
routed_to_review_queue string true —
review_due_at string | null true —
audit_event_id 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.completeOverrideReview

POST /api/v1/facility/{facilityId}/rcm/overrides/{overrideId}/complete_review/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, overrideId. 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.completeOverrideReview.request declared fields:

Field Type Required Description
review_note string true —

response type: ConfigurationOverride. 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.listGates

GET /api/v1/facility/{facilityId}/rcm/gates/. 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<DecisionGate>. client-side declaration; not proof of accepted server payload.

DecisionGate declared fields:

Field Type Required Description
id string true —
gate_key string true —
issue string true —
impact string true —
required_evidence string true —
owner_role string true —
owner_user UserIdentity | null true —
status GateStatusName | string true —
blocks_activation boolean true —
blocks_clinical_care false true Always false. A gate blocks activation, never clinical care.
safe_default object true —
work_queue_key string true —
risk_acceptance object true —
resolution object true —
blocking_rows GateBlockingRow[] | null true null means this surface did not resolve them — never "blocking nothing".
blocking_row_count number | null true —
blocking_rows_were_resolved 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.retrieveGate

GET /api/v1/facility/{facilityId}/rcm/gates/{gateId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, gateId. Transport strings are declared here; semantic identifier types require the server contract.

response type: DecisionGate. 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.closeGate

All four closure facts are required; the service refuses anything less. resolved_by (like accepted_by / decided_by below) is the signed-in user's own id, or another person's approval code for this action.

POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/close/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, gateId. 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.closeGate.request declared fields:

Field Type Required Description
resolved_by string true —
resolving_source string true —
closure_test_id string true —
resolution_note string true —
actor_role string false —

response type: DecisionGate. 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.acceptGateRisk

POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/accept_risk/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, gateId. 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.acceptGateRisk.request declared fields:

Field Type Required Description
accepted_by string true —
resolution_note string true —
actor_role string false —

response type: DecisionGate. 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.markGateNotApplicable

POST /api/v1/facility/{facilityId}/rcm/gates/{gateId}/not_applicable/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, gateId. 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.markGateNotApplicable.request declared fields:

Field Type Required Description
decided_by string true —
resolution_note string true —
actor_role string false —

response type: DecisionGate. 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.gateSweep

GATE-01: every already-active row naming a still-open gate.

GET /api/v1/facility/{facilityId}/rcm/gates/sweep/. 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: GateSweepResponse. client-side declaration; not proof of accepted server payload.

GateSweepResponse declared fields:

Field Type Required Description
violations GateBlock[] true —
violation_count number true —
invariant 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.listTraces

GET /api/v1/facility/{facilityId}/rcm/traces/. 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<DecisionTrace>. client-side declaration; not proof of accepted server payload.

DecisionTrace declared fields:

Field Type Required Description
id string true —
decision_kind string true —
subject object true —
outcome string | null true —
amount StatedStringValue true —
currency string true —
config_package ConfigPackage | null true —
weakest_evidence EvidenceStateName | string true —
weakest_evidence_is_activation_grade boolean true —
blocking_gates string[] true —
decided_at string | null true —
engine_version string true —
supersedes ConfigRowReference | null true —
is_append_only true true —
resolution_chain ResolutionChainStep[] false —
resolved_pricing_date string | null false —
pricing_date_rule_used string false —
applied_components string[] false —
consumed_buckets string[] false —
reason_trace ReasonTrace false —
blocking_gate_detail DecisionGate[] false —
explanation_is_structural boolean 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.retrieveTrace

GET /api/v1/facility/{facilityId}/rcm/traces/{traceId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, traceId. Transport strings are declared here; semantic identifier types require the server contract.

response type: DecisionTrace. 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.explainTrace

Explain a claim, a line or an estimate by its subject reference.

GET /api/v1/facility/{facilityId}/rcm/traces/explain/. 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: DecisionTrace. 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.listEndpoints

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/. 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<IntegrationEndpoint>. client-side declaration; not proof of accepted server payload.

A connection endpoint. secret_reference is structurally absent: what this carries is whether a reference is held and who rotates it — enough to operate, nothing to leak (ch. 4, ch. 31 SET-11).

IntegrationEndpoint declared fields:

Field Type Required Description
id string true —
label string true —
environment string true —
is_production boolean true —
endpoint_url string true —
organization object | null true —
profile_package object true —
key_reference object true —
status ConfigStatus | string true —
origin RowOrigin | null true —
certificate CertificateCountdown false —
effective_from string | null false —
effective_to string | null 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.retrieveEndpoint

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. Transport strings are declared here; semantic identifier types require the server contract.

response type: IntegrationEndpoint. 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.endpointCertificate

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/certificate/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. Transport strings are declared here; semantic identifier types require the server contract.

response type: CertificateResponse. client-side declaration; not proof of accepted server payload.

CertificateResponse declared fields:

Field Type Required Description
endpoint ConfigRowReference true —
certificate CertificateCountdown 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.testConnection

Pre-flight only. Nothing is transmitted, in any environment.

POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/test_connection/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. Transport strings are declared here; semantic identifier types require the server contract.

request type: Record<string, never>. client-side declaration; not proof of accepted server payload.

response type: ConnectionTestResponse. client-side declaration; not proof of accepted server payload.

ConnectionTestResponse declared fields:

Field Type Required Description
endpoint IntegrationEndpoint true —
transmitted false true A connection test sends nothing, in any environment.
transmitted_note string true —
certificate CertificateCountdown true —
package_pin PackagePin | null true —
checks IntegrationCheck[] true —
passed 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.replayExchange

Plan an identity-preserving resend. Nothing is transmitted.

POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/replay/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. 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.replayExchange.request declared fields:

Field Type Required Description
exchange string true —

response type: ReplayResponse. client-side declaration; not proof of accepted server payload.

ReplayResponse declared fields:

Field Type Required Description
endpoint ConfigRowReference true —
exchange ExchangeError true —
plan ResendPlan 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.endpointErrors

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/errors/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. Transport strings are declared here; semantic identifier types require the server contract.

response type: PaginatedResponse<ExchangeError>. client-side declaration; not proof of accepted server payload.

ExchangeError declared fields:

Field Type Required Description
id string true —
direction string true —
message_type string true —
status string true —
transport_status string true —
business_status string true —
processing_mode string true —
identity object true —
http_status number | null true —
queued_by_nphies boolean true —
retry_count number true —
next_attempt_at string | null true —
sent_at string | null true —
received_at string | null true —
completed_at string | null true —
issues ExchangeIssue[] true —
validation_results Array<Record<string, unknown>> true —
payload_reference 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.rotateCertificate

secret_reference is a REFERENCE into the secrets manager. The service refuses anything that looks like inline key material.

POST /api/v1/facility/{facilityId}/rcm/integration/endpoints/{endpointId}/rotate_certificate/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, endpointId. 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.rotateCertificate.request declared fields:

Field Type Required Description
change_reason string true —
certificate_subject string false —
certificate_not_after string | null false —
secret_reference string false —
rotation_owner string | null false —
lock_token string false —
actor_role string false —

response type: RotateCertificateResponse. client-side declaration; not proof of accepted server payload.

RotateCertificateResponse declared fields:

Field Type Required Description
path "new_version" | "save_configuration" true —
reason string false —
predecessor ConfigRowReference false —
endpoint IntegrationEndpoint 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.exportIntegration

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/export/. 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: IntegrationExport. client-side declaration; not proof of accepted server payload.

IntegrationExport declared fields:

Field Type Required Description
exported_at string | null true —
facility string true —
key_material_included false true —
endpoints IntegrationEndpoint[] true —
activation 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.activationStates

The seven states and what each permits, for the screen to render.

GET /api/v1/facility/{facilityId}/rcm/integration/endpoints/activation_states/. 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: ActivationStatesResponse. client-side declaration; not proof of accepted server payload.

ActivationStatesResponse declared fields:

Field Type Required Description
states Array<object & StateSemantics> true —
no_shortcut 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.

Pinned source evidence

Links require access to the private source repository.