Skip to main content
POST
/
med-cases
/
{id}
/
referrals
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceNumber": "<string>",
    "medCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "providerLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "doctorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentReferralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "notes": "<string>",
    "internalNotes": "<string>",
    "rejectionReasonNote": "<string>",
    "withdrawnNote": "<string>",
    "closedNote": "<string>",
    "acknowledgedAt": "2023-11-07T05:31:56Z",
    "respondedAt": "2023-11-07T05:31:56Z",
    "treatmentStartedAt": "2023-11-07T05:31:56Z",
    "treatmentCompletedAt": "2023-11-07T05:31:56Z",
    "closedAt": "2023-11-07T05:31:56Z",
    "withdrawnAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Path Parameters

​
id
string<uuid>
required

Med case UUID

Body

application/json

Creates a new referral on the med case. The provider must be in your network (an ACTIVE FirmProviderConnection); otherwise the request returns 403.

​
providerId
string<uuid>
required

UUID of the provider to refer to (required). Must be in your network.

​
providerLocationId
string<uuid> | null
​
doctorId
string<uuid> | null
​
notes
string

Response

Created med referral

​
data
object
required
​
meta
object
required