The Demo site for our new HL7 Version 2+ (plus) Standard
visit the hl7 website

Draft Website - For Review Purposes Only

Patient Care

Chapter Chair:

Stephen Chu

Chapter Chair:

Laura Heermann Langford
Intermountain Healthcare

Chapter Chair:

Emma Jones
Allscripts

Chapter Chair:

Jay Lyle

Chapter Chair:

Michelle Miller
Cerner Corporation

Chapter Chair:

Michael Padula
Children’s Hospital of Philadelphia

Chapter Chair:

Michael Tan
NICTIZ

Chapter Editor:

Amit Popat
Epic

Assisstant Editor:

Daniel Rutz
Epic

Sponsoring Work Group

Patient Care

List Server

patientcare@lists.hl7.org


INTRODUCTION AND OVERVIEW

The Patient Care1 Work Group has designed the following messages to support the communication of problem-oriented records, including clinical problems, goals, and pathway information between computer systems. The purpose of this chapter is to describe healthcare messages that need to be communicated between clinical applications for a given individual. These message transactions can be sent in either batch or online mode. As described in Chapter 2, multiple communication transactions may be grouped and sent between applications using a file transfer media or direct networked connection.

This chapter defines the transactions that occur at the seventh OSI level, that is, abstract messages. The examples of messages included in this chapter were constructed using the HL7 Encoding Rules.

This chapter describes a Clinical Relationship segment which enables the run-time expression of relationships between information elements both inside and, where identifiable, by the application, outside the message.

[1]     While not an ideal term, the word “patient” is used here to represent the entire spectrum of individuals who receive healthcare in a variety of settings including, but not limited to, acute care, clinic care, long-term care, residential care, home health care, office practices, school-based care and community settings.

Glossary

The following definitions of key terms are used throughout this chapter:

Goal:

A goal refers to an objective to be achieved as a consequence of healthcare interventions applied to an individual. Goals are set in many areas of the healthcare system, and include educational, behavior modification, and clinical goals such as reduced discomfort, improved circulation. Goals are documented by a variety of healthcare professionals including physicians, nurses, and respiratory and other therapists. Goals are defined during patient visits and they may span one or multiple visits, encounters, or episodes of care.

Problem:

A problem of a given individual can be described by formal diagnosis coding systems (such as DRGs, NANDA Nursing Diagnosis, ICD9, DSM, etc.) or by other professional descriptions of healthcare issues affecting an individual. Problems can be short- or long-term in nature, chronic or acute, and have a status. In a longitudinal record, all problems may be of importance in the overall long-term care of an individual, and may undergo changes in status repeatedly. Problems are identified during patient visits, and may span multiple visits, encounters, or episodes of care.

Role:

A role refers to the function or responsibility assumed by a person in the context of a healthcare event. Role information documents a person's association with an identified healthcare activity. Examples include primary care provider, transcriptionist, reviewer, and consulting physician.

Clinical pathway:

A clinical pathway is a standardized plan of care against which progress towards health is measured. A clinical pathway is applied based upon the results of a patient assessment. A clinical pathway shows exact timing of all key patient care activities intended to achieve expected standard outcomes within designated time frames. A clinical pathway includes documentation of problems, expected outcomes/goals, and clinical interventions/orders.

Variance:

Variances are documented deviations, either positive or negative, from a pre-defined standard. Variances are documented against expected outcomes, orders, or the patient's progress in general.

Scenario Descriptions

Patient pre-admission or patient admission

A physician's office is scheduling a patient for admission to the hospital. The admitting diagnosis/problem list and admission information is sent by the physician's electronic information system to the hospital's Patient Administration system and longitudinal medical record. The trigger event identifies the message as an "add problem" or update patient medical information to the Patient Administration and medical record system.

Consultation

A consultation is requested for an individual. The information system generating the consultation triggers an unsolicited message containing the problem/diagnosis list that is transmitted to the consulting organization. Goals and various kinds of role information are included with the transmission. The trigger event identifies the message as an unchanged record.

Loading a clinical repository

Information from point of care, clinical practice management or ancillary systems regarding the creation or update of pathways, problems, diagnoses, or goals are communicated to the clinical repository. Message triggers from the departmental systems may indicate adding, correcting, deleting, or updating records maintained in the clinical data repository.

Communicating clinical pathways and multidisciplinary plans of care

The pathway is communicated between Quality Assurance, Point of Care Systems, Research Databases, and Clinical Order Entry Systems. A point of care information system triggers a linkage between a problem and a set of ordered interventions initiated by the clinical order entry system.

Trigger Events

The trigger events originate goal, problem and pathway messages. Each trigger event is documented below, along with the appropriate form of the message exchange. These are message-level event triggers, which are augmented by the action code fields contained in the pathway, problem and goal segments described below. Action codes are required fields in patient care message segments (see Chapter 2 for further information regarding implementation issues). Implementors need to apply the appropriate logic as part of their message construction (for example, logic would state that an "add" trigger event should not include segments with a "delete" action code).

In order to accommodate these high-level events, the following patient care events are included in HL7 Table 0003 – Event Type. The added events are instantiated in MSH-9 Message Type and are used by the pathway, problem, and goal messages. MSH-9 Message Type contains the message type and trigger event for the message.

Use of Action Codes

Prior to Version 2.3 of the Standard, all repeating segments had to be sent in an update message, because there was no way to indicate which ones changed and which ones did not. In this snapshot mode, all repeating segments must be sent with every subsequent message in the series of messages.

To reduce the number of repeating segments, action codes may be employed. Action codes (e.g., order control codes and result status codes) may be embedded within repeating segments and used by sophisticated application parsers to reduce the number of repetitions required for a complete record.

In either event, for systems implementing Version 2.3 or higher, if a particular repeating segment can be updated by either of these two modes, the parties concerned determine by agreement on a site-specific basis whether an interface uses the snapshot mode or the action code/unique identifier mode.

A description of valid action codes used in message segments originating in this chapter is given immediately below:

  1. AD (ADD) - The object defined within the segment should be added to the set of objects that is linked to the previous object in the hierarchical structure of the message. (i.e., a goal under a problem is implicitly linked to the problem. If the goals already exist, the segment placement indicates the addition of a new linkage between the goal and that problem.)

  2. CO (CORRECT) - The object attributes contained within the segment have been corrected. This is not updated information, but information originally sent and later found to be in error. The previous attributes should be replaced.

  3. UP (UPDATE) - The object attributes contained within the segment are an update of previously sent information. The previous information was correct for the period of time in which it was sent.

  4. DE (DELETE) - This object should be deleted from the set of objects which are linked to the previous object in the message hierarchy. An example might be a role deleted from the set of roles contained by the Goal object. Delete presumes the original linkage was in error.

  5. LI (LINK) - This action code denotes that the object contained in the segment should be linked in a dependency relationship to the previous object in the hierarchy. It is used to denote relationships and should not contain additional information other than those attributes necessary for specific identification.

  6. UN (UNLINK) - This is a request that the object be removed from the set of linked objects. An example might be the dissolution of a relationship between a problem and a goal. Unlink presumes the original linkage was correct, but due to life cycle changes the active linkage is no longer appropriate.

  7. UC (UNCHANGED) - This code signifies that the segment is being included for the purposes of hierarchical set identification. It does not contain any changed or additional data. Its purpose is to allow the identification of the collection set to which subsequent segments belong in the message structure. An example might be the modification of role information requiring the previous goal segment to be appropriately identified.

Examples of action code usage

