Patient Form Template

PatientFormTemplate

archived_at	string or null <date-time>
	object or null
created_at	string <date-time>
email_to_patient_on_completion	boolean or null
id	string <int64>
	object
name	string <= 255 characters
restricted_to_practitioner	boolean or null
updated_at	string <date-time>

{"archived_at": "2019-08-24T14:15:22Z",
"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"email_to_patient_on_completion": true,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
},
"name": "string",
"restricted_to_practitioner": true,
"updated_at": "2019-08-24T14:15:22Z"
}

List patient form templates

get/patient_form_templates

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
id	int64
archived_at	date-time
created_at	date-time
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"patient_form_templates": [{"archived_at": "2019-08-24T14:15:22Z",
"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": null,
"type": null,
"required": null,
"answer": null,
"answers": [ ],
"other": { }
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"email_to_patient_on_completion": true,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
},
"name": "string",
"restricted_to_practitioner": true,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates?page=2",
"previous": "https://api.au1.cliniko.com/v1/patient_form_templates?page=1",
"next": "https://api.au1.cliniko.com/v1/patient_form_templates?page=3"
}
}

Create patient form template

post/patient_form_templates

SecuritybasicAuth

Request

Request Body schema: application/json

	object or null
email_to_patient_on_completion	boolean or null
name	string <= 255 characters
restricted_to_practitioner	boolean or null

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"email_to_patient_on_completion": true,
"name": "string",
"restricted_to_practitioner": true
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"email_to_patient_on_completion": true,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
},
"name": "string",
"restricted_to_practitioner": true,
"updated_at": "2019-08-24T14:15:22Z"
}

Get patient form template

get/patient_form_templates/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"email_to_patient_on_completion": true,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
},
"name": "string",
"restricted_to_practitioner": true,
"updated_at": "2019-08-24T14:15:22Z"
}

Update patient form template

patch/patient_form_templates/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

	object or null
email_to_patient_on_completion	boolean or null
name	string <= 255 characters
restricted_to_practitioner	boolean or null

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"email_to_patient_on_completion": true,
"name": "string",
"restricted_to_practitioner": true
}

Response samples

application/json

{"archived_at": "2019-08-24T14:15:22Z",
"content": {"sections": [{"name": "string",
"description": "string",
"questions": [{"name": "string",
"type": "checkboxes",
"required": true,
"answer": "string",
"answers": [{"value": null
}
],
"other": {"enabled": true
}
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"email_to_patient_on_completion": true,
"id": "1",
"links": {"self": "https://api.au1.cliniko.com/v1/patient_form_templates/1"
},
"name": "string",
"restricted_to_practitioner": true,
"updated_at": "2019-08-24T14:15:22Z"
}

Archive patient form template

post/patient_form_templates/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby