Developer documentation‎ > ‎HL7 API‎ > ‎Messages‎ > ‎MDM T02‎ > ‎

Care Plan


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]] [[Care Plan.External Data Point ID]] as derived from TXA-12.1 Replacement. The existing care plan is replaced in its entirety with the values provided in this message. A partial update is not performed. 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 Timestamp]]
[[Care Plan.Last Edited Timestamp]]


[ 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-12 ]


Unique document number





TXA-12.1

Unique document number

MY_CP_1

[[Care Plan.External Data Point ID]]


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 ORU 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" or "PDF" supported.

HTML

 



OBX-5.4

Either "Base64" or "A" supported.

Note: Use "Base64" when OBX-5.3 is "PDF".

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 SPEC_02 [[Care Plan.Specialty]]

Examples

MSH|^~\&|SendingApp|SendingFacility|HL7API|PKB|20140529180000||MDM^T02|ABC0000000001|P|2.4
PID|||9999999999^^^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||201508010900|^Foster^John^Harry^^Dr|||||||MY_CP_1|||||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.
Comments