A problem list and associated goals are generated in a Point of Care system. This transaction is broadcast through an interface engine that determines which systems in the organization require the event information and then forwards the messages appropriately. Each segment included in the original message contains the Action Code for ADD to signify an original message instance.

  1. Upon subsequent review, it is determined that a role segment designates the wrong person as the transcribing clerk for a problem. After the information is changed in the originating system, a new message is sent to provide synchronization. The message includes the original PRB segment with the PRB-1 Action Code for UNCHANGED (to identify the problem for which the role is being changed). This code signifies that the segment is included for the purposes of hierarchical linkage identification and that none of the information contained in it has been changed. The accompanying role segment sent would include the role transcriber in ROL-3 Role, the correct person in ROL-4 Role Person, and the value for CORRECT in ROL-2 Action Code.

  2. It is later decided that an additional goal must be added to a specific problem, and that an already existing goal that is currently supporting another problem should also be linked with this specific problem. The message would be constructed with the problem (PRB) segment for identification (the value for PRB-1 Action Code is UNCHANGED). The goal segment (GOL) for the additional goal would include GOL-1 Action Code for ADD. The goals already included with the problem list that need to be linked to this problem would have to be included on additional GOL segments with the GOL-1 Action Code for LINK.

    Once data regarding a Diagnosis/Problem or a Goal have been communicated to other systems, there are occasions on which the data may have to be amended.

  3. New diagnoses/problems must be added to an individual's list. The Problem message is sent with the appropriate Problem Instance ID. All PRB segment(s) included in the message that contain the value for ADD in PRB-1 Action Code are processed as additions to the individual's problem list.

  4. New goals are added to the individual's record. The Goal message is sent with the GOL segments indicating the value for ADD as GOL-1 Action Code in each segment occurrence.

  5. Changes are made to the attributes of a goal. Examples include a change in the expected resolution date, a change in the life cycle status to reflect its successful conclusion, etc. The Goal message is sent with the appropriate GOL-4 Goal Instance ID. The GOL segments of the Goal message would include the value for UPDATE in GOL-1 Action Code.

  6. A new goal is attached to a problem already in the repository (e.g., the goal of "education on diabetes" for an individual diagnosed with "insulin-dependent diabetes"). A problem message would be sent with the PRB segment including the PRB-4 Problem Instance ID for the diabetes problem, and with the value UNCHANGED in PRB-1 Action Code. The attached GOL segment for the education goal would accompany the message and contain the value ADD in its GOL-1 Action Code field.

  7. A new diagnosis/problem is attached to a goal (e.g., a Goal is to "discharge an individual with intact skin." While the initial problem was "skin breakdown related to immobility," a new problem is "potential for skin breakdown related to draining wounds"). A Goal message would be sent with the GOL segment, including the GOL-4 Goal Instance ID for the discharge goal, and contain the value UNCHANGED in GOL-1 Action Code. The attached PRB segment identifying the new problem, "potential for skin breakdown related to draining wounds," would accompany this message and contain the value for ADD in PRB-1 Action Code.

Note: If there is a requirement to modify information contained on a segment and unlink that same problem/goal, two segments must be transmitted (one for the modification and one for the unlink request).


Message Construction Rules

The semantic meaning of a message is contained in the message through the use of the trigger events, the implicit hierarchical linkages of the segments, and the segment action codes. Each of these has a scope within the message. The message event as included in the MSH-9 Message Type has a scope which is global to the message. The segment hierarchical linkage has a scope which includes both the segment itself and its relationship to its parent. The segment action code's scope is to the segment itself. It may further define link and unlink actions in the hierarchical structure.

Rule 1

The trigger event defines the action at the first level of the hierarchy, and should not be contradicted by either hierarchical linkages or segment action codes. Thus, a PC1 (problem add) event should only contain problem, goal, and role segments that have action codes ADD.

Figure 12-1. Table of allowable trigger event types and action codes

Trigger Event Types

Allowable Action Codes

xxx-Add

Top level action code must be ADD
Dependent segment action code must be ADD (or NW for Order segments)

xxx-Update

Top level action code must be CORRECT, UPDATE, or UNCHANGED
Dependent segment action codes - Any are allowed at the lower hierarchical levels

xxx-Delete

Top level action code must be DELETE
Dependent segments' action codes must be DELETE


Rule 2

When using the segment action codes LINK and UNLINK, only those fields which are used to define a unique instance of the object are used. This action cannot be used to send changes and updates to the other fields of that segment.

Rule 3

In dependent segments ADD is the action code to use to establish the initial relationship between parent-child objects. The receiving system must be ready to handle multiple adds of the same object. An example is a Problem List of three (3) problems which is being sent. Attached to these problems are three (3) goals. Problem A has Goals 1 and 2 attached to it. Problem B has the same Goal 2 and a new Goal 3 attached to it. All of these will have the ADD action code in the segment, and when Problem B is transmitted with Goals 2 and 3, Goal 2 will have been previously transmitted with Problem A. The message construct would look like this:

MSH...

PID...

            PRB (Problem A)

                GOL (Goal 1)

                GOL (Goal 2)

            PRB (Problem B)

                GOL (Goal 2)

                GOL (Goal 3)

            PRB (Problem C) (No attached goals)

When two (or more) instances of the same problem or goal segment are present in a message both such segments must have identical values for all fields.

Rule 4

Remember that HL7 only provides for error messages at the message level. Thus, if the receiving system cannot process one segment, the entire message is going to be treated as an error (See Chapter 2).

Rule 5

The Problem, Goal, and Pathway messages integrate order segments as a method for establishing causal linkages. Linkages or relationships between orders, problems, goals, and pathways can therefore be presented in the Patient Care messages.

Orders referenced in Patient Care messages are used for linkage purposes only. Initiation and status changes to orders are accomplished by using dedicated messages defined in the Order Entry Chapter.

Rule 6

Order segments are sent with Problem and Goal segments in order to establish a linkage between them, NOT to communicate new orders or changes to those orders. For purposes of these messages, an LI (Link) and a UL (Unlink) code have been added to HL7 Table 0119 - Order Control Codes.

Acknowledgment Choreography

As of Version 2.9 Infrastructure and Messaging requires that Acknowledgment Choreography be explicitly specified in MSH-15 and MSH-16. Because of the nature of the Query and Response Messaging pattern, the Response message is always an Application Acknowledgment. To specify this, the value in MSH-16 SHALL always be “AL” for those messages that are Queries, to indicate that there will always be an Application Acknowledgment to the Query Message. See Chapter 2 for more details on this subject.

MESSAGE DEFINITIONS

Applications can have differing orientations for representing problem and goal hierarchies. For example, parent/child relationships may map problem(s) to goal(s), or goal(s) to problem(s). To accommodate these different orientations, the Problem message allows representation of goals that are functionally dependent upon a problem, and the Goal message allows representation of problems that are functionally dependent on a goal.

Due to the multiple occurrences of common segments such as Variance (VAR) and Notes (NTE), we have chosen to expand the segment definitions on the message diagrams to explicitly identify the hierarchical relationships. Examples of this would be "Variance (Goal)" and "Variance (Participation)." This does not imply unique segments, but indicates in the first case that the variance is related to its parent Goal, and in the second case that the variance is related to its parent Role.

The notation used to describe the sequence, the optionality, and the repetition of segments is described in Chapter 2, under "Format for defining abstract message."

Note: For all message definitions, the "OBR etc." notation represents all possible combinations of pharmacy and other order detail segments, as outlined in Chapter 4 conventions (See section 4.2.2.4, "Order detail segment").

PGL/ACK - Patient Goal Message (Events PC6, PC7, PC8)

This message is used to send goals from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.

PGL^PC6^PGL_PC6: Patient Goal Message
HL7 MessageStructure Table - PGL_PC6
Segment Cardinality Must Implement Status
PGL_PC6
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
GOAL 1..* Yes
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PGL^PC6^PGL_PC6

Send Application Ack: ACK^PC6^ACK

Enhanced Mode Acknowledgement Choreography for PGL^PC6^PGL_PC6

When the MSH-15 value of a PGL^PC6^PGL_PC6 message is AL or ER or SU, an ACK^PC6^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PGL^PC6^PGL_PC6 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PGL^PC6^PGL_PC6 message is AL or ER or SU, an ACK^PC6^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PGL^PC6^PGL_PC6 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC6^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC6^ACK
NE (none)

PGL^PC7^PGL_PC6: Patient Goal Message
HL7 MessageStructure Table - PGL_PC6
Segment Cardinality Must Implement Status
PGL_PC6
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
GOAL 1..* Yes
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PGL^PC7^PGL_PC6

Send Application Ack: ACK^PC7^ACK

Enhanced Mode Acknowledgement Choreography for PGL^PC7^PGL_PC6

