⌘K

PlatformGuide

Integrations

Operate the laboratory connection, Partner API, validation and delivery monitoring from one workspace.

On this page

Sections

  • Overview: the state of this workspace's integrations.
  • Lab Test API: the partner-facing API surface for this laboratory.
  • API clients: register clients, grant program access, issue keys.
  • Webhooks: endpoints, event catalog, delivery logs.
  • Laboratory connection: LIS/LIMS order and result interfaces.
  • Validation and Activity: readiness checks and integration health.

Integrations is where you perform integration actions. This documentation site is where the concepts and contracts are explained.

Select the workspace and environment first

Confirm the laboratory workspace and Sandbox or Production label before opening a client, connection or delivery. Those labels select an authorization boundary, not just a display filter. A connection configured in Sandbox supplies no Production evidence.

  • Open Overview to identify the recorded state and missing evidence; then follow the existing next action to the affected connection, validation or activity view.
  • If a read fails or is refreshing, retain no positive readiness conclusion. Refresh and inspect the error before attempting another action.
  • Lab Admin owns laboratory connection changes. Operations may contribute technical details but cannot save owner-facing connection configuration. Server-side checks, not a visible control, decide permission.
  • Connection groups Overview and Laboratory connection; Testing & Validation groups scoped proof and diagnostic history; Activity & Monitoring groups events and exceptions; Developer Resources groups the partner-facing API, keys and Webhooks. Display access is not configuration or Production approval.

Step 5 laboratory discovery and IT handoff

Laboratory connection is the laboratory-facing order/result interface, separate from the partner-facing Lab Test API. In Step 5, select the system and supported path, record product/version and interface requirements, and use the managed request when the path needs assistance. Identified, requested and reviewed are distinct from installed and operational.

  • Direct HTTPS/JSON uses the configured solia.lab.v1 adapter and environment-specific authentication. Sandbox completion requires correlated order, acknowledgement and result evidence, not only a health response.
  • Native REST, FHIR, HL7/MLLP and SFTP packages are source-delivered candidates with disabled execution gates. Vendor selection does not provision an endpoint or certify a vendor.
  • An outbound Edge installation for a private LIS needs laboratory IT approval, the exact approved destination and secure custody. No inbound scanning or remote shell is authorized. Managed requests track assistance, not a live interface.
  • Mapping preview is bounded dictionary authoring. Saving requires separate governed authority; independent clinical review requires an authorized reviewer distinct from the author. A local preview or unavailable save is not persisted approval.
  • Send IT protocol/version, approved network requirements and nonsecret mapping references. Never put passwords, signing secrets, patient payloads or private keys in the handoff.

Partner clients, Program grants and webhooks

  • Register the client in the selected environment. Assign only the intended Program grants and credential scopes; a Program listing alone does not authorize orders.
  • Issue a key only through the authorized server action. Copy the one-time value to approved server-side custody; a browser, documentation sample or remembered key label cannot recover it.
  • Production issuance requires its own current eligibility and authorization; replacing a Sandbox key is not a go-live procedure.
  • Configure the permitted public HTTPS webhook URL in Webhooks, select canonical event types, protect the one-time signing secret, then inspect delivery logs. Laboratory credentials and webhook signing secrets are different credentials.
  • Use the API Reference and downloaded Postman resources for exact methods, paths and schemas. Resolve resource identifiers from authorized reads rather than using synthetic example identities.

Diagnostics, URL actions and incident triage

Use existing connection health, Validation, Activity and logs destinations to inspect contract version, environment, timestamps, safe error codes and correlation references. An endpoint URL is configuration, not proof of successful delivery; public HTTPS validation also does not establish clinical acceptance.

  • Locate the affected order or delivery in the same workspace/environment and preserve its request or correlation reference.
  • Compare queue state, transport receipt, application acknowledgement and result release separately. Do not treat a timeout as rejection or an ACK as final release.
  • Use supported suspension/revocation actions only with the required authority; preserve the original journal and ask the responsible operator to reconcile ambiguous delivery before any resend.
  • Escalate read failures or missing authority with safe references, not raw payloads or credentials. Do not invent a replacement endpoint or activate a disabled native path.

Related resources