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

MDM T02 - Custom Postal Metadata


MDM^T02: Postal metadata custom segment

Status

In development. API spec subject to change

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

Case for change

PKB is often rolled out to customers as part of a gainshare model.  In such a model PKB works with 3rd party hybrid mail management solutions to provide electronic and physical distribution of documents.  To better measure the cost savings associated with gainshare PKB would like to capture metadata from the partner hybrid mail management solution as part of an MDM^T02 message.

Key changes

  • Custom optional Z segment introduced to capture postal metadata - ZPM.
  • ZPM-1.1 = Planned Postal Date (YYYYMMDD)

Overview

The MDM^T02 message type will be updated to include support for a custom ZPM segment. 

The ZPM segment is not applicable to Care Plans.  The ZPM segment will only be an option on a MDM^T02 message where TXA-2.1 is not 'CP'.

Definition

Segment Field Component Description Example Data Model
MSH

Unchanged
 
PID

Unchanged
 

 
TXA  
Unchanged    
OBX

Unchanged
 
[PV1]

Unchanged
 
[ZPM]

Custom segment for a partner hybrid mail solution to provide postal metadata
 
   [ZPM-1]        
     [ZPM-1.1] Planned Postal Date.  YYYYMMDD.

If the supplied value includes time information then this will still be accepted but the time element will be ignored.

If the supplied value is an invalid date then a rejection will be returned.
20190801  

Examples

MSH|^~\&|MIRTH|SYS|HL7API|PKB|20190801080000||MDM^T02|15407|P|2.4
PID|||9271558359^^^NHS^NH{status:01}||Patient^Test^^^Mr||19920821|M|||34 Main Street^^Town^County^TQ2 9XX^GBR|||||||||||||||||||N|
TXA|1|AL|ED|20190801080000|^Foster^John^Harry^^Dr|||||||New Appointment Letter||||AppointmentLetter.pdf|AU
OBX|1|ED|||^TEXT^PDF^Base64^JVBERi0xLj......||||||
PV1|1|O||||||||SPEC_03|
ZPM|20190820

Response

PKB will respond with a standard HL7 acknowledgement.

Comments