When the MSH-15 value of a PGL^PC7^PGL_PC6 message is AL or ER or SU, an ACK^PC7^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PGL^PC7^PGL_PC6 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PGL^PC7^PGL_PC6 message is AL or ER or SU, an ACK^PC7^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PGL^PC7^PGL_PC6 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC7^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC7^ACK
NE (none)

PGL^PC8^PGL_PC6: Patient Goal Message
HL7 MessageStructure Table - PGL_PC6
Segment Cardinality Must Implement Status
PGL_PC6
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
GOAL 1..* Yes
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PGL^PC8^PGL_PC6

Send Application Ack: ACK^PC8^ACK

Enhanced Mode Acknowledgement Choreography for PGL^PC8^PGL_PC6

When the MSH-15 value of a PGL^PC8^PGL_PC6 message is AL or ER or SU, an ACK^PC8^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PGL^PC8^PGL_PC6 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PGL^PC8^PGL_PC6 message is AL or ER or SU, an ACK^PC8^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PGL^PC8^PGL_PC6 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC8^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC8^ACK
NE (none)

ACK^PC6^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC6^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC6^ACK

When the MSH-15 value of an ACK^PC6^ACK message is AL or ER or SU, an ACK^PC6^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC6^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC6^ACK
NE (none)
MSH-16 NE (none)

ACK^PC7^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC7^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC7^ACK

When the MSH-15 value of an ACK^PC7^ACK message is AL or ER or SU, an ACK^PC7^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC7^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC7^ACK
NE (none)
MSH-16 NE (none)

ACK^PC8^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC8^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC8^ACK

When the MSH-15 value of an ACK^PC8^ACK message is AL or ER or SU, an ACK^PC8^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC8^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC8^ACK
NE (none)
MSH-16 NE (none)

This error segment indicates the fields that caused a transaction to be rejected.

PPR/ACK - Patient Problem Message (Events PC1, PC2, PC3)

The patient problem message is used to send problems from one application to another (e.g., a point of care system to a clinical repository). Many of the segments associated with this event are optional. This optionality allows systems in need of this information to set up transactions that fulfill their requirements.

PPR^PC1^PPR_PC1: Patient Problem Message
HL7 MessageStructure Table - PPR_PC1
Segment Cardinality Must Implement Status
PPR_PC1
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PROBLEM 1..* Yes
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPR^PC1^PPR_PC1

Send Application Ack: ACK^PC1^ACK

Enhanced Mode Acknowledgement Choreography for PPR^PC1^PPR_PC1

When the MSH-15 value of a PPR^PC1^PPR_PC1 message is AL or ER or SU, an ACK^PC1^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPR^PC1^PPR_PC1 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPR^PC1^PPR_PC1 message is AL or ER or SU, an ACK^PC1^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPR^PC1^PPR_PC1 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC1^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC1^ACK
NE (none)

PPR^PC2^PPR_PC1: Patient Problem Message
HL7 MessageStructure Table - PPR_PC1
Segment Cardinality Must Implement Status
PPR_PC1
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PROBLEM 1..* Yes
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPR^PC2^PPR_PC1

Send Application Ack: ACK^PC2^ACK

Enhanced Mode Acknowledgement Choreography for PPR^PC2^PPR_PC1

When the MSH-15 value of a PPR^PC2^PPR_PC1 message is AL or ER or SU, an ACK^PC2^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPR^PC2^PPR_PC1 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPR^PC2^PPR_PC1 message is AL or ER or SU, an ACK^PC2^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPR^PC2^PPR_PC1 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC2^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC2^ACK
NE (none)

PPR^PC3^PPR_PC1: Patient Problem Message
HL7 MessageStructure Table - PPR_PC1
Segment Cardinality Must Implement Status
PPR_PC1
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PROBLEM 1..* Yes
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PATHWAY 0..*
PTH 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPR^PC3^PPR_PC1

Send Application Ack: ACK^PC3^ACK

Enhanced Mode Acknowledgement Choreography for PPR^PC3^PPR_PC1

When the MSH-15 value of a PPR^PC3^PPR_PC1 message is AL or ER or SU, an ACK^PC3^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPR^PC3^PPR_PC1 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPR^PC3^PPR_PC1 message is AL or ER or SU, an ACK^PC3^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPR^PC3^PPR_PC1 message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC3^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PC3^ACK
NE (none)

ACK^PC1^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC1^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC1^ACK

When the MSH-15 value of an ACK^PC1^ACK message is AL or ER or SU, an ACK^PC1^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC1^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC1^ACK
NE (none)
MSH-16 NE (none)

ACK^PC2^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC2^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC2^ACK

When the MSH-15 value of an ACK^PC2^ACK message is AL or ER or SU, an ACK^PC2^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC2^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC2^ACK
NE (none)
MSH-16 NE (none)

ACK^PC3^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PC3^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PC3^ACK

When the MSH-15 value of an ACK^PC3^ACK message is AL or ER or SU, an ACK^PC3^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PC3^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PC3^ACK
NE (none)
MSH-16 NE (none)

This error segment indicates the fields that caused a transaction to be rejected.

PPP/ACK - Patient Pathway Message (Problem-Oriented) (Events PCB, PCC, PCD)

PPP^PCB^PPP_PCB: Patient Pathway Problem-Oriented Message
HL7 MessageStructure Table - PPP_PCB
Segment Cardinality Must Implement Status
PPP_PCB
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPP^PCB^PPP_PCB

Send Application Ack: ACK^PCB^ACK

Enhanced Mode Acknowledgement Choreography for PPP^PCB^PPP_PCB

When the MSH-15 value of a PPP^PCB^PPP_PCB message is AL or ER or SU, an ACK^PCB^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPP^PCB^PPP_PCB message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPP^PCB^PPP_PCB message is AL or ER or SU, an ACK^PCB^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPP^PCB^PPP_PCB message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCB^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCB^ACK
NE (none)

PPP^PCC^PPP_PCB: Patient Pathway Problem-Oriented Message
HL7 MessageStructure Table - PPP_PCB
Segment Cardinality Must Implement Status
PPP_PCB
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPP^PCC^PPP_PCB

Send Application Ack: ACK^PCC^ACK

Enhanced Mode Acknowledgement Choreography for PPP^PCC^PPP_PCB

When the MSH-15 value of a PPP^PCC^PPP_PCB message is AL or ER or SU, an ACK^PCC^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPP^PCC^PPP_PCB message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPP^PCC^PPP_PCB message is AL or ER or SU, an ACK^PCC^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPP^PCC^PPP_PCB message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCC^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCC^ACK
NE (none)

PPP^PCD^PPP_PCB: Patient Pathway Problem-Oriented Message
HL7 MessageStructure Table - PPP_PCB
Segment Cardinality Must Implement Status
PPP_PCB
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPP^PCD^PPP_PCB

Send Application Ack: ACK^PCD^ACK

Enhanced Mode Acknowledgement Choreography for PPP^PCD^PPP_PCB

When the MSH-15 value of a PPP^PCD^PPP_PCB message is AL or ER or SU, an ACK^PCD^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPP^PCD^PPP_PCB message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPP^PCD^PPP_PCB message is AL or ER or SU, an ACK^PCD^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPP^PCD^PPP_PCB message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCD^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCD^ACK
NE (none)

ACK^PCB^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCB^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCB^ACK

When the MSH-15 value of an ACK^PCB^ACK message is AL or ER or SU, an ACK^PCB^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCB^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCB^ACK
NE (none)
MSH-16 NE (none)

ACK^PCC^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCC^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCC^ACK

When the MSH-15 value of an ACK^PCC^ACK message is AL or ER or SU, an ACK^PCC^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCC^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCC^ACK
NE (none)
MSH-16 NE (none)

ACK^PCD^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCD^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCD^ACK

When the MSH-15 value of an ACK^PCD^ACK message is AL or ER or SU, an ACK^PCD^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCD^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCD^ACK
NE (none)
MSH-16 NE (none)

PPG/ACK - Patient Pathway Message (Goal-Oriented) (Events PCG, PCH, PCJ)

PPG^PCG^PPG_PCG: Patient Pathway Goal-Oriented Message
HL7 MessageStructure Table - PPG_PCG
Segment Cardinality Must Implement Status
PPG_PCG
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPG^PCG^PPG_PCG

Send Application Ack: ACK^PCG^ACK

