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
Segment | Field | Component | Description | Example | Data Model |
MSH | Unchanged |
| |||
PID | Unchanged |
| |||
[PD1] |
|
| Unchanged. Segment not yet supported in live. Refer to primary care provider roadmap . |
|
|
[ROL] |
|
| Unchanged. Segment not yet supported in live. Refer to primary care provider roadmap . |
|
|
{ [NK1] } |
|
| Next of Kin |
|
|
| NK1-1 |
| Segment identifier |
|
|
|
| NK1-1.1 | An incrementing number for each NK1. If no value is supplied or the identifier is not sequentially correct then the NK1 segment will be silently ignored. HL7 null is accepted when there is one NK1 segment. A Null in the first field of a single NK1 segment will signify that all next of kin entries held in PKB by your organisation should be deleted. Refer to corrective behaviour example | 1 |
|
| [NK1-2] |
| The legal name of the associated party |
|
|
|
| [NK1-2.1] | Family name | Smith |
|
|
| [NK1-2.2] | Given name | Mary |
|
|
| [NK1-2.3] | Middle name | Louise |
|
|
| [NK1-2.5] | Title | Mrs |
|
| [NK1-3] |
| Relationship |
|
|
|
| [NK1-3.1] | Identifier. Refer to relationship code set below for supported values. If no value is supplied or the value supplied is not part of the defined code set PKB will default the value to 'UNK' - Unknown. | MTH |
|
| [NK1-4] |
| Primary Address |
|
|
|
| [NK1-4.1] | Address Line 1 | 5 My Road |
|
|
| [NK1-4.2] | Address Line 2 | Town |
|
|
| [NK1-4.3] | City | City |
|
|
| [NK1-4.4] | State | County |
|
|
| [NK1-4.5] | Postal Code | NE1 1XX |
|
|
| [NK1-4.6] | Country Code | GBR |
|
| [NK1-7] |
| Role |
|
|
|
| [NK1-7.1] | Identifier. Only NOK is supported currently. If NOK is supplied then this NK1 segment will be marked as the patients chosen next of kin. A patient may have multiple next of kin. If a value other than NOK is supplied this value will be silently ignored. | NOK |
|
| [NK1-15] |
| Gender |
|
|
|
| [NK1-15.1] | Gender. Allowed values are defined in Code Set PKBCS01 If a value is provided which is not part of the code set this value will be silently ignored. | F |
|
| [NK1-16] |
| Date of birth |
|
|
|
| [NK1-16.1] | Date of birth. Note that this timestamp will be accepted even if it contains time information. | 19700101 |
|
| [NK1-33] |
| National identifier. See here for more information about acceptable identifiers. |
|
|
|
| [NK1-33.1] | The national ID for the person described in this NK1 segment. In the UK this is their NHS number. | 5555555555 |
|
|
| [NK1-33.4] | National ID assigning authority (e.g "NHS" for the UK) This value is expected to be present if NK1-33.1 is provided. If a value is not supplied here then the corresponding value in NK1-33.1 will not be processed and will be silently ignored. | NHS |
|
|
| [NK1-33.5] | National ID type code (e.g. "NH" for the UK). If an NHS number status code is being provided, it must be appended without a space in the format given in the example. | NH{status:01} |
|
| { [NK1-40] } |
| Contact information. As of HL7 version 2.7 this field is used for all next of kin contact information. NK1-5 and NK1-6 details should be moved to this field prior to sending to PKB. |
|
|
|
| [NK1-40.1] | Telephone number | 0191 111 2222 |
|
|
| [NK1-40.2] | Telecommunication use code. Allowed values are defined in telephone code set . | PRS |
|
|
| [NK1-40.4] | Email address |
| |
{ [ AL1] } | Unchanged |
| |||
{ [ NTE ] } | Unchanged |
| |||
{ [ DG1 ] } | Unchanged |
| |||
{ [ ZRX ] } | Unchanged |
| |||
[ ZTM ] | Unchanged |
|
Relationship Code Set
Based on HL7 specification table 0063
Value | Description |
SEL | Self |
SPO | Spouse |
DOM | Life partner |
CHD | Child |
GCH | Grandchild |
NCH | Natural child |
SCH | Step child |
FCH | Foster child |
DEP | Handicapped dependent |
WRD | Ward of court |
PAR | Parent |
MTH | Mother |
FTH | Father |
CGV | Care giver |
GRD | Guardian |
GRP | Grand parent |
EXF | Extended family |
SIB | Sibling |
BRO | Brother |
SIS | Sister |
FND | Friend |
OAD | Other adult |
EME | Employee |
EMR | Employer |
ASC | Associate |
EMC | Emergency contact |
OWN | Owner |
TRA | Trainer |
MGR | Manager |
NON | None |
UNK | Unknown |
OTH | Other |
Telephone Code Set
Based on HL7 specification table 0063
Value | Description |
PRS | Mobile phone number |
PRN | Phone number |
WPN | Work phone number |
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.
PKB customer sites: deploy | developer | information governance | procurement | manual
© Patients Know Best, Ltd. Registered in England and Wales Number: 6517382. VAT Number: GB 944 9739 67.
This API specification and design is licensed under a Creative Commons Attribution 4.0 International License.