FAQs - Add to / Remove from Teams (HL7)
- Sara Muse
- Andy Clowe
- Suzanne Joyce
Question | Response |
|---|---|
Can a patient be removed from all teams? | Yes, but the patient will remain associated with the organisation. |
Can a patient be discharged from a PKB organisation? | No. The patient will remain a part of the organisation and will be searchable within the organisation’s PKB patient list. |
Does the alias to add the patient to the correct team need to be supplied with every demographic message sent for that patient? | No. Once the patient is in that specialty team in PKB they will remain there until discharged manually in the UI or via the API using the specified team’s alias in ZTM-2.1. |
Do I have to include the default or creating team when adding a patient to a team? | Yes. Without the default / creating team, the message will be rejected. |
Do I have to include the default or creating team when removing a patient to a team? | No, but you can’t add and remove a patient from the same team in the same message. |
How do I get an alias to use in the ZTM segment? | This is created by the PKB integrations team and sent to you. |
What data will the team lose access to in the patient's record after discharge? | See a link to our manual for details of what the team will lose access to and what happens for the patient when they’re discharged from a team. |
How does PKB handle cases where ZTM-1 and ZTM-2 contain the same team(s) in the same ZTM segment? | PKB will respond with an AR rejection response and the patient will not be added to or removed from any of the teams in the ZTM segment. |
What happens if we’re using soft matching and there’s a mismatch in demographics within the A28/31? | If an organisation is using soft-matching and an A28/31 with a ZTM-1 or ZTM-2 contains a mismatch, then the patient will not be added to or removed from the team(s) in the ZTM segments. |
Can a patient be added to more than one team via a single HL7 message? And is there a limit? | Yes a patient can be added to and / or removed from multiple teams in one HL7 message, and there is no limit to the number of teams in ZTM-1 or ZTM-2. |
What is the minimum data required in an A28/31 message to add / remove from a team? | Assuming the patient record is already created in PKB, only the patient identifier and ZTM segment are required. If using soft matching, the soft matching fields must be included in the PID segment. |
Can a patient be removed from more than one team via a single HL7 message? | Yes |
What happens if the ZTM segment contains an alias for a team a patient is already in? | Nothing happens. The patient will remain in the team(s) that are in the ZTM-1 segment. |
What notification does a patient get when being added or removed from a team? | When added to a team they get an email titled “You are connected to a new team at <organisation name>” that gives more information about why this happened, what happens next, what if the patient doesn’t know the organisation, and how the patient knows what information they have about them.
If a patient is removed from a team, the patient receives an email titled “You have been discharged.” The patient receives an email notification each time the alias is sent in ZTM-2, even if they aren’t in the team or have already been discharged from it. |
Does a patient get any notification if a ZTM-1 segment includes the alias of a team the patient is already in? | No. The patient will get a notification the first time the alias comes through in the ZTM-1 and not again. |
Can the text of any notification messages be bespoke to meet a customer's specific requirements? | The footer of the email notification message can be bespoke per organisation and per team. Your success project manager can work with you on this, if that’s something you’re interested in. |
Does PKB build the logic to add our patients to particular teams? | No, you need to create logic in your integration engine to add patients to particular teams based on triggers in your system that you identify. ie. if a patient attends a particular clinic (code). |