Enhanced Mode Acknowledgement Choreography for PPG^PCG^PPG_PCG

When the MSH-15 value of a PPG^PCG^PPG_PCG message is AL or ER or SU, an ACK^PCG^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPG^PCG^PPG_PCG message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPG^PCG^PPG_PCG message is AL or ER or SU, an ACK^PCG^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPG^PCG^PPG_PCG message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCG^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCG^ACK
NE (none)

PPG^PCH^PPG_PCG: Patient Pathway Goal-Oriented Message
HL7 MessageStructure Table - PPG_PCG
Segment Cardinality Must Implement Status
PPG_PCG
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPG^PCH^PPG_PCG

Send Application Ack: ACK^PCH^ACK

Enhanced Mode Acknowledgement Choreography for PPG^PCH^PPG_PCG

When the MSH-15 value of a PPG^PCH^PPG_PCG message is AL or ER or SU, an ACK^PCH^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPG^PCH^PPG_PCG message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPG^PCH^PPG_PCG message is AL or ER or SU, an ACK^PCH^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPG^PCH^PPG_PCG message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCH^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCH^ACK
NE (none)

PPG^PCJ^PPG_PCG: Patient Pathway Goal-Oriented Message
HL7 MessageStructure Table - PPG_PCG
Segment Cardinality Must Implement Status
PPG_PCG
MSH 1..1 Yes
SFT 0..*
UAC 0..1
PID 1..1 Yes
PROVIDER 1..* Yes
PRD 1..1 Yes
CTD 0..*
PATIENT_VISIT 0..1
PV1 1..1 Yes
PV2 0..1
PATHWAY 1..* Yes
PTH 1..1 Yes
NTE 0..*
VAR 0..*
PATHWAY_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL 0..*
GOL 1..1 Yes
NTE 0..*
VAR 0..*
GOAL_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
GOAL_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
PROBLEM 0..*
PRB 1..1 Yes
NTE 0..*
VAR 0..*
PROBLEM_PARTICIPATION 0..*
ROL 1..1 Yes B
PRT 1..1 Yes
VAR 0..*
PROBLEM_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
ORDER 0..*
ORC 1..1 Yes
ORDER_DETAIL 0..1
NTE 0..*
VAR 0..*
1..1 Yes
OBR 1..1 Yes
Hxx 1..1 Yes
ORDER_OBSERVATION 0..*
OBX 1..1 Yes
PRT 0..*
NTE 0..*
VAR 0..*

Original Mode Acknowledgement Choreography for PPG^PCJ^PPG_PCG

Send Application Ack: ACK^PCJ^ACK

Enhanced Mode Acknowledgement Choreography for PPG^PCJ^PPG_PCG

When the MSH-15 value of a PPG^PCJ^PPG_PCG message is AL or ER or SU, an ACK^PCJ^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of a PPG^PCJ^PPG_PCG message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a PPG^PCJ^PPG_PCG message is AL or ER or SU, an ACK^PCJ^ACK message SHALL be sent as an application ack.

When the MSH-16 value of a PPG^PCJ^PPG_PCG message is NE, an application ack SHALL NOT be sent.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCJ^ACK
NE (none)
MSH-16 AL, ER, SU application ack: ACK^PCJ^ACK
NE (none)

ACK^PCG^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCG^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCG^ACK

When the MSH-15 value of an ACK^PCG^ACK message is AL or ER or SU, an ACK^PCG^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCG^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCG^ACK
NE (none)
MSH-16 NE (none)

ACK^PCH^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCH^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCH^ACK

When the MSH-15 value of an ACK^PCH^ACK message is AL or ER or SU, an ACK^PCH^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCH^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCH^ACK
NE (none)
MSH-16 NE (none)

ACK^PCJ^ACK: General Acknowledgment
HL7 MessageStructure Table - ACK
Segment Cardinality Must Implement Status
ACK
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*

Original Mode Acknowledgement Choreography for ACK^PCJ^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^PCJ^ACK

When the MSH-15 value of an ACK^PCJ^ACK message is AL or ER or SU, an ACK^PCJ^ACK message SHALL be sent as an immediate ack.

When the MSH-15 value of an ACK^PCJ^ACK message is NE, an immediate ack SHALL NOT be sent.

Never send an application ack in enhanced mode.

Field Value Send Response
MSH-15 AL, ER, SU immediate ack: ACK^PCJ^ACK
NE (none)
MSH-16 NE (none)

QRY - Patient Care Problem Query (Event PC4)

Retained for backwards compatibility only as of version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

PRR - Patient Problem Response (Event PC5)

Retained for backwards compatibility only as of version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

QRY - Patient Goal Query (Event PC9)

Retained for backwards compatibility only as of version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

PPV - Patient Goal Response (Event PCA)

Retained for backwards compatibility only in version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

QRY - Patient Pathway (Problem-Oriented) Query (Event PCE)

Retained for backwards compatibility only in version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

PTR - Patient Pathway (Problem-Oriented) Response (Event PCF)

Retained for backwards compatibility only in version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

QRY - Patient Pathway (Goal-Oriented) Query (Event PCK)

Retained for backwards compatibility only in version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

PPT - Patient Pathway (Goal-Oriented) Response (Event PCL)

Retained for backwards compatibility only in version 2.4 and removed from the standard as of v2.8; refer to Chapter 5, section 5.4. The original mode query and the QRD/QRF segments have been replaced.

MESSAGE SEGMENTS

GOL - Goal Detail Segment

The goal detail segment contains the data necessary to add, update, correct, and delete the goals for an individual.

HL7 Attribute Table - GOL - Goal Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
GOL
1 00816 Action Code SHALL [1..1] [2..2] ID
2 00817 Action Date/Time SHALL [1..1] DTM
3 00818 Goal ID SHALL [1..1] CWE
4 00819 Goal Instance ID SHALL [1..1] EI
5 00820 Episode of Care ID [0..1] EI
6 00821 Goal List Priority = [0..1] 3 NM
7 00822 Goal Established Date/Time [0..1] DTM
8 00824 Expected Goal Achieve Date/Time [0..1] DTM
9 00825 Goal Classification [0..1] CWE
10 00826 Goal Management Discipline [0..1] CWE
11 00827 Current Goal Review Status [0..1] CWE
12 00828 Current Goal Review Date/Time [0..1] DTM
13 00829 Next Goal Review Date/Time [0..1] DTM
14 00830 Previous Goal Review Date/Time [0..1] DTM
15 00831 Goal Review Interval SHALL NOT W [0..0]
16 00832 Goal Evaluation [0..1] CWE
17 00833 Goal Evaluation Comment = [0..*] 300 ST
18 00834 Goal Life Cycle Status [0..1] CWE
19 00835 Goal Life Cycle Status Date/Time [0..1] DTM
20 00836 Goal Target Type [0..*] CWE
21 00837 Goal Target Name [0..*] XPN
22 02182 Mood Code MAY
True:
False:
C
[1..1]
[0..1]
CNE

GOL-1: Action Code (ID) 00816

(Definition from OH1.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH2.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH3.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH4.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from ORC.35 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either ORC-2 and/or ORC 3 is valued with a unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBR.55 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either an OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from IPC.10 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when the combination of IPC-1, IPC-2, IPC-3, and IPC-4 represents a unique identifier according to Chapter 2, Section 2.10.4.2.

(Definition from BPX.22 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BPX is uniquely identified sufficiently within the specific implementation using BPX-17 or BPX-6 as agreed to by the trading partners and in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BTX.21 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BTX is uniquely identified sufficiently within the specific implementation using BTX-20 or BTX-3 as agreed to by the trading partners in accordance with Chapter 2, Section 2.10.4.2.

(Definition from DON.34 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an DON is uniquely identified sufficiently within the specific implementation using DON-1 in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BUI.13 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BUI is uniquely identified sufficiently within the specific implementation using BUI-2 in accordance with Chapter 2, Section 2.10.4.2

(Definition from RXV.22 in Ch. 4A)

Definition: The intended handling by the receiver of the infusion order is represented by this segment. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from CDO.2 in Ch. 4A)

Definition: The Action Code indicates whether the cumulative dosage segment is intended to be added, deleted, updated, or did not change. If the field is not valued in any CDO segments for the order, the segments are considered to have been sent in snapshot mode. If some but not all CDO segments for the order do not have the action code valued, the default value is Add. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OBR.55 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an either OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBX.31 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an OBX-21 is valued in accordance with guidance in Chapter 2, Section 2.10.4.2.

(Definition from SPM.35 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an SPM-2 or SPM-31 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PRT.2 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

(Definition from CSR.17 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CSR-1 and CSR-4, or CSR-2 and CSR-5 are valued as agreed to by the trading partners in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from CTI.4 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CTI-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from SHP.12 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when SHP-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PAC.9 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when PAC-2 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from GOL.1 in Ch. 12)

Definition: The action code field gives the intent of the problem or goal. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PRB.1 in Ch. 12)

Definition: This field contains the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PTH.1 in Ch. 12)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from DEV.1 in Ch. 17)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

