ZTM
- Andy Clowe
- Suzanne Joyce
Definition
The ZTM segment can be added to an HL7 demographic (A28/31) message to add or remove a patient to / from a team of the organisation sending the HL7 message.
If a partner is sending an A28/31 message on behalf of an organisation, the same logic will apply.
When adding a patient to a team (ZTM-1) then the alias for the default team must always be supplied, along with the alias for the team a patient is to be added to.
Note that the ZTM-2 field can not be used to remove patients from the default team (usually the Patient Record Team).
The alias’s to be used need to be configured by the PKB integrations team and provided to the customer / partner.
See our FAQ’s page on add and remove from teams functionality for more information
Segment | Field | Opt | RP/# | Component | Description | Example |
|---|---|---|---|---|---|---|
[ ZTM ] |
|
|
|
| This is a custom PKB team segment. If you have agreed some source aliases with PKB then you can specify 1 or more of those aliases in this ZTM segment. When creating or updating a medical record this segment will contribute to determining which teams the patient should be linked to. Note: You cannot use the ZTM segment to exclude the Team which would have otherwise been used. See our guidance on Team membership for more information. |
|
| ZTM-1 | O | Y |
|
|
|
|
|
|
| ZTM-1.1 | Alias | first_alias~second_alias |
| ZTM-2 | O | Y |
|
|
|
|
|
|
| ZTM-2.1 | Alias | first_alias |
Example segment:
To be added as a final segment in an A28/31 HL7 message.
ZTM|first_alias~second_alias~third_alias|first_alias|