GET/transactional-api/inbound-referral-metadata

Get Inbound Referral Metadata

Returns the active commissioned services for this tenant and the fixed list of valid MHSDS referral reasons, plus the active clinical case types. Use the returned IDs/values when calling the create-inbound-referral endpoint. Clinical case types include a flag indicating whether a commissioned service must be provided.

Authorization: Bearer token (JWT). See Authentication.

Responses

200 Metadata retrieved successfully.

{
  "commissionedServices": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "serviceIdentifier": "string"
    }
  ],
  "referralReasons": [
    {
      "value": "string",
      "label": "string"
    }
  ],
  "clinicalCaseTypes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "requiresCommissionedService": false
    }
  ]
}