Integrations & data · Practice guide

Keep internal notes out of external messages

Illustrative situation

A connector copies an internal note into a message field intended for an external recipient. An internal note may be useful to colleagues but inappropriate in a message to its subject. Define allowed outgoing fields explicitly instead of assuming every field on a record is suitable for a template.

Healthcare booking calendars on two connected screens with blue and orange appointment cards.
Make the handover between tools clear for the team using them.

What this means for your practice

Define the permitted message content and field mapping explicitly. Review the rendered output using fictional examples before enabling an external communication path.

An example to discuss with your team

Populate a fictional internal-only note and inspect the external message preview.

Healthcare data integration connecting two applications through a field-mapping board.
Agree what each field means and which system owns it.
Healthcare data validation separating matched records from an exception tray.
Make rejected or uncertain records visible for review.

Questions to take to your supplier

Populate a fictional internal-only note and inspect the external preview. Repeat with missing and unusually long values. Ask who approves template changes and how the practice reviews the final wording. The important outcome is the information actually shown to the recipient.

Agree the working process

Start by identifying what the external recipient needs to know for the stated purpose. Choose the permitted input fields from that list rather than giving the template access to every available note. Internal comments can contain working assumptions, staff discussion or information intended for a different audience. Keep those fields clearly separate in the mapping and review process. Ask the supplier to use fictional content that would be unmistakable if it appeared in the outgoing preview.

Test missing values and later edits too, since a safe initial sample does not establish the behaviour of every update. Give template changes an owner and retain the approved combination of wording and inputs. Staff should be able to see whether they are editing internal context or recipient-facing content. Before enabling automatic sending, review the complete rendered message through the organisation's process. If an unintended field reaches a test output, trace the mapping and correct it before treating the connection as ready, rather than merely editing that one sample message.

How to check the result

Count prohibited fields reaching a test output.

Turn reading into a next step

Your action checklist

Work through these checks with your team or supplier. Tick the ones you have resolved and leave unknowns open.

Checks to discuss

Record what you know, what is still missing and the answer you need from your team or supplier.

Use project decisions only, without personal, patient or confidential details. Entries stay in this page and are not submitted to Kay & Co. Copy or download before leaving; this page does not save your notes.

Further reading

These sources provide background for the topic. The practice examples and checklist are illustrative planning suggestions from Kay & Co.

Related guides

Need help with this?

Tell us what is getting in the way. Kay & Co. can help you understand the options and turn the next step into something that works for your practice.

Explore integrations & data services or discuss your project.

Try the free Healthcare Digital Planner to find your starting priority.