Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
integer
required
Required range: x > 0

Response

200 - application/json
id
integer
required

Patient Form Id

Required range: x > 0
submittedAt
required

Submitted time in YYYY:MM:DD HH:mm:ss format

patientId
integer
required

Patient id

Required range: x > 0
organisationId
integer
required

Organisation id

Required range: x > 0
appointmentId
integer | null
required

Appointment id

Required range: x > 0
templateId
integer | null
required

Template id

Required range: x > 0
createdAt
required

Object creation date time

updatedAt
required

Object update date time

title
string

Form Title

uuid
string

uuid

brandingColor
string | null

Branding color

headerImage
string | null

Link of the image

content
string

Content of form

submittedMessage
string | null

Submitted message

status
enum<string>

Status

Available options:
Incomplete,
In progress,
Completed