Patient Data
Access patient-specific data such as intent status and custom properties. These endpoints use the shop customer ID and shop identifier to identify patients.Check Patient Intent
Query whether a patient has completed a specific intent (e.g., a questionnaire submission).Example Request
Response
return_code indicates when the patient last completed a signed submission for the given intent.
Get Patient Property
Retrieve a specific property value for a patient.The property field name to retrieve. You can find the field key in the admin tool under Settings > Profile Fields — use the key value shown for each field.
Example Request
Set Patient Property
Set or update a property value for a patient.Request Body (form-data)
Example Request
Patient properties are custom fields defined per organisation. You can configure available property fields in the Settings > Profile Fields section of the admin tool.