Managing Halaxy AI templates

Create your own AI template

On top of the preset AI templates, you can also create a custom AI template that is tailored exactly to what you want Halaxy AI Scribe or Halaxy AI File Summary to generate.

  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. You can also select a template from the list under Preset Library, which you can edit.

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

  5. Under Category, choose Scribe if this template is for Halaxy AI Scribe or File Summary for Halaxy AI File Summary. Choose the appropriate category for the template:

  6. Under AI Template Instructions, enter your template structure and prompts.

    AI-Scribe-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?