Payerbox Docs

CDS Services Discovery

Returns the list of CDS Services available on this server, as defined by the CDS Hooks 2.0 Discovery endpoint. Payerbox advertises its CRD hooks here, with their prefetch templates and usage requirements.

Defined as part of CDS Hooks 2.0 and used by Payerbox for CRD.

Endpoint

GET <base>/cds-services

Auth

Discovery is unauthenticated per CDS Hooks spec — EHRs fetch the service list before configuring credentials. Hook invocations themselves require SMART Backend Services; see Authentication.

Response Fields

FieldTypeDescription
servicesarrayArray of available CDS Service definitions
services[].idstringUnique identifier for this CDS Service
services[].hookcodeThe hook this service should be invoked on (e.g., order-sign, order-select)
services[].titlestringHuman-readable name of this service
services[].descriptionstringDescription of what this service does
services[].prefetchobjectKey/value pairs of FHIR queries for prefetch data
services[].usageRequirementsstringHuman-readable description of any preconditions for using this service

Example

GET /cds-services
Accept: application/json
{
  "services": [
    {
      "id": "order-sign-crd",
      "hook": "order-sign",
      "title": "CRD Prior Authorization (Order Sign)",
      "description": "Provides final prior authorization determination when orders are being signed",
      "prefetch": {
        "patient": "Patient/{{context.patientId}}",
        "encounter": "Encounter/{{context.encounterId}}",
        "coverage": "Coverage?patient={{context.patientId}}&status=active"
      },
      "usageRequirements": "Requires context.patientId and at least one order in context.draftOrders"
    }
  ]
}

Last updated: