Next of Kin (NK1)

ADT^A28 and ADT^A31: Next of Kin support

Status

In development. API spec subject to change.

Please contact integrations@patientsknowbest.com if you have any feedback.

Overview

The A28 and A31 message types will be updated to include support for the NK1 segment.

If specified the segments will add the next of kin details held by your organisation to the demographics of the matched patient record. Any previously added next of kin details added by your organisation will be replaced by the latest update. Updates from your organisation will not overwrite details provided by another organisation.

Definition

Relationship Code Set

Based on HL7 specification table 0063

Telephone Code Set

Based on HL7 specification table 0063

Examples

Create a new patient with these IDs, demographics and next of kin.

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

PID|||523456789^^^NHS^NH{status:01}||Smith^Joe^^^Mr||19980101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||joe.smith@hotmail.com^NET~01234567811^PRN~07123456722^PRS|joe.smith@company.com^NET~01234098765^WPN||||||||||||||||N|

NK1|1|Smith^Mary^Louse^^Mrs|MTH|5 My Road^Town^City^County^NE1 9XX^GBR|||NOK||||||||F|19700101|||||||||||||||||5555555555^^^NHS^NH{status:01}|||||||example@gmail.com^NET~01234567890^PRN~07123456789^PRS

NK1|2|Smith^Joan^^^Miss|SIS|5 My Road^Town^City^County^NE1 9XX^GBR|||||||||||F|19990101|||||||||||||||||5666666666^^^NHS^NH{status:01}|||||||example2@gmail.com^NET~07123456780^PRS

NK1|3|Smith^John^^^Mr|BRO||||||||||||M|||||||||||||||||||||||||07123456781^PRS

Corrective behaviour: to remove next of kin entries from a patient record send a single NK1 segment with an HL7 null value in NK1-1.1. This is the NK1 segments only required field.

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A31|ABC0000000002|P|2.7

PID||| 523456789^^^NHS^NH{status:01}||Smith^Joe^^^Mr||19800101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||joe.smith@hotmail.com^NET~01234567811^PRN~07123456722^PRS|joe.smith@company.com^NET~01234098765^WPN||||||||||||||||N|

NK1|""|

Response

PKB will respond with a standard HL7 acknowledgement.