v1.8.0 New isNewPatient field added to booking requests

This minor release added a new 'isNewPatient' boolean field to our booking request payloads.

This field indicates whether the patient has claimed to be new to the practice while completing the booking form.

v1.7.0 Practice consent authentication method

This minor release finalised the new practice consent method, replacing the now deprecated OAuth 2.0 authentication flow.

Practices are able to log in to our Practice Admin product, navigate to Account → Integration Consent, and consent to your vendor having access to their data via this API.

This authentication method is covered in detail in the 'authentication and practice onboarding' section of the quick start guide.

v1.6.0 Attach documents extra feature

This minor release added a new optional attach documents extra feature.

This feature allows you to get pending documents from Healthengine to be inserted and attached to a patient in your PMS, so they are available to practice staff. These documents are provided by the patient for products such as New Patient Forms, Referrals, and more to come.

If you choose to support this feature, you can enable it for an integrated practice by calling POST features/attachDocuments/enable. To support this feature, your integration should perform the following:

• Retrieve pending attach document requests via GET /requests/attachDocuments by polling and/or subscribing to webhooks
• Retrieve document content for an attach document request via GET attachDocuments/{requestId}/content
• Confirm or reject the attach document request via POST attachDocuments/{requestId}/confirmInsert or POST attachDocuments/{requestId}/rejectInsert