In development. API spec subject to change.
Please contact integrations@patientsknowbest.com if you have any feedback.
The A28 and A31 message types will be updated to include support for the PD1 and ROL segments.
If specified the segments will add the primary care provider (GP) and the primary care facility (GP practice) details held by your organisation to the demographics of the matched patient record. Any previously added primary care provider details held against the patient record will be replaced.
Create a new patient with these IDs, demographics, primary care facility (GP practice) and primary care provider (GP). Primary care facility ODS code and primary care provider GMC number are included. PD1-4 backwards compatibility supported.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A28|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1|||Family Health Centre^^A12345^^^NHS^ODS|G1234567^Jones^Simon^Paul^^Dr^^^NHS^^^^GMC
Create a new patient with these IDs, demographics, primary care facility (GP practice) and primary care provider (GP). Primary care facility ODS code and primary care provider GMC number are included.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A28|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1|||Family Health Centre^^A12345^^^NHS^ODS
ROL|||PP|G1234567^Jones^Simon^Paul^^Dr^^^NHS^^^^GMC|||||||Family Health Centre^Road^Town^City^NE1 1XX^|^^^email@address.com^^^0191 111 2222
Create a new patient with these IDs, demographics, primary care facility (GP practice) and primary care provider (GP). Primary care facility and primary care provider identifiers are not known and excluded from message.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A28|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1|||My Medical Centre^^^^^^
ROL|||PP|^Bloggs^Simon^Joe^^Dr^^^^^^^|||||||My Medical Centre^Road^Town^City^NE1 1YZ^|^^^email@address.com^^^0191 111 2222
Update the above patient record. Primary care provider practice and practitioner identifiers are now known and included in the message.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A31|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1|||My Medical Centre^^A98765^^^NHS^ODS
ROL|||PP|G9876543^Bloggs^Simon^Joe^^Dr^^^NHS^^^^GMC|||||||My Medical Centre^Road^Town^City^NE1 1YZ^|^^^email@address.com^^^0191 111 2222
Corrective behaviour: to remove a primary care facility (GP practice) from the patient record send an HL7 null value for each PD1-3 field in the specification within the PD1 segment. PKB will detect that all fields defining the primary care facility (id / facility name) are intentionally empty and will remove the existing primary care facility from the record.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A31|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1|||""^^""^^^""^""
Corrective behaviour: to remove a primary care provider (GP) from the patient record send an HL7 null value for each field in the specification within a ROL segment with ROL-3.1 set to PP. PKB will detect that all fields defining the primary care provider (id, name, address, contact details) are intentionally empty and will remove the existing primary care provider from the record.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A31|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
ROL|||PP|""^""^""^""^^""^^^""^^^^""|||||||""^""^""^""^""^""|^^^""^^^""
Corrective behaviour: to remove a primary care provider (GP) from the patient record where ROL is not supported in the feed send an HL7 null value for each PD1-4 field in the specification within a PD1 segment. PKB will detect that all fields defining the primary care provider (id, name, address, contact details) are intentionally empty and will remove the existing primary care provider from the record.
MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20160102101112||ADT^A31|ABC0000000001|P|2.4
PID|||5555555555^^^NHS^NH||Smith^John^Joe^^Mr||19700101|M|||My flat name^1, The Road^London^London^SW1A 1AA^GBR||john.smith@hotmail.com^NET~01234567890^PRN~07123456789^PRS|john.smith@company.com^NET~01234098765^WPN||||||||||||||||N|
PD1||||""^""^""^""^^""^^^""^^^^""
Response
PKB will respond with a standard HL7 acknowledgement.