Nookal Integration Setup
Snapforms allows clinics and allied health practitioners to create secure digital forms for patient registration, intake, referrals, signed consent, assessments and more.
With the Nookal practice management integration, Snapforms can automatically add and update patient files in Nookal using the information provided in your patients’ form responses.
| In this guide: |
How does the Nookal integration work?
- When a patient submits a completed form, it’s automatically synced to their file in your Nookal account.
- Got a new patient? No problem! Once they submit an intake, registration, or referral form, a new patient file is automatically created in your Nookal account with all their details filled in.
- Existing patient files can also be automatically updated via forms that are connected to Nookal.
- For both new and existing patient files, a PDF copy of the form is saved in their Nookal patient file.
How to set up the Nookal integration
Before you start
This guide assumes you’ve already created your online form using the drag-and-drop form builder. Please ensure your form has all the fields required for adding and updating patient files in Nookal.
If you’re new to Snapforms, we recommend you check out our 10-minute getting started video or have a look through our help guides to learn how to set up your form.
Obtain a Nookal API key
To connect Snapforms to Nookal, you will need to generate a new API key in your Nookal account. Please refer to Nookal’s help article for instructions.
Once you’ve obtained the API key, log into Snapforms and configure the following integration settings on your form.
Enable Nookal integration and link account
- Open your form edit mode.
- Navigate to the Form Settings tab > Integrations.
- Select the Nookal checkbox.
- If this is the first connection, click the click here link to display the API Key field.
- Paste your Nookal API key, then click Save. This API key is now saved and can be used across different forms.
- Enable the integration actions you require:
| Action | Description |
| Create a new Nookal patient from form response if one doesn’t already exist | Creates new patient files in Nookal using the mapped fields from the form responses. |
| If a patient exists in Nookal update their details with the answers from this form | Updates existing patient files in Nookal using the mapped fields from the form responses. |
| Attach a PDF document to the Nookal patient file | Attaches a PDF document that looks exactly like your online form (including the responses populated within the fields) to the patient file in Nookal.
If you prefer to design your own PDF template or use a pre-made fillable PDF, click Add/edit PDF templates for this form (blue link) and follow the instructions in the PDF templates guide.
|
| Send all uploaded files from form response to Nookal |
Sends all files uploaded (via the File Upload field) in form responses into the documents section of the associated patient profile in Nookal. |
Set up basic field mapping
- In the Field Mapping section, select the form fields that correspond with each of the Nookal fields. For example, link your ‘First Name’ field to ‘First Name’, ‘Last Name’ to ‘Last Name’, and so on. Note: First Name, Last Name, and Date of Birth are the minimum required mappings. For greater accuracy of data matching, you can add more field mappings.
- To add more field mappings, click Add Another Field, then select the form field from the list and map to the corresponding Nookal field.
- Set your Nookal API Region.
- To start syncing all submissions to Nookal, scroll to the top and click Save.
Advanced customisation
Mapping Nookal custom fields
If you’ve set up custom fields in Nookal, you can include them in the integration field mappings by selecting the Add Custom Field button. This will add a free text field that allows you to enter the Nookal custom field name.
Syncing two form field responses to one Nookal client field
To sync two form field responses into one Nookal field, map the desired form fields to the same Nookal destination, as shown in the example below:
Using conditional logic to run integration
Instead of syncing every submission, you can apply conditional logic that triggers the integration only when specific criteria are met. This allows you to filter syncs based on responses or completion of workflow steps.
To control when the integration runs:
- Tick the Run only when responses match these conditions.
- Choose to run the integration if All or Any conditions match.
- Select a form field, or a workflow step (if configured).
- Select an operator, e.g. is, is blank, greater than, etc. Note: This list will vary depending on the selected field type.
- Enter a specific answer required to trigger the integration.
Troubleshooting
If your data isn’t appearing in Nookal as expected, check the Response Activity Logs for errors and retrigger the sync.