⌘K

ReferenceReference

Laboratory endpoints

Exact request and response contracts for the laboratory endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description
On this page

Endpoints in this group

GET/v1/labRetrieve the laboratory capability profile

Important

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

GET/v1/lab

Retrieve the laboratory capability profile

Canonical, non-secret capability truth for the laboratory this key belongs to. Certification identifiers (CLIA, CAP) are not modeled in Solia today and are therefore reported as not_modeled rather than claimed, and the identity state is a laboratory self-declaration, never a verification.

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • Required scope: catalog:read. A key without it is refused with 403 forbidden.

Synthetic schema examples are illustrative, not eligible records. Set PROGRAM_ID and ITEM_ID from granted Programs/Catalog, ORDER_ID and RESULT_ID from current responses, and EXTERNAL_SUBJECT_ID to an opaque synthetic reference. Replace body identifiers with authorized records and include patient/provider/question fields only when current requirements request them. Use Sandbox; Production requires separate approval.

cURL

bash
curl -s "$SOLIA_API_BASE/lab" \
  -H "Authorization: Bearer $SOLIA_API_KEY"

Responses

  • 200 — The capability profile.
  • 401 — Missing, invalid, revoked or expired key.
  • 403 — The key lacks catalog:read.
  • 429 — Per-instance client rate limit exceeded; honor Retry-After.
  • 500 — Canonical request failed; reconcile uncertain actions.
  • 503 — Required API configuration is unavailable.
json
{
  "data": {
    "laboratory_id": "00000000-0000-4000-8000-000000000001",
    "display_name": "synthetic",
    "legal_name": "synthetic",
    "operating_name": "synthetic",
    "environment": "sandbox",
    "certifications": {
      "state": "not_modeled",
      "identifiers": [
        "synthetic"
      ]
    },
    "jurisdictions": [
      "synthetic"
    ],
    "service_geography": [
      "synthetic"
    ],
    "collection_methods": [
      "synthetic"
    ],
    "collection_modes": [
      "synthetic"
    ],
    "specimen_categories": [
      "synthetic"
    ],
    "coding_systems_supplied": [
      "synthetic"
    ],
    "reference_range_source": "synthetic",
    "standard_turnaround": "synthetic",
    "clinical_ordering_model": "synthetic",
    "laboratory_identity_state": "declared_laboratory"
  },
  "request_id": "synthetic"
}

Related resources