Skip to main content

What a Joy note looks like inside the clinical system

Written by Sonja Gebhardt

This guide explains what the current Joy file-back sends to SystmOne and how the resulting clinical event is identified and attributed.

It does not cover checking or retrying delivery. See The Clinical Systems queue: has my note reached the GP record? and How to retry something that did not reach the clinical record.

Where the note goes

Joy asks SystmOne to UpdatePatientRecord for the patient matched by NHS number. The content is written as a clinical event in that patient record.

The current file-back code establishes this SystmOne format. It does not establish an equivalent EMIS note layout, so do not assume that an EMIS record will use the same presentation.

How the event begins

The first narrative line starts with Joy: followed by the event name, with underscores changed to spaces.

For example:

  • record_saved becomes Joy: record saved;

  • contact_sent becomes Joy: contact sent;

  • wellbeing_completed becomes Joy: wellbeing completed.

This first line identifies the kind of action sent by Joy. SystmOne receives it as a narrative line, not as a separate Joy-branded document title.

What travels from a Joy record

For a record saved with Save to clinical record, the SystmOne narrative can contain, in this order:

  • Joy: record saved;

  • the record title, when one was entered;

  • the record content;

  • Record type: followed by the record type.

Joy removes HTML tags from record content before it is queued. Paragraph and line-break tags become plain line breaks, so formatting such as headings, bold text and links is not preserved as rich text.

If an Owner or Admin added Note (added to the file-back payload) while correcting an attempt, that note is included as another narrative line.

For a sent contact, the event begins Joy: contact sent. An email contributes its subject. An SMS or WhatsApp contact contributes its message body. The contact's record type is also included.

Other file-back families use the same cautious pattern: the Joy event line first, followed only by summary, content, note, decline reason, decision time or record type values that are present in that item's payload.

Clinical codes

When the Joy item carries one or more selected SNOMED codes, each code is sent as a separate SystmOne ClinicalCode using the Snomed scheme.

The file-back sends the code itself. It does not put the Joy catalogue's descriptive term into the code's free-text field.

Date and author

The clinical event date and time comes from when the file-back item was queued. Joy formats it in the Europe/London time zone.

The SystmOne event is attributed to the writing staff member's SystmOne username (case sensitive) when that has been saved in My organisation. If it is absent, Joy uses the username configured on the organisation's clinical-system record.

This is why the SystmOne username must match the clinical system exactly.

What is not included in this narrative

The current SystmOne narrative builder does not add:

  • attachments from the Joy record;

  • rich-text or HTML formatting;

  • the client's name or Joy client number;

  • the NHS number as visible narrative text;

  • time spent on the Joy record;

  • the record's completion timestamp;

  • the Joy catalogue term alongside a SNOMED code.

The NHS number is used to identify the patient record, but it is not added as a narrative line.

Check that it really arrived

The queue status sent means the broker accepted the request. It does not mean SystmOne applied the clinical event.

Wait for filed, which reflects a successful downstream response, or check the patient's SystmOne record. A device rejection returns the item to the queue as failed, beginning Rejected by SystmOne:.

Related guides

Did this answer your question?