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) 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.

Definition


Segment Field Component Description Example Data Model
MSH

Unchanged
 
PID

Unchanged
 

 
[PD1]     Primary care facility (GP practice) information. 
   
   [PD1-3]   Patient primary facility    
    [PD1-3.1] Facility name Family Health Centre  
    [PD1-3.3] Facility identifier

If a UK ODS code is provided PKB will attempt to retrieve GP Practice address details from UK master reference data.  If this is available then this will take precedence over any details provided in ROL-11.
In the UK this would typically be an ODS code e.g A12345  
    [PD1-3.6]  Assigning authority.  This is required if the identifier (PD1-3.3) is populated.
  
Accepted national values must be whitelisted by PKB. 
  
Only 'NHS' is currently whitelisted.   If a blank or a non-whitelisted value is provided then the associated identifier (PD1-3.3) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes.  See examples.
NHS  
    [PD1-3.7] Identifier type code.  This is required if the identifier (PD1-3.3) is populated.

Accepted national values must be whitelisted by PKB. 

Only 'ODS' is currently whitelisted.   If a blank or a non-whitelisted value is provided then the associated identifier (PD1-3.3) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes.  See examples.
ODS  
   [PD1-4]   The primary care provider details

PD1-4 has been deprecated.  Primary care provider details should be provided in a ROL-4 where possible. However, in the interest of backwards compatibility, PKB will continue to support PD1-4.  If primary care provider details are provided in both PD1-4 and ROL-4 then the ROL-4 details will take precedence.
   
    [PD1-4.1]  Identifier
In the UK this would typically be a GMC number e.g G1234567   
    [PD1-4.2]  Family name Jones  
    [PD1-4.3]  Given name Paul  
    [PD1-4.4]  Middle name Simon  
    [PD1-4.6]   Title Dr  
    [PD1-4.9] Assigning authority. This is required if an identifier (PD1-4.1) is populated.

Accepted national values must be whitelisted by PKB.

Only 'NHS' is currently whitelisted. If a blank or a non-whitelisted value is provided then the associated identifier (PD1-4.1) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes. See examples.
NHS  
    [PD1-4.13] Identifier type code. This is required if the identifier (PD1-4.1) is populated.

Accepted national values must be whitelisted by PKB.

Only 'GMC' is currently whitelisted. If a blank or a non-whitelisted value is provided then the associated identifier (PD1-4.1) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes. See examples.
GMC  
 [ROL]     Patient primary care provider (GP) information.    
   [ROL-3]   The role described    
     [ROL-3.1] Role identifier.  PP (Primary Care Provider) is the only value currently processed.  If anything else is provided the entire segment will be silently ignored. PP  
   [ROL-4]   The primary care provider 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.  This is required if an identifier (ROL-4.1) is populated.

Accepted national values must be whitelisted by PKB.  

Only 'NHS' is currently whitelisted.  If a blank or a non-whitelisted value is provided then the associated identifier (ROL-4.1) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes.  See examples.
NHS  
    [ROL-4.13] Identifier type code. This is required if the identifier (ROL-4.1) is populated.  

Accepted national values must be whitelisted by PKB. 

Only 'GMC' is currently whitelisted. If a blank or a non-whitelisted value is provided then the associated identifier (ROL-4.1) will be silently ignored and will not be added to the record.

The HL7 null value is accepted but only for corrective purposes.  See examples.
GMC  
   [ROL-11]   The primary care provider practice 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]  Country Code GBR  
   [ROL-12]    The contact details for the primary care provider    
    [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 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.

Comments