GOL-2: Action Date/Time (DTM) 00817

(Definition from GOL.2 in Ch. 12)

Definition: This field contains the date/time that the operation represented by the action code was performed.

(Definition from PRB.2 in Ch. 12)

Definition: This field contains the date/time that the operation represented by the action code was performed.

GOL-3: Goal ID (CWE) 00818

Definition: This field identifies the goal. This is the identifier from an institution's master list of goals.

GOL-4: Goal Instance ID (EI) 00819

Definition: This field contains the unique identifier assigned by an initiating system to this instance of the goal.

Note: It is required that the value in this field be unique over time. This instance ID identifies a specific instance for a specific patient and is unique across all patients. See entity ID data type description in Chapter 2.


GOL-5: Episode of Care ID (EI) 00820

(Definition from GOL.5 in Ch. 12)

Definition: This field uniquely identifies the episode of care to which this goal applies. See note under "Ongoing issues."

Note: Based on application use, this field is required to be unique over time.


(Definition from PRB.5 in Ch. 12)

Definition: This field uniquely identifies the episode of care to which this problem applies. (See note under "Ongoing issues.")

Note: It is required that this field be unique over time.


GOL-6: Goal List Priority (NM) 00821

Definition: This field prioritizes this goal on a list that is maintained for an individual.

GOL-7: Goal Established Date/Time (DTM) 00822

Definition: This field identifies the date/time when the stated goal was initially created.

GOL-8: Expected Goal Achieve Date/Time (DTM) 00824

Definition: This field contains the projected date/time for achieving the stated goal.

GOL-9: Goal Classification (CWE) 00825

Definition: This field indicates the kind of goal. This field can be used to categorize goals so that they may be managed and viewed independently within different applications (e.g., admission, final, post-operative, pre-operative, outpatient, discharge, etc.).

Note: This field can be used to differentiate separate goal lists that may be managed independently within applications.


GOL-10: Goal Management Discipline (CWE) 00826

Definition: This field indicates the category of caregiver with responsibility for managing this specific goal (e.g., care team, nursing, medicine, respiratory therapy, occupational therapy, dietary etc.). This is a repeating field to allow identification of all disciplines that may have the responsibility for this goal.

GOL-11: Current Goal Review Status (CWE) 00827

Definition: This field contains the current point in the continuum of a goal review cycle (e.g., due, initiated, reviewed, overdue, verified, etc.).

GOL-12: Current Goal Review Date/Time (DTM) 00828

Definition: This field contains the date/time of the current review of the goal.

GOL-13: Next Goal Review Date/Time (DTM) 00829

Definition: This field contains the date/time of the next scheduled goal review.

GOL-14: Previous Goal Review Date/Time (DTM) 00830

Definition: This field contains the date/time that the goal was reviewed prior to the current review.

GOL-15: Goal Review Interval

As of Version 2.5, this field was retained for backward compatibility only and withdrawn and removed as of v2.7. Refer to the TQ1 segment described in Chapter 4.

GOL-16: Goal Evaluation (CWE) 00832

Definition: This field provides an indicator of progress towards achievement of the goal (e.g., achieved, ahead of schedule, delayed, failed to achieve, etc.).

GOL-17: Goal Evaluation Comment (ST) 00833

Definition: This field contains the comments associated with the goal evaluation. Examples of comments that might be entered in this field include: a reason for delay in achieving goal, or a clinical footnote about progress made towards the goal, etc.

GOL-18: Goal Life Cycle Status (CWE) 00834

Definition: This field contains an indication of the state of the goal (e.g., Active, Canceled, Inactive, Suspended, etc.).

GOL-19: Goal Life Cycle Status Date/Time (DTM) 00835

Definition: This field contains the effective date/time of the current goal life cycle status.

GOL-20: Goal Target Type (CWE) 00836

Definition: This field contains the individual/group for whom the goal has been established (e.g., family group, family member, patient, etc.).

Note: This field is focused on a specific person/group that is directly patient-related.


GOL-21: Goal Target Name (XPN) 00837

Definition: This field contains the identification of the person(s) on whom the goal is focused. This is a repeating field which allows for the identification of a group of individuals.

GOL-22: Mood Code (CNE) 02182

(Definition from OBX.22 in Ch. 7)

Definition: This field identifies the actuality of the observation (e.g., intent, request, promise, event). Refer to HL7 Table 0725 – Mood Codes for valid values. This field may only be used with new trigger events and new messages from v 2.6 onward. When this field is not valued in a message that qualifies, then the Value is assumed to be 'EVN'.

Note: OBX-22 Mood Code was introduced in v 2.6 to support Patient Care messaging concepts and constructs. At this time, there are no documented use cases for this field in the context messages as described in this chapter. This statement does not preclude the use of OBX-22, but implementers should exercise caution in using this field outside of the Patient Care context until appropriate use cases are established. While a similar note exists for OBX-21 Observation Instance Identifier, particular care should be taken with OBX-22 as this could modify the intent of the segment/message and create backward compatibility problems.


(Definition from GOL.22 in Ch. 12)

Definition: This field indicates the Mood of the Goal. It allows expression of the context of the problem.

Note: As Mood Code changes the meaning of the segment it must only be used in new messages as of v2.6.


Refer to HL7 Table 0725 – Mood Codes in Chapter 2C, Code Tables, for allowed values.

PRB - Problem Detail Segment

NOTE: This segment will be taken over by the Orders and Observations Work Group.

The problem detail segment contains the data necessary to add, update, correct, and delete the problems of a given individual.

HL7 Attribute Table - PRB - Problem Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
PRB
1 00816 Action Code SHALL [1..1] [2..2] ID
2 00817 Action Date/Time SHALL [1..1] DTM
3 00838 Problem ID SHALL [1..1] CWE
4 00839 Problem Instance ID SHALL [1..1] EI
5 00820 Episode of Care ID [0..1] EI
6 00841 Problem List Priority [0..1] NM
7 00842 Problem Established Date/Time [0..1] DTM
8 00843 Anticipated Problem Resolution Date/Time [0..1] DTM
9 00844 Actual Problem Resolution Date/Time [0..1] DTM
10 00845 Problem Classification [0..1] CWE
11 00846 Problem Management Discipline [0..*] CWE
12 00847 Problem Persistence [0..1] CWE
13 00848 Problem Confirmation Status [0..1] CWE
14 00849 Problem Life Cycle Status [0..1] CWE
15 00850 Problem Life Cycle Status Date/Time [0..1] DTM
16 00851 Problem Date of Onset [0..1] DTM
17 00852 Problem Onset Text = [0..1] 80 ST
18 00853 Problem Ranking [0..1] CWE
19 00854 Certainty of Problem [0..1] CWE
20 00855 Probability of Problem # [0..1] 4 NM
21 00856 Individual Awareness of Problem [0..1] CWE
22 00857 Problem Prognosis [0..1] CWE
23 00858 Individual Awareness of Prognosis [0..1] CWE
24 00859 Family/Significant Other Awareness of Problem/Prognosis = [0..1] 200 ST
25 00823 Security/Sensitivity [0..1] CWE
26 02234 Problem Severity [0..1] CWE
27 02235 Problem Perspective [0..1] CWE
28 02237 Mood Code MAY
True:
False:
C
[1..1]
[0..1]
CNE

The business and/or application must assume the responsibility for maintaining knowledge about data ownership, versioning, and/or audit trail control (for purposes of data integrity). It is also their responsibility to represent the appropriate version of that data.

