Add a clinical note

Records a clinical note against the patient, attributed to your organisation and the
API key that wrote it. serviceId must be one of the services your organisation
offers (400 unknown_service otherwise). text is required and is stored up to 4000
characters — anything longer is truncated. The note is visible to the member and to
your portal users, never to other providers. The action is recorded in your activity
log.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The patient's identifier, as returned by the bookings and patients endpoints. Opaque — treat it as a string.

Body Params
string
required

The service the note relates to. Must be one of the services your organisation offers (see GET /api/v1/availability).

string
required

The note text. Required and non-blank; stored up to 4000 characters (longer text is truncated).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json