Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patientId
string<uuid>
required

The id of the patient in question A universally unique identifier.

Example:

"29ea9012-c622-4851-a57a-9327abd21198"

Query Parameters

notes
enum<string>[]
required

Comma-separated list of note types to include

Available options:
ASYNC_CONSULTATION,
CLINICAL_RX_RECOMMENDATION,
FOLLOW_UP_ASYNC_CONSULTATION,
FOLLOW_UP_CLINICAL_RX_RECOMMENDATION,
FOLLOWON_ASSESSMENT,
FOLLOWUP_HQV3,
HEALTH_COACH_QUARTERLY_NOTE,
INITIAL_HQV3,
INTAKE_ASSESSMENT,
INTAKE_PLUS_CLINICAL_ASSESSMENT,
INTERNAL_CLINICAL_NOTE,
LIFESCORE
Example:

"FOLLOW_UP_CLINICAL_RX_RECOMMENDATION,HEALTH_COACH_QUARTERLY_NOTE"

take
integer<int32>

The number of notes to return

locked
boolean

Whether to return only locked notes

Response

Successful response

data
object[]