Developer documentation‎ > ‎HL7 API‎ > ‎Roadmap‎ > ‎

Primary Care Provider (GP Details)


ADT^A28 and ADT^A31: GP Details 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 PD1 and ROL segments.

If specified the segments will add the primary care provider (GP) details and the primary care facility (GP practice) held by your organisation to the demographics of the matched patient record.   Any previously added primary care provider details from your organisation will be replaced.

Definition


Segment Field Component Description Example Data Model
MSH

Unchanged
 
PID

Unchanged
 

 
[PD1]     Primary care provider practice and practitioner information. 
   
   [PD1-3]   Patient primary facility    
    [PD1-3.1] Facility name Family Health Centre  
    [PD1-3.3] Facility identifier In the UK this would typically be an ODS code e.g A12345  
    PD1-3.6  Assigning authority.  Only NHS is currently accepted.   If anything else is provided the segment will be silently ignored. NHS  
    PD1-3.7 Identifier type code.  Only ODS is currently accepted.  If anything else is provided the segment will be silently ignored. ODS  
 [ROL]     Patient practitioner information.    
   [ROL-3]   The role described    
     ROL-3.1 Role identifier.  PP (Patient Practitioner) is the only value accepted, PP  
   [ROL-4]   The patient practitioner details    
    [ROL-4.1] Identifier In the UK this would typically be a GMC number e.g G1234567   
    [ROL-4.2] Family name Jones  
    [ROL-4.3] Given name Paul  
    [ROL-4.4] Middle name Simon  
    [ROL-4.6]  Title Dr  
    ROL-4.9 Assigning authority.  Only NHS is currently accepted.  If anything else is provided the segment will be silently ignored. NHS  
    ROL-4.13 Identifier type code.  Only GMC is currently accepted. If anything else is provided the segment will be silently ignored. GMC  
   [ROL-11]   The patient practitioner address    
     [ROL-11.1]  Address Line 1 Family Health Centre  
     [ROL-11.2]  Address Line 2 Road  
     [ROL-11.3]  City Town  
     [ROL-11.4]  State City  
     [ROL-11.5]  Postal Code NE1 1XX  
     [ROL-11.6]  County Code GBR  
   [ROL-12]    The contact details for the patient practitioner    
    [ROL-12.4]   Email address address@gmail.com  
    [ROL-12.7]  Telephone number 0191 111 2222  
{ [ AL1] }

Unchanged
 
{ [ NTE ] }

Unchanged
 
{ [ DG1 ] }

Unchanged
 
{ [ ZRX ] }

Unchanged
 
[ ZTM ]

Unchanged
 

Examples

Create a new patient with these IDs, demographics, primary care provider, medications list, allergies, and diagnoses.

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 444 4444

Corrective behaviour: to remove a GP Practice from the patient record send an HL7 null for each optional field within a PD1 segment.  PKB will detect this and remove the current GP Practice from the record.

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|||""^^""^^^NHS^ODS
ROL|||PP|G1234567^Jones^Simon^Paul^^Dr^^^NHS^^^^GMC|||||||Family Health Centre^Road^Town^City^NE1 1XX^|^^^email@address.com^^^0191 444 4444

Corrective behaviour: to remove a GP Practitioner from the patient record send an HL7 null for each optional field within a ROL segment.  PKB will detect this and remove the current GP Practitioner from the record.

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|""^""^""^""^^""^^^NHS^^^^GMC|||||||""^""^""^""^""|^^^""^^^""


Response

PKB will respond with a standard HL7 acknowledgement.

Comments