Care Plan

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

R

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

R

Activity timestamp

TXA-4.1

Activity timestamp

201508010905

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

TXA-5

O

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

R

Unique document number

TXA-12.1

Unique document number

MY_CP_1

[[Care Plan.External Data Point ID]]

TXA-16

O

Filename. If provided, will be used instead of the default for the name of the downloadable attachment.

TXA-16.1

Filename

mycareplan.pdf

[[Document->Attachment.Filename]]

TXA-17

R

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.

OBX-2

R

OBX-2.1

Only "ED" supported.

ED

OBX-3

R

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

R

We only support the following OBX-5.2/OBX-5.3 combinations (please note there is a 50MB limit on these files):

• TEXT/HTML

• APPLICATION/PDF

• TEXT/PLAIN

• IMAGE/* e.g. IMAGE/PNG

• AUDIO/* e.g. AUDIO/MP3

OBX-5.2

See OBX-5 for OBX-5.2/OBX-5.3 combinations

TEXT

OBX-5.3

See OBX-5 for OBX-5.2/OBX-5.3 combinations

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

O

Hospital service. See our notes on code sets for more information on our handling of coded data.

PV1-10.1

Hospital service code

SPEC_02

[[Care Plan.Specialty]]