PRB-1: Action Code (ID) 00816

(Definition from OH1.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH2.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH3.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH4.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from ORC.35 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either ORC-2 and/or ORC 3 is valued with a unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBR.55 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either an OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from IPC.10 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when the combination of IPC-1, IPC-2, IPC-3, and IPC-4 represents a unique identifier according to Chapter 2, Section 2.10.4.2.

(Definition from BPX.22 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BPX is uniquely identified sufficiently within the specific implementation using BPX-17 or BPX-6 as agreed to by the trading partners and in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BTX.21 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BTX is uniquely identified sufficiently within the specific implementation using BTX-20 or BTX-3 as agreed to by the trading partners in accordance with Chapter 2, Section 2.10.4.2.

(Definition from DON.34 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an DON is uniquely identified sufficiently within the specific implementation using DON-1 in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BUI.13 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BUI is uniquely identified sufficiently within the specific implementation using BUI-2 in accordance with Chapter 2, Section 2.10.4.2

(Definition from RXV.22 in Ch. 4A)

Definition: The intended handling by the receiver of the infusion order is represented by this segment. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from CDO.2 in Ch. 4A)

Definition: The Action Code indicates whether the cumulative dosage segment is intended to be added, deleted, updated, or did not change. If the field is not valued in any CDO segments for the order, the segments are considered to have been sent in snapshot mode. If some but not all CDO segments for the order do not have the action code valued, the default value is Add. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OBR.55 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an either OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBX.31 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an OBX-21 is valued in accordance with guidance in Chapter 2, Section 2.10.4.2.

(Definition from SPM.35 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an SPM-2 or SPM-31 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PRT.2 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

(Definition from CSR.17 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CSR-1 and CSR-4, or CSR-2 and CSR-5 are valued as agreed to by the trading partners in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from CTI.4 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CTI-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from SHP.12 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when SHP-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PAC.9 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when PAC-2 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from GOL.1 in Ch. 12)

Definition: The action code field gives the intent of the problem or goal. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PRB.1 in Ch. 12)

Definition: This field contains the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PTH.1 in Ch. 12)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from DEV.1 in Ch. 17)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

PRB-2: Action Date/Time (DTM) 00817

(Definition from GOL.2 in Ch. 12)

Definition: This field contains the date/time that the operation represented by the action code was performed.

(Definition from PRB.2 in Ch. 12)

Definition: This field contains the date/time that the operation represented by the action code was performed.

PRB-3: Problem ID (CWE) 00838

Definition: This field identifies the problem. This is the identifier from an institution's master list of problems.

PRB-4: Problem Instance ID (EI) 00839

Definition: This field contains the identifier assigned by an initiating system to an instance of a problem.

Note: It is required that this value remain unique over time. This instance ID identifies a specific instance for a specific patient and is unique across all patients. See entity ID data type description in Chapter 2.


PRB-5: Episode of Care ID (EI) 00820

(Definition from GOL.5 in Ch. 12)

Definition: This field uniquely identifies the episode of care to which this goal applies. See note under "Ongoing issues."

Note: Based on application use, this field is required to be unique over time.


(Definition from PRB.5 in Ch. 12)

Definition: This field uniquely identifies the episode of care to which this problem applies. (See note under "Ongoing issues.")

Note: It is required that this field be unique over time.


PRB-6: Problem List Priority (NM) 00841

Definition: This field prioritizes this problem on a list that is maintained for the individual.

PRB-7: Problem Established Date/Time (DTM) 00842

Definition: This field contains the date/time when the corresponding problem was initially identified by the caregiver.

PRB-8: Anticipated Problem Resolution Date/Time (DTM) 00843

Definition: This field contains the estimated date/time for resolving the stated problem.

PRB-9: Actual Problem Resolution Date/Time (DTM) 00844

Definition: This field contains the date/time that the problem was actually resolved.

PRB-10: Problem Classification (CWE) 00845

Definition: This field indicates the kind of problem. This field can be used to categorize problems so that they may be managed and viewed independently within different applications (e.g., admission, final, post-operative, pre-operative, outpatient, discharge, etc.).

PRB-11: Problem Management Discipline (CWE) 00846

Definition: This field indicates the category of caregiver with responsibility for managing this specific problem (e.g., care team, nursing, medicine, respiratory therapy, occupational therapy, dietary, etc.). This is a repeating field to allow identification of all disciplines that may have the responsibility for this problem.

PRB-12: Problem Persistence (CWE) 00847

Definition: This field contains the perseverance of a problem (e.g., acute, chronic, etc.).

PRB-13: Problem Confirmation Status (CWE) 00848

Definition: This field contains the verification status of a problem (e.g., confirmed, differential, provisional, rule-out, etc.).

PRB-14: Problem Life Cycle Status (CWE) 00849

Definition: This field contains the current status of the problem at this particular date/time (e.g., active, active-improving, active-stable, active-worsening, inactive, resolved, etc.).

PRB-15: Problem Life Cycle Status Date/Time (DTM) 00850

Definition: This field indicates the effective date/time of the current problem life cycle status.

PRB-16: Problem Date of Onset (DTM) 00851

Definition: This field contains the date/time when the problem began.

PRB-17: Problem Onset Text (ST) 00852

Definition: This field allows for a textual representation of the time when the problem began.

PRB-18: Problem Ranking (CWE) 00853

Definition: This field contains a user-defined prioritization of a problem (e.g., numeric ranking, or the use of words such as "primary," "secondary," etc.).

PRB-19: Certainty of Problem (CWE) 00854

Definition: This field contains a qualitative representation of the certainty of a problem (e.g., HI - high, LO - low, ME - medium, etc.).

PRB-20: Probability of Problem (NM) 00855

Definition: This field contains a quantitative or numeric representation of the certainty that the problem exists for this patient. This field has a valid range of 0 to 1. For example, a healthcare provider may be 75% (.75) sure that the problem has been correctly identified.

Note: We have provided for two different representations of the certainty of the problem due to varying representations in applications.


PRB-21: Individual Awareness of Problem (CWE) 00856

Definition: This field contains the individual's comprehension of the problem (e.g., full, marginal, partial, etc.).

PRB-22: Problem Prognosis (CWE) 00857

Definition: This field contains the prognosis for the individual's problem (e.g., good, poor, etc.).

PRB-23: Individual Awareness of Prognosis (CWE) 00858

Definition: This field contains the individual's comprehension of the prognosis for the problem (e.g., full, marginal, partial, etc.).

PRB-24: Family/Significant Other Awareness of Problem/Prognosis (ST) 00859

Definition: This field indicates the individual's family or significant other's comprehension of the actual problem/prognosis.

PRB-25: Security/Sensitivity (CWE) 00823

Definition: This field contains information about the level of security and/or sensitivity surrounding the problem (e.g., highly sensitive, not sensitive, sensitive, etc.).

PRB-26: Problem Severity (CWE) 02234

Definition: This field indicates the severity of the Problem. Refer to User-defined Table 0836- Problem Severity in Chapter 2C, Code Tables, for suggested values.

PRB-27: Problem Perspective (CWE) 02235

Definition: This field indicates from whose perspective this problem was identified. Refer to User-defined Table 0838 - Problem Perspective in Chapter 2C, Code Tables, for suggested values.

PRB-28: Mood Code (CNE) 02237

Definition: This field indicates the Mood of the Problem. It allows expression of the context of the problem.

Note: As Mood Code changes the meaning of the segment it must only be used in new messages as of v2.6.


Refer to HL7 Table 0725 - Mood Codes in Chapter 2C, Code Tables, for allowed values.

PTH - Pathway Segment

The pathway segment contains the data necessary to add, update, correct, and delete from the record pathways that are utilized to address an individual's health care.

HL7 Attribute Table - PTH - Pathway Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
PTH
1 00816 Action Code SHALL [1..1] [2..2] ID
2 01207 Pathway ID SHALL [1..1] CWE
3 01208 Pathway Instance ID SHALL [1..1] EI
4 01209 Pathway Established Date/Time SHALL [1..1] DTM
5 01210 Pathway Life Cycle Status [0..1] CWE
6

