Managing Halaxy AI templates

Halaxy AI templates control exactly how your AI-generated clinical notes and file summaries are structured. Choose a ready-to-use template from the preset library to get started straight away, or create your own custom template to match your practice's exact documentation style.

Preset AI templates

Halaxy's preset library also includes preset AI templates you can use straight away, covering common clinical, admin, summary and file-summary needs. You can start using any preset AI template as-is, or customise it further to suit your practice. Preset AI templates are grouped into four categories:

  • Scribe - Clinical: Clinical note formats for Halaxy AI Scribe, such as SOAP, BIRP and GPCCMP, plus profession-specific options including psychology intakes and progress note templates.

  • Scribe - Admin: Admin note formats for Halaxy AI Scribe, such as the Default Admin Phone Summary, for capturing key details from admin calls.

  • Clinical Summary: Multi-note summary formats for Halaxy Clinical Summary, such as the Default Multi Note Clinical Summary, General Practitioner Multi Note Clinical Summary, and Surgeon Post-Operative Multi Note Clinical Summary.

  • File Summary: Formats for summarising uploaded files with Halaxy File Summary, such as Pathology Test Summary, NDIS Plan Summary, and Discharge Summary.

Add a preset AI template

  1. Click Settings > Clinical, then click the AI Templates tab.

  2. In the top right, click Add AI Template.

    AI-Scribe-template-01.png
  3. In the pop-up, click the preset template you want to add. It's imported straight away, ready to use.

    AI-Template-01.png

Tip

Can't find the exact structure you need? Customise any preset template, or create your own from scratch using the steps below.

Create your own AI template

If none of the preset templates match what you need, you can build your own custom AI template from scratch.

  1. Click Settings > Clinical, then click the AI Templates tab.

  2. In the top right, click Add AI Template.

    AI-Scribe-template-01.png
  3. In the pop-up, click Create new AI template.

  4. Enter the Template Name and Description, then set Status to Active.

  5. Under Category, select the appropriate category for this template.

  6. Enter your template structure under AI Template Instructions.

    AI-Template-02.png
  7. Click Save.

You have successfully created your custom AI template, which can now be used to transform your session notes or file attachments.

Guidelines for creating AI templates

This section helps you understand how to properly format your AI templates using text elements.

Caution

It is highly recommended that you follow the guidelines below to create an effective AI template. If instructions are written outside brackets, the AI may still process them; however, the formatting may be incorrect and the output inaccurate.

Elements

Description

Example

Structural Labels

Adds regular text to the template, useful for letters or heading titles for structured notes.

Investigations, Diagnosis, Management Plan

Fixed phrases

Applies fixed text to the note without alterations. This can also be added to dictate actual text within the instructions. Enter the text inside quotation marks " ".

"Confidential – For clinical use only"

Contextual Fields

Inserts AI-processed text that grabs the information from the context and transcription. Enter the desired text that the AI should add inside square brackets [ ].

[Insert patient's age and gender]

Behavioural Directives

Directs the AI behaviour on how the text should be processed and displayed according to the written instructions.

Enter the instructions inside round brackets ( ).

(State the primary reason for the consultation, such as symptoms, concerns, or requests.)

Dynamic Terms and Dynamic Data

Inserts patient data according to the information in the patient's profile. These are inside square brackets [ ] by default. See this help guide article for a list of all available dynamic terms.

[Patient Full Name]

Tips for creating AI templates

  • Changing some words can affect output: Using words like "include" can make the model include those words, use similar words like "such as" when giving examples in the past medical history of the CVD template. (E.g. "list medical history including Chronic Kidney Disease, Heart failure" to "list medical history such as Chronic Kidney Disease, Heart failure")

  • Repeating instructions/sections: Asking the model, "Repeat the same for the section above" like in the GP CCMP template, can help reduce work needed for creating templates.

  • Providing examples for the model: Sometimes the model can be provided with an example of how you'd like the output e.g. "Medicine A - 50 MG - Twice Daily and then put this example for illustrative purposes. Do not copy verbatim etc."

  • Using Dynamic Terms: When a dynamic term or dynamic data exists, e.g. [Patient First Name], you can put these in as placeholders so that once you publish the note, they will auto-populate and you don't have to put in context or say the patient's name.

Set a default AI template

Setting a default template for each AI tool helps speed up your AI automation by automatically selecting the correct template to use.

  1. Navigate to Settings > General.

  2. Under the AI Settings sections, click the Icon-Edit.svg pencil icon for Default AI templates.

  3. In the pop-up, select a template under the dropdown for the desired AI tool.

Caution

If you do not see the AI template you want to use in the dropdown list, the template may be Inactive or belong to another category. You can review your templates in Settings > Clinical > AI Templates tab.

Updated

Was this article helpful?