← Knowledge library

IT & integrations

Start an integration from the deployed API contract

Use the current schema, facility scope and documented pagination instead of guessing endpoints.

Current source · source reviewed · 7 min read

Before you begin

1. Inspect the deployed schema

The core defines api/schema, swagger and redoc routes when enabled by its URL configuration. Use the deployment’s actual schema to confirm operations, fields, authentication and feature availability.

2. Confirm facility and resource scope

RCM resources are facility-scoped. Use the authorized facility identifier and verify object relationships; possession of another resource ID is not a permission grant.

3. Read list responses correctly

The default pagination class returns count and results, uses limit/offset semantics and caps limit at 200. Endpoint-specific actions can use different response shapes; follow the actual schema.

4. Validate requests and preserve evidence

Handle structured errors, field/value states, lock tokens and operation-specific idempotency. Keep source identifiers, request keys and correlation IDs in protected logs.

5. Prove a complete test transaction

Run synthetic happy and failure cases against the intended version, including authentication expiry, empty pages, validation errors and duplicate retries before operational handoff.

No universal integration claim

Current NPHIES builders do not imply a generic FHIR clinical server. Backend and frontend plugins also have their own contracts rather than one universal external integration surface.

Public-safe support

Share schema paths, error codes and synthetic examples. Do not publish credentials, internal deployment hostnames or patient payloads.

Troubleshooting

An endpoint shown in a guide is missing

Check the deployed version, feature/entitlement state and actual schema with the installation owner. Do not substitute an unrelated legacy endpoint.

Source evidence

References are pinned to the private MANSOQ source repository. Repository access is required to open these links.