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.

Response fields

Field	Type	Description
`commissionedServices[].id`	`string<uuid>`
`commissionedServices[].name`	`string`
`commissionedServices[].serviceIdentifier`	`string`	External human-readable identifier for the commissioned service.
`referralReasons[].value`	`string`	Pass this as reasonForReferral.
`referralReasons[].label`	`string`
`clinicalCaseTypes[].id`	`string<uuid>`
`clinicalCaseTypes[].name`	`string`
`clinicalCaseTypes[].requiresCommissionedService`	`boolean`	When true, a commissionedServiceId must be provided when creating an inbound referral with this case type.

{
  "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
    }
  ]
}

Responses​

Responses