v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Patient Form

Create patient form

When creating a patient form with a patient_form_template_id, the values for name, content, and restricted_to_practitioner will be pulled from the template. However, you may provide any of those values to override the template, or even provide all of your own values and exclude the patient_form_template_id altogether.

post/patient_forms

Request body

attendee_idstring int64

attendee id

business_idstring int64

business id

completedboolean

email_to_patient_on_completionboolean nullable

expiredboolean nullable

patient_idstring int64

patient id

patient_form_template_idstring int64

patient form template id

namestring

restricted_to_practitionerboolean nullable

Example request

{
  "attendee_id": "1",
  "business_id": "1",
  "patient_id": "1",
  "patient_form_template_id": "1",
  "content": {
    "sections": [
      {
        "questions": [
          {
            "custom_field_token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70"
          }
        ]
      }
    ]
  }
}

Response

Resource was created

archived_atstring date-time nullable

completed_atstring date-time nullable

created_atstring date-time

edited_atstring date-time nullable

email_to_patient_on_completionboolean nullable

expiredboolean nullable

expires_atstring date-time nullable

idstring int64

namestring

restricted_to_practitionerboolean nullable

updated_atstring date-time

urlstring uri nullable

Example response

{
  "attendee": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/attendees/1"
    }
  },
  "booking": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/bookings/1"
    }
  },
  "business": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/businesses/1"
    }
  },
  "content": {
    "sections": [
      {
        "questions": [
          {
            "custom_field_token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70"
          }
        ]
      }
    ]
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_forms/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_form_template": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
    }
  },
  "signatures": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_forms/1/signatures/112233"
    }
  }
}