Adding to and Removing patients from teams

Overview

PKB offers an automated Team membership method for adding patients to, or removing patients from PKB teams. The HL7 API-based approach is significantly more efficient because the management of PKB patient lists moves from a manual intervention in the UI, to a fully automated and customisable process based on trigger events chosen and handled directly in the customer’s systems (e.g., PAS or TIE).  

How does it work

• The PKB integration team will issue a unique alias to the customer for each PKB team that is in scope.

• The customer decides which PKB team(s) a patient needs to be added to, or removed from based on an event in their own system.

• The required alias values are then added to a ZTM custom segment in an ADT^A28/A31 message and sent to PKB.

  • ZTM-1 is used to Add to a team

  • ZTM-2 is used to Remove from a team

Adding to team(s)

• Aliases provided in ZTM-1 indicate which team(s) the patient should be added to.

• The organisation’s default team in PKB (usually the Patient Record Team) must be included, along with the aliases of any additional teams to which the patient should be added.

  • Alias values are separated by a tilde (~)

• When a patient is added to the new team, an email notification is sent to the patient/carer notifying of the change.

• If the patient was already in the team, no new email notification is sent.

Removing from team(s)

• Aliases provided in ZTM-2 indicate which team(s) in PKB the patient should be discharged from.

• If the patient is currently admitted to the team, then they will be discharged (which includes revoking any granted privacy labels).

• If the default team (i.e., PRT) is included in ZTM-2, the patient will be removed from the default team, but remain in the PKB organisation.

Validation rules

Adding and removing from teams

1. ZTM-1 and ZTM-2 can both be provided in the same ZTM segment of an HL7 ADT^A28/A31 Message or be sent independently of each other. 

2. ZTM-1 and ZTM-2 cannot contain the same team(s) alias values in the same ZTM segment of an HL7 message. These messages will be rejected with an AR, and the patient will not be added to, or removed from any of the teams specified.

3. When populating ZTM-1 the default PKB team for a customer’s organisation must always be included.

   1. PKB will advise the customer of the correct team alias for this team.

4. If an organisation is using PKB soft-matching and there is a mis-match failure,  then the patient will not be added to or removed from the team.

Removing from teams

1. A ZTM-2 containing a team that the patient is not already in will be rejected with an AR.

2. ZTM segments containing unknown aliases in ZTM-2 will be rejected with an AR.

3. ZTM segments containing aliases that do not map to teams of the sending customer’s PKB organisation will be rejected with an AR.

Further information

For more help on how to get started, refer to the Integration Planning and Testing Support section of the wiki.

Here is our FAQs wiki page.

Example HL7 message

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A28|ABC0000000001|P|2.4

PID|||9999999999^^^NHS^NH|
ZTM|prt_alias~add-to-team1_alias~add-to-team2_alias|remove-from-team_alias

User journey

Open

Open