Variables
A variable is a flexible part of an option, one which can take on different values.
Variables are useful for options where you don't know in advance how every aspect should be completed. They make it easier to configure your templates for even quicker patient note creation.
- An option can contain multiple variables.
- Variables can be optional or required. Required variables must be completed (or deleted) before you submit your note.
- Variables can be completed either from a list of predefined candidates, or via free text entry.
Setting up a variable
The easiest way to set up a variable is to ask us to do it for you. Send us your request and we will set the variable up within your template.
Syntax:
If you are comfortable writing accurate syntax, you can set the variable up yourself as follows:
| Purpose | Syntax | Position |
| Start variable | ** | Start of variable |
| Close variable | ** | End of variable |
| Start option | << | Start of option |
| End option | >> | End of option |
| Selection | $$selected | Before the closing >> of an option |
| Required | $$required | Before the closing ** of the syntax |
| Free text variable | $$text | Between << and >> |
Examples:
To be able to add free text to an option, the syntax would be:
Medial femoral condyle **<<$$text>>**
To be able to choose a grade (1-3) for an option, the syntax would be:
Medial femoral condyle **<<grade 1>><<grade 2>><<grade 3>>**
To make grade 2 selected, the syntax would be:
Medial femoral condyle **<<grade 1>><<grade 2$$selected>><<grade 3>>**
To make the variable required, the syntax would be:
Medial femoral condyle **<<grade 1>><<grade 2>><<grade 3>>$$required**
Important: When completing a patient note, if you edit the text of an option which contains a variable, you will lose the variable functionality. The option becomes normal text, just as it will appear on the PDF.