01211 Change Pathway Life Cycle Status Date/Time MAY
True:
False:
C
[1..1]
[0..1]
DTM
7 02239 Mood Code MAY
True:
False:
C
[1..1]
[0..1]
CNE

PTH-1: Action Code (ID) 00816

(Definition from OH1.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH2.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH3.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OH4.2 in Ch. 3)

Definition: This field contains a code defining the action to be taken for this segment. It allows this segment to be sent to delete or update, for example, previously sent information. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from ORC.35 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either ORC-2 and/or ORC 3 is valued with a unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBR.55 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when either an OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from IPC.10 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when the combination of IPC-1, IPC-2, IPC-3, and IPC-4 represents a unique identifier according to Chapter 2, Section 2.10.4.2.

(Definition from BPX.22 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BPX is uniquely identified sufficiently within the specific implementation using BPX-17 or BPX-6 as agreed to by the trading partners and in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BTX.21 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BTX is uniquely identified sufficiently within the specific implementation using BTX-20 or BTX-3 as agreed to by the trading partners in accordance with Chapter 2, Section 2.10.4.2.

(Definition from DON.34 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an DON is uniquely identified sufficiently within the specific implementation using DON-1 in accordance with Chapter 2, Section 2.10.4.2.

(Definition from BUI.13 in Ch. 4)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an BUI is uniquely identified sufficiently within the specific implementation using BUI-2 in accordance with Chapter 2, Section 2.10.4.2

(Definition from RXV.22 in Ch. 4A)

Definition: The intended handling by the receiver of the infusion order is represented by this segment. Refer to HL7 Table 0206 – Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from CDO.2 in Ch. 4A)

Definition: The Action Code indicates whether the cumulative dosage segment is intended to be added, deleted, updated, or did not change. If the field is not valued in any CDO segments for the order, the segments are considered to have been sent in snapshot mode. If some but not all CDO segments for the order do not have the action code valued, the default value is Add. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from OBR.55 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an either OBR-2 and/or OBR-3 is valued with unique identifier in accordance with Chapter 2, Section 2.10.4.2.

(Definition from OBX.31 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an OBX-21 is valued in accordance with guidance in Chapter 2, Section 2.10.4.2.

(Definition from SPM.35 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when an SPM-2 or SPM-31 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PRT.2 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

(Definition from CSR.17 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CSR-1 and CSR-4, or CSR-2 and CSR-5 are valued as agreed to by the trading partners in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from CTI.4 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when CTI-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from SHP.12 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when SHP-1 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from PAC.9 in Ch. 7)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0206 - Segment Action Code for valid values.

The action code can only be used when PAC-2 is valued in accordance with the guidance in Chapter 2, Section 2.10.4.2.

(Definition from GOL.1 in Ch. 12)

Definition: The action code field gives the intent of the problem or goal. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PRB.1 in Ch. 12)

Definition: This field contains the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from PTH.1 in Ch. 12)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/Goal Action Code in Chapter 2C, Code Tables, for valid values.

(Definition from DEV.1 in Ch. 17)

Definition: This field reveals the intent of the message. Refer to HL7 Table 0287 – Problem/goal action code for valid values.

PTH-2: Pathway ID (CWE) 01207

Definition: This field contains the pathway master data identifier associated with the referenced problem or goal. Examples: open heart pathway, new diabetic, total hip replace.

PTH-3: Pathway Instance ID (EI) 01208

Definition: This field contains a value generated by the originating application that represents an associated order placer group number, or other unique identifier assigned to the grouping of pathway directives.

Note: It is required that this value remain unique over time. This instance ID identifies a specific instance for a specific patient and is unique across all patients. See entity ID data type description in Chapter 2.


PTH-4: Pathway Established Date/Time (DTM) 01209

Definition: This field contains the identification of the event time for the current pathway record.

PTH-5: Pathway Life Cycle Status (CWE) 01210

Definition: This field contains an application-specific set of state identifiers (e.g., Active, Suspended, Complete, Canceled, Delayed, Scheduled).

PTH-6: Change Pathway Life Cycle Status Date/Time (DTM) 01211

Definition: This field contains the date/time when pathway has been modified or deactivated. (Marked as conditional – must be filled in if trigger event is update or terminate pathway.)

PTH-7: Mood Code (CNE) 02239

Definition: This field indicates the Mood of the Pathway. It allows expression of the context of the Pathway.

Note: As Mood Code changes the meaning of the segment it must only be used in new messages as of v2.6.


Refer to HL7 Table 0725 - Mood Codes in Chapter 2C, Code Tables, for allowed values.

VAR - Variance Segment

The variance segment contains the data necessary to describe differences that may have occurred at the time when a healthcare event was documented.

HL7 Attribute Table - VAR - Variance Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
VAR
1 01212 Variance Instance ID SHALL [1..1] EI
2 01213 Documented Date/Time SHALL [1..1] DTM
3 01214 Stated Variance Date/Time [0..1] DTM
4 01215 Variance Originator [0..*] XCN
5 01216 Variance Classification [0..1] CWE
6 01217 Variance Description = [0..*] 512 ST

VAR-1: Variance Instance ID (EI) 01212

Definition: This field contains the unique identifier of the specific variance record.

VAR-2: Documented Date/Time (DTM) 01213

Definition: This field contains the time stamp that identifies the timed occurrence of the variance documentation.

VAR-3: Stated Variance Date/Time (DTM) 01214

Definition: This field contains the time stamp that identifies a stated time of the variance which may be different than the time it was documented.

VAR-4: Variance Originator (XCN) 01215

Definition: This field contains the originator (person or system) documenting the variance.

VAR-5: Variance Classification (CWE) 01216

Definition: This field identifies a categorical set of variances. Classification may be used by applications for presentation and processing functions.

VAR-6: Variance Description (ST) 01217

Definition: This field specifies the details of a variance. The content of the field is a string with optional formatting.

REL - Clinical Relationship Segment

The Clinical Relationship segment contains the data necessary to relate two data elements within and/or external to the message at run-time. It also includes information about the relationship.

Relationships are constrained to being between explicit segments of messages rather than beween the identities of entities they reference. Segments are available within the message but related persistent information may not be. Because of the transient nature of messages applications must manage the associations with entities which persist outside or across messages.

Examples:

  • Problem is a consequence of a diagnosis.

  • Diagnosis is supported by observation.

  • Observation is a manifestation of a diagnosis.

  • Complication is a consequence of a procedure.

HL7 Attribute Table - REL - Clinical Relationship Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
REL
1

02240 Set ID –REL MAY
True:
False:
C
[1..1]
[0..1]
[1..4] SI
2 02241 Relationship Type SHALL [1..1] CWE
3 02242 This Relationship Instance Identifier SHALL [1..1] EI
4 02243 Source Information Instance Identifier SHALL [1..1] EI
5 02244 Target Information Instance Identifier SHALL [1..1] EI
6 02245 Asserting Entity Instance ID [0..1] EI
7 02246 Asserting Person [0..1] XCN
8 02247 Asserting Organization [0..1] XON
9 02248 Assertor Address [0..1] XAD
10 02249 Assertor Contact [0..1] XTN
11 02250 Assertion Date Range [0..1] DR
12 02251 Negation Indicator [0..1] [1..1] ID
13 02252 Certainty of Relationship [0..1] CWE
14 02253 Priority No = [0..1] 5 NM
15 02254 Priority Sequence No = [0..1] 5 NM
16 02255 Separability Indicator [0..1] [1..1] ID
17 02455 Source Information Instance Object Type [0..1] ID
18 02456 Target Information Instance Object Type [0..1] ID

REL-1: Set ID –REL (SI) 02240

Definition: This field contains the Set ID of the specific relationship Record.

REL-2: Relationship Type (CWE) 02241

Definition: This field contains the type of the relationship. Refer to User-defined Table 0948 – Relationship Type, as defined in Chapter 2C, Code Tables for suggested values.

REL-3: This Relationship Instance Identifier (EI) 02242

Definition: This field contains the instance identifier of this relationship.

REL-4: Source Information Instance Identifier (EI) 02243

Definition: This field contains the Instance ID of the Source Segment.

REL-5: Target Information Instance Identifier (EI) 02244

Definition: This field contains the Instance ID of the Target Segment.

REL-6: Asserting Entity Instance ID (EI) 02245

Definition: This field contains the Instance ID of the Person or Organization that asserted the relationship.

REL-7: Asserting Person (XCN) 02246

Definition: This field contains the Identifier details of the Person who asserted the relationship.

REL-8: Asserting Organization (XON) 02247

Definition: This field contains the Identifier details of the Organization that asserted the relationship.

REL-9: Assertor Address (XAD) 02248

Definition: This field contains the address of the Person or Organization that asserted the relationship.

REL-10: Assertor Contact (XTN) 02249

Definition: This field contains the address of the Person or Organization that asserted the relationship.

REL-11: Assertion Date Range (DR) 02250

Definition: This field contains the date range during which assertion of the relationship took place.

REL-12: Negation Indicator (ID) 02251

Definition: This field asserts the absence of the relationship for this particular REL segment. This field, if populated and set a value of 'Y', indicates that the given relationship does not exist.

REL-13: Certainty of Relationship (CWE) 02252

Definition: This field contains the certainty of existence of the relationship.

NOTE that there are no suggested values for this coded element.

REL-14: Priority No (NM) 02253

Definition: This field contains the priority number as used, for example, in relative ordering, plans, and workflows.

REL-15: Priority Sequence No (NM) 02254

Definition: This field contains the priority sequence number as used, for example, in relative preference for consideration.

REL-16: Separability Indicator (ID) 02255

Definition: This field indicates whether source and target can be interpreted independently. Refer to HL7 Table 0136 – Yes/no Indicator, as defined in Chapter 2C, Code Tables.

REL-17: Source Information Instance Object Type (ID) 02455

Definition: This field contains the identifier type code drawn from coding system HL70203 describing the object identifed by the Source Information Instance Identifier (REL-4).

REL-18: Target Information Instance Object Type (ID) 02456

Definition: This field contains the identifier type code drawn from coding system HL70203 describing the object identifed by the Target Information Instance Identifier (REL-5).

EXAMPLE TRANSACTIONS

The following is an example of a patient goal message.

MSH|^~VALUEamp;|SENDAP|SENDFAC|RECAP|RECFAC|||PGL^PC4| <cr>

PID||0123456-1||EVERYMAN^ADAM^A|||||||9821111|<cr>

PV1|1|I|2000^2012^01||||004777^ATTEND^AARON^A.|||SUR||||ADM|A0|<cr>

GOL|AD|199505011200|00312^Improve Peripheral Circulation^Goal Master List||||199505011200|199505101200|Due^Review Due^Next Review List|||199505021200||QAM|||ACT^Active^Level Seven Healthcare, Inc. Internal|199505011200| P^Patient^Level Seven Healthcare, Inc. Internal||<cr>

PRT||AD||AT^Attending Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

PRT||AD||EP^Entering Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

PRB|AD|199505011200|04411^Restricted Circulation^Nursing Problem List|| ||199505011200|||IP^Inpatient^Problem Classification List| NU^Nursing^Management Discipline List|Acute^Acute^Persistence List| C^Confirmed^Confirmation Status List|A1^Active^Life Cycle Status List| 199505011200|199504250000||2^Secondary^Ranking List|HI^High^Certainty Coding List||1^Fully^Awareness Coding List|2^Good^Prognosis Coding List|||| <cr>

PRT||AD||AT^Attending Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

OBX|001|TX|^Peripheral Dependent Edema|1|Increasing Edema in lower limbs|<cr>

The following is an example of a patient problem message.

MSH|^~VALUEamp;|SENDAP|SENDFAC|RECAP|RECFAC|||PPR^PC1| <cr>

PID||0123456-1||EVERYMAN^ADAM^A|||||||9821111|<cr>

PV1|1|I|2000^2012^01||||004777^ATTEND^AARON^A.|||SUR||||ADM|A0|<cr>

PRB|AD|199505011200|04411^Restricted Circulation^Nursing Problem List|| ||199505011200|||IP^Inpatient^Problem Classification List| NU^Nursing^Management Discipline List|Acute^Acute^Persistence List| C^Confirmed^Confirmation Status List|A1^Active^Life Cycle Status List| 199505011200|199504250000||2^Secondary^Ranking List|HI^High^Certainty Coding List||1^Fully^Awareness Coding List|2^Good^Prognosis Coding List|||| <cr>

PRT||AD||AT^Attending Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

PRT||AD||EP^Entering Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

OBX|001|TX|^Peripheral Dependent Edema|1|Increasing Edema in lower limbs|<cr>

GOL|AD|199505011200|00312^Improve Peripheral Circulation^Goal Master List||||199505011200|199505101200|Due^Review Due^Next Review List|| 199505021200||QAM|||ACT^Active^ Level Seven Healthcare, Inc. Internal|199505011200| P^Patient^Level Seven Healthcare, Inc.||<cr>

PRT||AD||AT^Attending Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

The following is an example of a patient pathway problem-oriented message.

MSH|^~VALUEamp;|SENDAP|SENDFAC|RECAP|RECFAC|||PPP^PCB| <cr>

PID||0123456-1||EVERYMAN^ADAM^A|||||||9821111|<cr>

PV1|1|I|2000^2012^01||||004777^ATTEND^AARON^A.|||SUR||||ADM|A0|<cr>

PTH|AD^^HL70287|OH457^Open Heart Pathway^AHCPR|0018329078785^PCIS1|199505011200|A1^Active^Pathway Life Cycle Status List|199505011200|<cr>

VAR|84032847876^LOCK|199505011200||^Verify^Virgil^V^^RN|23^Coincident^Variance Class List|Exceeds APACHE III threshold score.|<cr>

PRB|AD|199505011200|04411^Restricted Circulation^Nursing Problem List|| ||199505011200|||IP^Inpatient^Problem Classification List| NU^Nursing^Management Discipline List|Acute^Acute^Persistence List| C^Confirmed^Confirmation Status List|A1^Active^Life Cycle Status List| 199505011200|199504250000||2^Secondary^Ranking List|HI^High^Certainty Coding List||1^Fully^Awareness Coding List|2^Good^Prognosis Coding List|||| <cr>

PRT||AD||AT^Attending Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

PRT||AD||EP^Entering Provider^HL70912|^Admit^Alan^A^^RN||||||199505011200<cr>

ORC|NW|2045^OE||||E|^C^199505011200^199505011200^^TM30^^^^|<cr>

RXO|||3|L|IV|D5W WITH 1/2 NS WITH 20 MEQ KCL EVERY THIRD BOTTLE STARTING WITH

    FIRST||W8&825&A^|N||||||||H30<cr>

ORC|NW|1000^OE|9999999^RX|||E|^Q6H^D10^^^R|||||||<cr>

RXA|1|199505011200|||0047-0402-30^Ampicillin 250 MG TAB^NDC|2|TAB||<cr>

IMPLEMENTATION CONSIDERATIONS

The Patient Care Technical Committee recognizes that this document contains a great deal of information for computer systems that are currently under development. The participating institutions/vendors will be responsible for defining the necessary tables that have been previously discussed. As these tables are defined and clarified, they will be included in this document for distribution.

Applications can have differing orientations for representing problem and goal hierarchies. For example, parent:child relationships may map problem(s) to goal(s), or goal(s) to problem(s). To accommodate these different orientations, the Problem message allows representation of goals that are functionally dependent upon a problem, and the Goal message allows representation of problems that are functionally dependent on a goal. We recognize that institutions will decide on one or the other of the methodologies based on practice preferences.

Outstanding ISSUES

In both the Problem and Goal segments a field named "Episode of Care" has been included. This field is intended to accommodate an entity defined by consensus business rules that defines an episode of care.

Individual businesses/applications must be cognizant of and able to handle data integrity issues that may arise from the fact that problem lists and goal lists may not have a single owner of record. This chapter does not address the need for joint data ownership (of problem and goal data) between two or more front-end clinical applications concurrently supporting patient care in real-time. From a data integrity perspective, problem/goal data must be sourced/originated (and thus owned) by a single application only - for example, a front-end clinical application (source) transmitting to a back-end repository application. This is not recognized to be within the current scope of the Patient Care Committee; therefore, this concern will be submitted to the Infrastructure & Messaging committee for further debate.