ClinicOffice Support Forum • View topic - FAQ 303: Customising Appointment Captions in the Diary

FAQ 303: Customising Appointment Captions in the Diary

Frequently Asked Questions relating to ClinicOffice v4 and v5
Forum rules
*** NOTE: This is our OLD FORUM WEBSITE *** Please go to https://pioneersoftware.co.uk/forums

FAQ 303: Customising Appointment Captions in the Diary

Postby Support » February 28th, 2013, 5:25 pm

We sometimes get asked if it's possible to fully customise "auto-description" captions for appointments in the diary - to which the answer is: YES!

Firstly, please follow these instructions :-
    - Go to the diary and click the DIARY OPTIONS button (top right)
    - Click the "Visual Settings" tab
    - Notice there are 2 caption formats; one for "staff view" and one for "room view"... these are the boxes you will be editing
There are six standard 'merge fields' available, as follows :-

{patient} = the name of the patient/contact attending the appointment
{type} = the appointment type (e.g. "Consultation")
{status} = the status of the appointment (e.g. "Arrived")
{clinic} = the name of the clinic where the appointment is booked (usful for multi-site clinics)
{staff} = the name of the practitioner involved in the appointment
{room} = the room that the appointment is booked in

For sake of argument, let's say we're working in the STAFF VIEW. The default caption format is :-
Code: Select all
{patient} [{type}] in {room}

This displays the patient's name, then the type of appointment, then the room e.g.
Code: Select all
Bloggs, Joe [Consultation] in Room 1

But what you if you want to add information from a different field? Please read on...


Constructing Custom Merge Field Codes
'Merge field' codes are all enclosed in curly braces i.e. {...} For custom merge field codes, THREE parts are required inside the braces :-
[1] The database table name
[2] The field which is displayed
[3] Mapping information for mapping the information to this appointment

Each of the above is separated by an exclamation mark character i.e. "!".

For example, say we have added a custom field to our patient database called "my_text_field". To add this field to the caption, we would need to add the following 'merge field' code to the caption format :-
{custom_patient_fields!my_text_field!per_id=@per_id}

Hence the final caption format would be something like :-
Code: Select all
{patient} [{type}] in {room} - {custom_patient_fields!my_text_field!per_id=@per_id}

[1] The database table = "custom_patient_fields"
[2] The field name = "my_text_field"
[3] The "per_id" field in the "custom_patient_fields" table is mapped to @per_id which is the per_id of the appointment

This would result in :-
Code: Select all
Bloggs, Joe [Consultation] in Room 1 - some custom info


A Note About Performance

Including additional custom fields in the auto-generated captions WILL affect performance because ClinicOffice will have to perform an additional database lookup for every appointment that is displayed in the diary.


If you're non-technical, then this is obviously going to be quite difficult to follow so please feel free to post a reply with more information about what you're trying to achieve and we'll be happy to help!
ClinicOffice Support Team
User avatar
Support
Site Admin
 
Posts: 888
Joined: August 25th, 2005, 6:37 pm

Re: FAQ 303: Customising Appointment Captions in the Diary

Postby clinicoffice_user » July 24th, 2013, 10:17 am

Hi - I run a domiciliary clinic - please can you tell me how to format the labels as follows :-

23/07/2013 09:00-10:00 Nail Extraction - Mrs Smith (Sue) - 12 Long Hurst Rd Crawley RH11 0TB 01903 12345

I want to show :-
DateTime - Appointment Type - Patient - Patient Address - Patient Telephone - Status
clinicoffice_user
 
Posts: 56
Joined: July 20th, 2009, 8:47 am

Re: FAQ 303: Customising Appointment Captions in the Diary

Postby Daniel Casserly » July 24th, 2013, 10:43 am

Hi - thanks for your post. Please follow these step-by-step instructions :-

  • Go to the Diary and click on the Diary Options button (above the diary on the right)
  • Click on the Visual Settings tab
  • Under Appointment Captions you will see two options - Caption format for staff view and Caption format for Room View. Click the [Advanced] link next to the "Caption format for staff view"
  • Copy and Paste in the below code, click OK and then OK again to save the changes.
Code: Select all
{type} - {patient} - {per!address1!id=@per_id} {per!towncity!id=@per_id} {per!postcode!id=@per_id} {per!telephone!id=@per_id} {status}

You may need to click the Refresh button to refresh the diary and see the updated appointment labels.

Please let us know how you get on.
ClinicOffice Support Team
User avatar
Daniel Casserly
 
Posts: 49
Joined: May 25th, 2010, 3:34 pm

Re: FAQ 303: Customising Appointment Captions in the Diary

Postby dyerstchiro » February 10th, 2015, 4:35 pm

Hi all,

With regards to putting in the number, when I place in the code only the home telephone number appears. Is there a way to change this to a mobile number?

Many thanks

Rob.
dyerstchiro
 
Posts: 15
Joined: May 20th, 2014, 6:17 pm

Re: FAQ 303: Customising Appointment Captions in the Diary

Postby Mat Larkin » February 11th, 2015, 8:38 am

Hi there,

Please use this code to use mobile number instead of telephone number;

Code: Select all
{type} - {patient} - {per!address1!id=@per_id} {per!towncity!id=@per_id} {per!postcode!id=@per_id} {per!mobile!id=@per_id} {status}


Thanks!
ClinicOffice Support Team
www.pioneersoftware.co.uk
User avatar
Mat Larkin
 
Posts: 208
Joined: January 11th, 2010, 11:27 am

Re: FAQ 303: Customising Appointment Captions in the Diary

Postby William » May 25th, 2018, 5:08 pm

We have discovered that if you insert the patient notes field into the appointment description the patient notes can be viewed in whole when you hover over an appointment with your mouse cursor. Please see example below.

patient_notes_preview.png
patient_notes_preview.png (22.31 KiB) Viewed 677 times


This can help when previewing additional information you might have stored on the patient that you need to know about. The line of code to add for this is:-

Code: Select all
{per!notes!id=@per_id}


So if you were to add it to the staff view, it would look something like this:-

Code: Select all
{patient} [{type}] - {per!notes!id=@per_id}


If you were to add this to the room view, it would look something like this:-

Code: Select all
{patient} [{type}] with {staff} - {per!notes!id=@per_id}
ClinicOffice Support Team
www.pioneersoftware.co.uk
User avatar
William
 
Posts: 196
Joined: November 1st, 2007, 8:52 am


Return to FAQ Articles (START HERE if looking for help!)

Who is online

Users browsing this forum: No registered users and 0 guests

cron