Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Programs endpoints

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

Machine-readable OpenAPI description

Endpoints in this group

GET/v1/programsList programs this key may order from
GET/v1/programs/{programId}Retrieve one program
GET/v1/programs/{programId}/catalogList orderable tests in a program
GET/v1/programs/{programId}/requirementsDiscover what an order must carry

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

GET/v1/programs

List programs this key may order from

Authentication & scope

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

Responses

  • 200 — Granted programs.
  • 403 — The key lacks programs:read.
json
{
  "data": [
    {
      "program_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
      "name": "string",
      "status": "string",
      "environment": "sandbox",
      "currency": "string"
    }
  ],
  "request_id": "string",
  "cursor": "string"
}

GET/v1/programs/{programId}

Retrieve one program

Authentication & scope

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

Path parameters

  • programId (required) — string (uuid). Program identifier.

Responses

  • 200 — The program.
  • 404 — Unknown or ungranted program.
json
{
  "data": {
    "program_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
    "name": "string",
    "status": "string",
    "environment": "sandbox",
    "currency": "string"
  },
  "request_id": "string",
  "cursor": "string"
}

GET/v1/programs/{programId}/catalog

List orderable tests in a program

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.

Path parameters

  • programId (required) — string (uuid). Program identifier.

Responses

  • 200 — Orderable tests.
json
{
  "data": [
    {
      "item_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
      "lab_orderable_id": "1c9d5b70-3f42-4a51-8d0e-77b6c2419f83",
      "lab_test_code": "string",
      "code": "string",
      "description": "string",
      "external_code": "string",
      "name": "string",
      "kind": "string",
      "performing_laboratory": "string",
      "specimen_type": "string",
      "container": "string",
      "min_volume_ml": 1
    }
  ],
  "request_id": "string",
  "cursor": "string"
}

GET/v1/programs/{programId}/requirements

Discover what an order must carry

Reports the laboratory's governed ordering requirements. A facet the laboratory has not configured is reported as not_configured and requires nothing.

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.

Path parameters

  • programId (required) — string (uuid). Program identifier.

Query parameters

  • item_id (optional) — string (uuid)
  • region (optional) — string

Responses

  • 200 — The governed requirement profile.
  • 404 — Unknown program for this key.
json
{
  "data": {
    "program_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
    "item_id": "1c9d5b70-3f42-4a51-8d0e-77b6c2419f83",
    "jurisdiction": "string",
    "environment": "sandbox",
    "subject": {
      "mode": "opaque_reference",
      "required_patient_fields": [
        "string"
      ],
      "authority_state": "configured"
    },
    "order": {
      "required_fields": [
        "string"
      ],
      "authority_state": "configured"
    },
    "provider": {
      "requirement": "not_required",
      "required_fields": [
        "string"
      ],
      "authority_state": "configured",
      "license_authority_state": "not_modeled"
    },
    "aoe": {
      "authority_state": "configured",
      "questions": [
        {
          "question_key": null,
          "prompt": null,
          "answer_type": null,
          "options": null,
          "required": null,
          "version": null
        }
      ]
    },
    "clinical": {
      "policy": "string",
      "ordering_model": "string",
      "clinical_review": "string",
      "intake_required": true,
      "requirement_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
      "requirement_state": "configured"
    },
    "collection": {
      "methods": [
        "string"
      ],
      "regions": [
        "string"
      ]
    },
    "billing": {
      "mode_required": true,
      "authority_state": "configured"
    }
  },
  "request_id": "string",
  "cursor": "string"
}