Create a new referral

post

https://clinician-profile-service.tacklit.com/apis/accounts/{accountId}/referrals

Create a new referral. Requires an x-api-key with write access scoped to Referrals.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

The unique identifier of the secure Tacklit Workspace.

Body Params

date

required

Referral date, YYYY-MM-DD.

status

string

enum

required

Use "new" for a fresh inbound referral (untriaged). The other values are pipeline states set later in Tacklit.

reason

string | null

Optional for standard accounts. (Only enforced on some statuses for ProCare/Here Toitu accounts.)

detail

string | null

presentingIssues

array of strings | null

Free-text array; not enum-validated by the API. Suggested values: Anxiety, Substance issues, Adjustment issues, Behavioural issues, Eating issues, Gender Identity, Grief & Loss, Health issues, Low mood/Depression, Relationship difficulties, Self-harm, Sleep Issues, Stress, Suicidal ideation, Trauma, Mood disorder, Parenting issues, Perinatal/Postpartum, Psychosis, Childhood/Family origin issues, OCD, Other.

presentingIssues

expiryDate

date | null

referrer

object

required

The referring party. No sub-field is strictly required by the API, but send as much as the OCR can read (at minimum a name and, for GPs, providerNumber).

subject

object | null

The patient the referral is about. Optional, but strongly recommended for patient matching. Matching currently keys on email, so supplying a reliable email (and DOB) reduces duplicate client records.

clientRecordId

string | null

Optional. Link the referral to an existing client record instead of creating a new one.

generalPractitionerId

string | null

Optional. Tacklit address-book id of the referring GP, if already known.

org

object | null

emergencyContact

object | null

Optional. When the referral is linked to / creates a client, this is added as a key client contact tagged 'Emergency Contact'.

funder

object | null

Funding source for this referral.

packages

array of objects | null

packages

apiAttachments

array of strings | null

Array of file URLs (e.g. the source referral PDF).

apiAttachments

apiNotes

array of strings | null

Free-text notes; each is added to the referral as a system note.

apiNotes

rdf

array of objects | null

Referral data fields: values mapped into the account's referral/CDF categories. Use categoryId + variableId from the categories reference Tacklit provides. NOTE: persistence of rdf value requires a pending Tacklit service update - confirm with Tacklit before relying on rdf for structured values.

rdf

isAddToAddressBook

boolean | null

Optional. If true, adds the referrer to the account address book.

code

string | null

apiSubmission

object | null

Optional. Correlate this submission back to your system.

Headers

x-api-key

string

required

Responses

403

Invalid or missing x-api-key, or key not scoped to Referrals write.

404

Resource not found

201Referral created successfully

400Bad request (validation error or invalid referral date)