v1

latestOpenAPI 3.0.02026-07-26550199.6 KB

patient-form

Get a single patient-form

Get patient-form data by id

get/patient-forms/{id}

Path parameters

idinteger required

Example:1

Response

Object with patient-form data.

idinteger required

Patient Form Id

titlestring

Form Title

uuidstring uuid

uuid

brandingColorstring nullable

Branding color

headerImagestring nullable

Link of the image

contentstring

Content of form

submittedMessagestring nullable

Submitted message

patientIdinteger required

Patient id

organisationIdinteger required

Organisation id

appointmentIdinteger nullable required

Appointment id

status'Incomplete' | 'In progress' | 'Completed'

Status

templateIdinteger nullable required

Template id

archivedboolean nullable

Whether the patient form has been archived

Example response

{
  "id": 1,
  "title": "Form Title",
  "uuid": "e2753e11-22a2-4886-be76-df5113632f0d",
  "brandingColor": "blue",
  "headerImage": "https://sampleImage.com",
  "content": "[{\"title\":\"Section title\",\"questions\":[{\"type\":\"Paragraph\",\"title\":\"Paragraph title\",\"answerText\":\"\"}]}]}]",
  "submittedMessage": "Message",
  "patientId": 1,
  "organisationId": 1,
  "appointmentId": 1,
  "status": "Completed",
  "templateId": 1
}