Send medical documents


MDM^T02: Send a new care plan for a patient

Overview

This message can be used to send a new care plan through for a patient.

Relevant Entities

  • Care plan information will be used to populate [[Care Plan]] entities

Please click through to the Data Model to explore the presentation of these entities in the web interface.

Update Behaviour

Message Entity Matching Criteria Behaviour (Matched) Behaviour (Not Matched)
T02 [[Care Plan]] There is no unique identifier on a [[Care Plan]] submitted via HL7, so they cannot be updated. N/A New [[Care Plan]] created.

Definition


Segment Field Component Description Example Data Model

MSH



Message header. This conforms to PKB's standard definition.


 

PID



Patient identification. This conforms to PKB's standard definition.


 

TXA



Although this segment is formally for transcribed document information, we accept several document types in an MDM^T02 which may or may not have been transcribed. This segment contains metadata about the document.


 


TXA-2


Document type. Must be "CP" for a care plan.


 



TXA-2.1

Document type. Allowed values for this field are defined in Code Set PKBCS05, but you must set CP to indicate this is a care plan.

CP

 


TXA-4


Activity timestamp


 



TXA-4.1

Activity timestamp

201508010905

[[Care Plan.Created Timetamp]]
[[Care Plan.Last Edited Timetamp]]


[ TXA-5 ]


Primary activity provider. If provided, at least the family name must be given.


[[Care Plan->Source.Source Text]]



TXA-5.2

Family name

Foster

 



[ TXA-5.3 ]

Given name

John

 



[ TXA-5.4 ]

Middle names

Harry

 



[ TXA-5.6 ]

Title

Dr

 


TXA-17


Document completion status.


 



TXA-17.1

Document completion status. Must be "AU" for authenticated (this is not an in-progress or tentative document).

AU

 

OBX



Observation or result.  This contains the actual document content. See the OBX definition for an R01 message, but note the extra restrictions.


 


OBX-2




 



OBX-2.1

Only "ED" supported.

ED

 


OBX-3


Observation identifier


 



[ OBX-3.2 ]

Name. This will be used as the title of the care plan.

My Care Plan

[[Care Plan.Name]]



[ OBX-3.5 ]

Alternative name. This will be used as the title of the care plan if OBX-3.1 is not present.

My Care Plan Alternative Name

[[Care Plan.Name]]
if OBX-3.2 was not provided.


OBX-5







OBX-5.2

Only "TEXT" supported.

TEXT

 



OBX-5.3

Only "HTML" supported.

HTML

 



OBX-5.4

Either "Base64" or "A" supported.

A




OBX-5.5

The action plan content.

Drink water.

This value is set in
[[Care Plan.Action Plan]]
after being processed according to OBX-5.4.
[ PV1 ]     This is used to include the Hospital Service Code of the document    
  [ PV1-10 ]   Hospital service. See here for more information on code sets.    
    PV1-10.1 Hospital service code
[[Care Plan.Specialty]]

Examples

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20140529180000||MDM^T02|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|
TXA|1|CP|AP|201508010900|^Foster^John^Harry^^Dr|201508010910|201508010920|201508010930|||||||||AU
OBX|1|ED|^My Care Plan^||^TEXT^HTML^Base64^BERi0xLjMKJeTjz9IKNSI (more bytes...)||||||F
PV1|1|||||||||SPEC_02|

Response

PKB will respond with a standard HL7 acknowledgement.

MDM^T02: Send a document

Overview

In addition to care plans, the MDM^T02 can be used to send correspondence to a patient, for example a discharge summary.

The document type (TXA-2) value will be used to determine what sort of data we have received.

Correspondence documents will be presented to the patient as an attachment to a message.

Relevant Entities

  • Correspondence information will be used to populate [[Message]] entities
Please click through to the Data Model to explore the presentation of these entities in the web interface.

Update Behaviour

Message Entity Matching Criteria Behaviour (Matched) Behaviour (Not Matched)
T02 [[Message]] [[Message.External ID]] as derived from TXA-12.1 TBC New [[Message]] created.

Definition

This is identical in format to the MDM^T02 as used for care plans, except for the following:

Segment Field Component Description Example Data Model
TXA

We identify the [[Message.Timestamp]] value by trying the following fields in order: TXA-8, TXA-7, TXA-6, TXA-4. If none are provided, MSH-7 will be used.
 

TXA-2
Document type
 


TXA-2.1 Document type. Allowed values for this field are defined in Code Set PKBCS05, but you must not use CP since that will cause the document to be handled as a care plan. DS [[Message.Document Type]]

[ TXA-4 ]
Activity timestamp
 


TXA-4.1 Activity timestamp 201508010900 [[Message.Timestamp]]

if neither TXA-8, TXA-7, nor TXA-6 were provided.

[ TXA-6 ]
Origination timestamp
 


TXA-6.1 Origination timestamp 201508010910 [[Message.Timestamp]]

if neither TXA-8 nor TXA-7 were provided.

[ TXA-7 ]
Transcription timestamp
 


TXA-7.1 Transcription timestamp 201508010920 [[Message.Timestamp]]

if TXA-8 was not provided.

[ TXA-8 ]
Edit timestamp
 


TXA-8.1 Edit timestamp 201508010930 [[Message.Timestamp]]
   TXA-12   Unique document number    
     TXA-12.1 Unique document number MYDOC00001 [[Message.External Data Point ID]]
  [ TXA-16 ]   Filename. If provided, will be used instead of the default for the name of the downloadable attachment.    
     TXA-16.1 Filename mydoc.rtf [[Message->Attachment.Filename]]
OBX



 

OBX-3
Not used.
 

OBX-5
Value



OBX-5.3 RTF or PDF accepted. Note that viewing these attachments requires the end user to have the viewer installed, e.g. Microsoft Word or Adobe Reader. RTF  


OBX-5.4 Must be either "Base64" or "A", to match the data supplied in OBX-5.5. Base64  


OBX-5.5 If encoded in "A" format, this data must be escaped using the standard HL7 escape strings. e1xydGYxXGFkZWZsYW5nMTAyN... This value set in

[[Message->Attachment.Content]]

after being processed according to OBX-5.4

OBX-13
Custom access rules. Currently supported: "{patientDelay:NUMBERdays}" with any whole number in place of "NUMBER" (no spaces).  The patient will see that the message has arrived, but the contents will not be revealed until the set number of days past the date/time of the message have passed. If this field is not specified the patient will be able to see the message immediately.



OBX-13.1 Custom access rules {patientDelay:3days}  
[ PV1 ]



 

[ PV1-2 ]
Patient class



PV1-2.1 Patient class. Allowed values are defined in Code Set PKBCS04. I [[Message.Class]]



The message subject will be automatically generated based on document type.

DS : Discharge Summary
CL : Clinic Letter
RL : Referral Letter
AL : Appointment Letter
TCI : Admission (TCI) Letter
MDT : Multidisciplinary Team Meeting Notes

[[Message.Subject]]


The message content will be automatically generated based on document type. For example:

"Your discharge summary from ORG_NAME is attached."

[[Message.Content]]

Examples

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20140529180000||MDM^T02|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|
TXA|1|DS|ED|201508010900|^Foster^John^Harry^^Dr|201508010910|201508010920|201508010930||||MYDOC00001||||mydoc.rtf|AU
OBX|1|ED|||^TEXT^RTF^Base64^BERi0xLjMKJeTjz9IKNSI (more bytes...)||||||
PV1|1|||||||||SPEC_03|

Response

PKB will respond with a standard HL7 acknowledgement.
Comments