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

Draft Website - For Review Purposes Only

Personnel Management

Co-Chair:

Alexander de Leon
Kaiser Permanente

Co-Chair:

Irma Jongeneel-de Haas
HL7 Netherlands

Co-Chair:

Brian Postlethwaite
Health Connex

Co-Chair:

Line Saele
HL7 Norway

Chapter Chair & Editor

Frank Oemig
Deutsche Telekom Healthcare and Security Solutions GmbH, HL7 Germany

Sponsoring Working Group:

Patient Administration WG

List Server:

pafm@lists.hl7.org


PURPOSE

The Personnel Management transactions set provides for the transmission of new or updated administration information about individual healthcare practitioners and supporting staff members. Since many systems (e.g., security, scheduling, orders, etc.), must be able to closely monitor changes in certain information regarding individual healthcare practitioners, the Personnel Management transaction set is used to clearly identify these events. For example, it is important to a Security System to be aware of when a staff member was hired or specific role has been terminated. Prior to Version 2.4, master file updates were the only method to update this information. However, when any of these changes are reported as master file update notifications, it is not obvious which of the data has been changed, and is cumbersome to process efficiently. It should be noted that Personnel Management functions that do not affect healthcare administration (e.g., benefits) are not addressed in this chapter.

Generally, information is entered into a Personnel Management system and passed to other systems requiring individual healthcare practitioner data either in the form of an unsolicited update or a response to a record-oriented query.

This document defines the transactions that occur at the application layer (the seventh level of the ISO-OSI models), that is, the abstract messages. The examples included in this chapter were constructed using the HL7 Encoding Rules, Trigger Events and Messages.

Each trigger event is documented below, along with the applicable form of the message exchange. The notation used to describe the sequence, optionality, and repetition of segments is described in Chapter 2, section 2.12, "Chapter Formats for Defining HL7 Messages."

The trigger events that follow are served by the unsolicited Personnel Management update (PMU) and General Acknowledgment (ACK) response.

The information that is included in any of these trigger event transactions can be more than the minimum necessary to communicate that event. Any of the fields occurring in the segments listed for the message can be used. A few or many fields can be used as agreed upon during implementation. However, please note, that when the contents of a field change for a field that is not necessarily related to the trigger event, it is a matter for implementation negotiation as to whether the receiving systems can capture this changed data.

Usage of Chapter 15 vs. Chapter 8

Chapter 8 deals with master file maintenance.

Chapter 15 manages operational relationships based on trigger events.

TRIGGER EVENTS AND MESSAGE DESCRIPTIONS

PMU/ACK – Add Personnel Record (Event B01)

An event B01 signals to add a new record for healthcare administration information about an individual healthcare practitioner establishing a relationship between that practitioner and the institution.

The EVN segment is used to indicate the effective or planned date.

PMU^B01^PMU_B01: Personnel Record Message
HL7 MessageStructure Table - PMU_B01
Segment Cardinality Must Implement Status
PMU_B01
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*
AFF 0..*
LAN 0..*
EDU 0..*
CER 0..*
NK1 0..*
PRT 0..*
ROL 0..* deprecated

Original Mode Acknowledgement Choreography for PMU^B01^PMU_B01

Send Application Ack: ACK^B01^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B01^PMU_B01

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

When the MSH-15 value of a PMU^B01^PMU_B01 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B01^PMU_B01 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B01^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^B01^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B01^ACK

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

When the MSH-15 value of an ACK^B01^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^B01^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Update Personnel Record (Event B02)

An event B02 signals to update the record with the healthcare administration information about an individual healthcare practitioner. This event should not be used to grant/revoke a certificate.

The EVN segment is used to indicate the effective or planned date.

PMU^B02^PMU_B01: Personnel Record Message
HL7 MessageStructure Table - PMU_B01
Segment Cardinality Must Implement Status
PMU_B01
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*
AFF 0..*
LAN 0..*
EDU 0..*
CER 0..*
NK1 0..*
PRT 0..*
ROL 0..* deprecated

Original Mode Acknowledgement Choreography for PMU^B02^PMU_B01

Send Application Ack: ACK^B02^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B02^PMU_B01

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

When the MSH-15 value of a PMU^B02^PMU_B01 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B02^PMU_B01 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B02^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^B02^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B02^ACK

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

When the MSH-15 value of an ACK^B02^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^B02^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Delete Personnel Record (Event B03)

An event B03 signals to delete the record with the healthcare administration information about an individual healthcare practitioner to correct erroneous entries.

The EVN segment is used to indicate the effective or planned date.

PMU^B03^PMU_B03: Delete Personnel Record Message
HL7 MessageStructure Table - PMU_B03
Segment Cardinality Must Implement Status
PMU_B03
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes

Original Mode Acknowledgement Choreography for PMU^B03^PMU_B03

Send Application Ack: ACK^B03^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B03^PMU_B03

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

When the MSH-15 value of a PMU^B03^PMU_B03 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B03^PMU_B03 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B03^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^B03^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B03^ACK

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

When the MSH-15 value of an ACK^B03^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^B03^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Activate Practicing Person (Event B04)

An event B04 signals that a staff member is available for work (e.g., schedules can be created) and has a relationship with the institution. This message applies to STF-7.

PMU^B04^PMU_B04: Activate Practicing Person Message
HL7 MessageStructure Table - PMU_B04
Segment Cardinality Must Implement Status
PMU_B04
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*

Original Mode Acknowledgement Choreography for PMU^B04^PMU_B04

Send Application Ack: ACK^B04^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B04^PMU_B04

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

When the MSH-15 value of a PMU^B04^PMU_B04 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B04^PMU_B04 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B04^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^B04^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B04^ACK

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

When the MSH-15 value of an ACK^B04^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^B04^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Deactivate Practicing Person (Event B05)

An event B05 indicates that a staff member is temporarily unavailable for work, while maintaining a relationship with the institution. This message applies to STF-7.

PMU^B05^PMU_B04: Deactivate Practicing Person Message
HL7 MessageStructure Table - PMU_B04
Segment Cardinality Must Implement Status
PMU_B04
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*

Original Mode Acknowledgement Choreography for PMU^B05^PMU_B04

Send Application Ack: ACK^B05^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B05^PMU_B04

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

When the MSH-15 value of a PMU^B05^PMU_B04 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B05^PMU_B04 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B05^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^B05^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B05^ACK

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

When the MSH-15 value of an ACK^B05^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^B05^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Terminate Practicing Person (Event B06)

An event B06 signals that the formal relationship between a staff member and the institution has ended (i.e., upon termination).

PMU^B06^PMU_B04: Terminate Practicing Person Message
HL7 MessageStructure Table - PMU_B04
Segment Cardinality Must Implement Status
PMU_B04
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*

Original Mode Acknowledgement Choreography for PMU^B06^PMU_B04

Send Application Ack: ACK^B06^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B06^PMU_B04

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

When the MSH-15 value of a PMU^B06^PMU_B04 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B06^PMU_B04 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B06^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^B06^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B06^ACK

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

When the MSH-15 value of an ACK^B06^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^B06^ACK
NE (none)
MSH-16 NE (none)

QBP/RSP – Query Information (Event Q25/K25)

The following trigger event is served by the following Conformance Statement: Another application determines a need for Personnel data about a person and sends a query to a system providing this information.

Conformance Statement ID:

Q25

Query Table Type:

Query

Query Name:

Personnel Information by Segment

Query Trigger:

QBP^Q25^QBP_Q21

Query Mode:

Both

Response Trigger:

RSP^K25^RSP_K25

Query Characteristics

Returns response sorted by STF-3 Staff Name

Purpose:

Retrieve all available personnel information based upon the values of one or more commonly used search parameters

Response Characteristics:

Returns response sorted by StaffName unless otherwise specified.

Based on Segment Pattern:

PMU_B01


QBP^Q25^QBP_Q21: Query Personnel Information Message
HL7 MessageStructure Table - QBP_Q21
Segment Cardinality Must Implement Status
QBP_Q21

Original Mode Acknowledgement Choreography for QBP^Q25^QBP_Q21

Send Application Ack: RSP^K25^RSP_K25

Enhanced Mode Acknowledgement Choreography for QBP^Q25^QBP_Q21

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

When the MSH-15 value of a QBP^Q25^QBP_Q21 message is NE, an immediate ack SHALL NOT be sent.

When the MSH-16 value of a QBP^Q25^QBP_Q21 message is AL or ER or SU, a RSP^K25^RSP_K25 message SHALL be sent as an application ack.

When the MSH-16 value of a QBP^Q25^QBP_Q21 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

Fld. Seq.

ColName

Key/

Search

Sort

LEN

TYPE

Opt

Rep

Match Op

TBL

Segment Field Name

LOINC or HL7 code/ Domain

Element Name

1

StaffIDCode

S

Y

60

CX

O

=

STF.2

STF-2: Staff ID Code

2

StaffName

S

Y

48

XPN

O

=

STF.3

STF-3: Staff Name

3

PractitionerCategory

S

Y

3

IS

O

Y

in

0186

PRA.3

PRA-3: Practitioner Category

4

Language

S

Y

60

CWE

O

Y

in

0296

LAN.2

LAN-2: Language

5

LanguageAbility

Y

60

CWE

C

Y

in

0403

LAN.3

LAN-3: Language Ability

6

LanguageProficiency

Y

60

CWE

C

Y

in

0404

LAN.4

LAN-4: Language Proficiency


Input Parameter

Comp Name

DT

Description

StaffIDCode

CX

Components: <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility (HD)>

This field contains a personnel identification code or institution user number, used by the institution to identify the requested person.

If this field is not valued, all values for this field are considered to be a match.

The following components may be specified:

ID

If this field, STF.2.1, is not valued, all values for this field are considered to be a match.

Assigning Authority

If this field, STF.2.4, is not valued, all values for this field are considered to be a match.

Identifier type code

If this field, STF.2.5, is not valued, all values for this field are considered to be a match.

StaffName

XPN

If this field is not valued, all values for this field are considered to be a match.

PractitionerCategory

IS

If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified.

Language

CWE

If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified.

LanguageAbility

CWE

The Server will evaluate this field only if the Language field is specified; otherwise, this field will be ignored. If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified.

LanguageProficiency

CWE

The Server will evaluate this field only if the Language field is specified; otherwise, this field will be ignored. If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified.


RSP^K25^RSP_K25: Personnel Information Response Message
HL7 MessageStructure Table - RSP_K25
Segment Cardinality Must Implement Status
RSP_K25
MSH 1..1 Yes
SFT 0..*
UAC 0..1
MSA 1..1 Yes
ERR 0..*
QAK 1..1 Yes
QPD 1..1 Yes
RCP 1..1 Yes
STAFF 1..* Yes
STF 1..1 Yes
PRA 0..*
ORG 0..*
AFF 0..*
LAN 0..*
EDU 0..*
CER 0..*
NK1 0..*
PRT 0..*
ROL 0..* deprecated
DSC 0..1

Original Mode Acknowledgement Choreography for RSP^K25^RSP_K25

Send Immediate Ack: ACK^K25^ACK

Enhanced Mode Acknowledgement Choreography for RSP^K25^RSP_K25

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

When the MSH-15 value of a RSP^K25^RSP_K25 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^K25^ACK
NE (none)
MSH-16 NE (none)

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 SHALL always be set to NE (Never).

PMU/ACK – Grant Certificate/Permission (Event B07)

An event B07 indicates that a health professional is granted a certificate/permission for a special purpose.

A permission is issued by an organization and documented in form of a certificate. An update of a role results in an issuing of a new certificate.

The EVN segment is used to indicate the effective or planned date.

PMU^B07^PMU_B07: Grant Certificate Message
HL7 MessageStructure Table - PMU_B07
Segment Cardinality Must Implement Status
PMU_B07
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..1
CERTIFICATE 0..*
CER 1..1 Yes
PRT 0..*
ROL 0..* deprecated

Original Mode Acknowledgement Choreography for PMU^B07^PMU_B07

Send Application Ack: ACK^B07^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B07^PMU_B07

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

When the MSH-15 value of a PMU^B07^PMU_B07 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B07^PMU_B07 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B07^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^B07^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B07^ACK

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

When the MSH-15 value of an ACK^B07^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^B07^ACK
NE (none)
MSH-16 NE (none)

PMU/ACK – Revoke Certificate/Permission (Event B08)

An event B08 indicates that a certificate/permission for a health professional is revoked.

The EVN segment is used to indicate the effective or planned date.

PMU^B08^PMU_B08: Revoke Certificate Message
HL7 MessageStructure Table - PMU_B08
Segment Cardinality Must Implement Status
PMU_B08
MSH 1..1 Yes
SFT 0..*
UAC 0..1
EVN 1..1 Yes
STF 1..1 Yes
PRA 0..1
CER 0..*

Original Mode Acknowledgement Choreography for PMU^B08^PMU_B08

Send Application Ack: ACK^B08^ACK

Enhanced Mode Acknowledgement Choreography for PMU^B08^PMU_B08

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

When the MSH-15 value of a PMU^B08^PMU_B08 message is NE, an immediate ack SHALL NOT be sent.

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

When the MSH-16 value of a PMU^B08^PMU_B08 message is NE, an application ack SHALL NOT be sent.

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

There is not supposed to be an Application Level acknowledgement to an Application Level Acknowledgement message. In Enhanced Mode, MSH-16 in the Application Acknowledgement message SHALL always be set to NE (Never).

ACK^B08^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^B08^ACK

Send An Acknowlegment is never sent in original mode.

Enhanced Mode Acknowledgement Choreography for ACK^B08^ACK

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

When the MSH-15 value of an ACK^B08^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^B08^ACK
NE (none)
MSH-16 NE (none)

MESSAGE SEGMENTS

The following segments are defined for the Personnel Management messages.

AFF - Professional Affiliation Segment

The AFF segment adds detailed information regarding professional affiliations with which the staff member identified by the STF segment is/was associated.

HL7 Attribute Table - AFF - Professional Affiliation Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
AFF
1 01427 Set ID – AFF SHALL [1..1] [1..4] SI
2 01444 Professional Organization SHALL [1..1] XON
3 01445 Professional Organization Address [0..1] XAD
4 01446 Professional Organization Affiliation Date Range [0..*] DR
5 01447 Professional Affiliation Additional Information = [0..1] 60 ST

AFF-1: Set ID – AFF (SI) 01427

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

AFF-2: Professional Organization (XON) 01444

Definition: This field contains the official name of the association promoting specific professional interests with which the staff member is affiliated.

AFF-3: Professional Organization Address (XAD) 01445

Definition: This field contains the postal address of the professional organization with which the Staff Member is associated.

AFF-4: Professional Organization Affiliation Date Range (DR) 01446

Definition: This field contains the period the staff member started and ended membership in the professional organization.

AFF-5: Professional Affiliation Additional Information (ST) 01447

Definition: This field contains miscellaneous additional information related to the staff member's membership in the professional organization.

CER - Certificate Detail Segment

The CER segment adds detailed information regarding the formal authorizations to provide a service (e.g. licenses, certificates) held by the health professional identified by the STF segment.

HL7 Attribute Table - CER - Certificate Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
CER
1 01856 Set ID – CER SHALL [1..1] [1..4] SI
2 01857 Serial Number = [0..1] 80 ST
3 01858 Version = [0..1] 80 ST
4 01859 Granting Authority [0..1] XON
5 01860 Issuing Authority [0..1] XCN
6 01861 Signature [0..1] ED
7 01862 Granting Country [0..1] [3..3] ID
8 01863 Granting State/Province [0..1] CWE
9 01864 Granting County/Parish [0..1] CWE
10 01865 Certificate Type [0..1] CWE
11 01866 Certificate Domain [0..1] CWE
12

01867 Subject ID MAY
True:
False:
C
[1..1]
[0..1]
EI
13 01907 Subject Name SHALL = [1..1] 250 ST
14 01868 Subject Directory Attribute Extension [0..*] CWE
15 01869 Subject Public Key Info [0..1] CWE
16 01870 Authority Key Identifier [0..1] CWE
17 01871 Basic Constraint [0..1] [1..1] ID
18 01872 CRL Distribution Point [0..*] CWE
19 01875 Jurisdiction Country [0..1] [3..3] ID
20 01873 Jurisdiction State/Province [0..1] CWE
21 01874 Jurisdiction County/Parish [0..1] CWE
22 01895 Jurisdiction Breadth [0..*] CWE
23 01876 Granting Date [0..1] DTM
24 01877 Issuing Date [0..1] DTM
25 01878 Activation Date [0..1] DTM
26 01879 Inactivation Date [0..1] DTM
27 01880 Expiration Date [0..1] DTM
28 01881 Renewal Date [0..1] DTM
29 01882 Revocation Date [0..1] DTM
30 01883 Revocation Reason Code [0..1] CWE
31 01884 Certificate Status Code [0..1] CWE

CER-1: Set ID – CER (SI) 01856

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

CER-2: Serial Number (ST) 01857

Definition: The serial number uniquely identifies the attribute certificate within the scope of its issuer. This field contains the number and/or characters that identify the certificate held by the health professional.

An attribute certificate is a data structure which certifies (either digitally or manually) that one or more attributes (e.g., descriptors, capabilities, qualifications, etc.) are associated with a particular entity as verified/certified by the attribute authority (e.g., Credentialing Organization (US), Physician Chamber "Ärztekammer" (D), Physicians Statutory Association "Kassenärztliche Vereinigung" (D)).

CER-3: Version (ST) 01858

Definition: The version number differentiates among different versions of the attribute certificate.

CER-4: Granting Authority (XON) 01859

Definition: It specifies the authority that granted the certificate to the person.

CER-5: Issuing Authority (XCN) 01860

Definition: Specifies the authority that issued the certificate to the person.

CER-6: Signature (ED) 01861

(Definition from CER.6 in Ch. 15)

Definition: Digital Signature of the certifying authority. The Digital Signature includes a seal concept and is verifiable.

(Definition from STF.41 in Ch. 15)

Definition: Digital Signature of the staff member. The Digital Signature includes a seal concept and is verifiable.

CER-7: Granting Country (ID) 01862

Definition: ID of the country granting the certificate. Refer to External Table 0399 – Country Code for valid values.

CER-8: Granting State/Province (CWE) 01863

Definition: State/province granting the certificate. Refer to User-defined Table 0347 – State/Province for valid values (in Chapter 2)

CER-9: Granting County/Parish (CWE) 01864

Definition: County/parish granting the certificate. Refer to User-defined Table 0289 – County/Parish for valid values (in Chapter 2).

CER-10: Certificate Type (CWE) 01865

Definition: This field specifies the certificate's classification, e.g., being a privilege, permission, or qualification certificate.

CER-11: Certificate Domain (CWE) 01866

Definition: This field specifies the subject area to which the certificate is applicable, e.g., administrative, medical, or nursing issues.

CER-12: Subject ID (EI) 01867

Definition: This field expresses the identifier of the certificate's subject as used by the certifying body. (The subject is the owner of the certificate, e.g., person, organization, device, application, component.) If the certificate is expressed as a X.509 document this field is required.

CER-13: Subject Name (ST) 01907

Definition: This field defines the name of the subject of the certificate as used by the certifying body.

CER-14: Subject Directory Attribute Extension (CWE) 01868

Definition: In individual identity certificates, this Subject Directory Attribute extension MAY contain a Healthcare Professional Role attribute and may contain a Qualified Certificate Statement attribute. In addition, Subject Directory Attributes MAY contain other attributes not specified by this technical specification.

CER-15: Subject Public Key Info (CWE) 01869

Definition: This field contains the algorithm identifier. Referred to this field, the X.509 extension field MAY contain a Subject Public Key Identifier to identify the public key used in the Subject Public Key Info.

X.509 is an ISO standard specifying certificates.

CER-16: Authority Key Identifier (CWE) 01870

Definition: The Authority Key Identifier extension SHALL identify the public key to be used to verify the signature of the certificate. It enables distinct keys, used by one CA, to be distinguished (e.g., as key updating occurs).

CER-17: Basic Constraint (ID) 01871

Definition: The Basic Constraints extension contains a boolean used to specify whether or not the subject can act as a CA (certificate authority), using the certified key to sign certificates.

CER-18: CRL Distribution Point (CWE) 01872

Definition: The Certificate Revocation List (CRL) Distribution Point extension SHALL identify the location of the associated CRL (or Authority Revocation List (ARL) for attribute certificates) in the PKI directory.

CER-19: Jurisdiction Country (ID) 01875

Definition: This field contains the country for which the qualification is valid. Refer to External Table 0399 – Country Code for valid values.

CER-20: Jurisdiction State/Province (CWE) 01873

Definition: This field contains the state for which the qualification is valid. HL7 suggests using values in User-defined Table 0347 – State/Province.

CER-21: Jurisdiction County/Parish (CWE) 01874

Definition: This field contains the county/parish for which the qualification is valid. HL7 suggests using values in User-defined Table 0289 – County/Parish.

CER-22: Jurisdiction Breadth (CWE) 01895

Definition: This field contains the breadth/extent of the jurisdiction where the qualification is valid. HL7 suggests using values in User-defined Table 0547 – Jurisdictional Breadth.

Refer to User-defined Table 0547 – Jurisdictional Breadth in Chapter 2C, Code Tables, for valid values. This table contains values for County, Parish, County etc.

CER-23: Granting Date (DTM) 01876

Definition: This field contains the date when the certificate was granted.

CER-24: Issuing Date (DTM) 01877

Definition: This field contains the date/time when the certificate was issued.

CER-25: Activation Date (DTM) 01878

Definition: This field contains the date/time when the certificate became or will become active.

CER-26: Inactivation Date (DTM) 01879

Definition: This field contains the date/time when the certificate became or will become inactive.

CER-27: Expiration Date (DTM) 01880

Definition: This field contains the date/time when the certificate expires or will expire.

CER-28: Renewal Date (DTM) 01881

Definition: This field contains the date/time when the certificate must/will/ be / has been renewed.

CER-29: Revocation Date (DTM) 01882

Definition: This field contains the date/time when the certificate has been revoked.

CER-30: Revocation Reason Code (CWE) 01883

Definition: This field contains the reason for revoking the certificate (e.g., having been compromised, changes of conditions/environment, etc.)

CER-31: Certificate Status Code (CWE) 01884

Definition: This field contains the state of the certificate held by the health professional, such as provisional, revoked, etc. Refer to User-defined Table 0536 – Certificate Status in Chapter 2C, Code Tables, for suggested values.

EDU - Educational Detail Segment

The EDU segment adds detailed educational information to the staff member identified by the STF segment. An EDU segment may optionally follow an STF segment. An EDU segment must always have been preceded by a corresponding STF segment.

HL7 Attribute Table - EDU - Educational Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
EDU
1 01448 Set ID – EDU SHALL [1..1] [1..4] SI
2 01449 Academic Degree [0..1] CWE
3 01597 Academic Degree Program Date Range [0..1] DR
4 01450 Academic Degree Program Participation Date Range [0..1] DR
5 01451 Academic Degree Granted Date [0..1] DT
6 01452 School [0..1] XON
7 01453 School Type Code [0..1] CWE
8 01454 School Address [0..1] XAD
9 01885 Major Field of Study [0..*] CWE

EDU-1: Set ID – EDU (SI) 01448

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

EDU-2: Academic Degree (CWE) 01449

Definition: This field contains the standard classification awarded upon completion of a unified program of study. HL7 suggests using values in User-defined Table 0360 - Degree/License/Certificate.

EDU-3: Academic Degree Program Date Range (DR) 01597

Definition: This field contains the date range when the academic degree program took place.

EDU-4: Academic Degree Program Participation Date Range (DR) 01450

Definition: This field contains the date range during which the staff member participated in the academic degree program.

EDU-5: Academic Degree Granted Date (DT) 01451

Definition: This field contains the date the academic degree was granted to the staff member.

EDU-6: School (XON) 01452

Definition: This field contains the official name of the academic institution that granted the degree to the Staff Member.

EDU-7: School Type Code (CWE) 01453

Definition: This field contains the categorization of the academic institution that granted the degree to the Staff Member. HL7 suggests using values in User-defined Table 0402 – School Type.

Refer to User-defined Table 0402 – School Type in Chapter 2C, Code Tables, for valid values. This table contains values for graduate, medical etc.

EDU-8: School Address (XAD) 01454

Definition: This field contains the postal address of the academic institution that granted the degree to the Staff Member.

EDU-9: Major Field of Study (CWE) 01885

Definition: This field contains the subject of academic study associated with the specific academic degree program pursued by the staff member as his/her area of specialization.

LAN - Language Detail Segment

The LAN segment adds detailed language information to the staff member identified by the STF segment. An LAN segment may optionally follow an STF segment. An LAN segment must always have been preceded by a corresponding STF segment.

HL7 Attribute Table - LAN - Language Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
LAN
1 01455 Set ID – LAN SHALL [1..1] [1..4] SI
2 01456 Language Code SHALL [1..1] CWE
3 01457 Language Ability Code [0..*] CWE
4 01458 Language Proficiency Code [0..1] CWE

LAN-1: Set ID – LAN (SI) 01455

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

LAN-2: Language Code (CWE) 01456

Definition: This field contains the language about which the Staff Member's has some knowledge. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 – Primary Language.

LAN-3: Language Ability Code (CWE) 01457

Definition: This field contains the ability the Staff Member possesses with respect to the language. HL7 recommends using values in HL7 Table 0403 - Language Ability.

Refer to HL7 Table 0403 – Language Ability in Chapter 2C, Code Tables, for valid values. This table contains values for the Staff Member's ability to read, write, understand, etc.

LAN-4: Language Proficiency Code (CWE) 01458

Definition: This field contains the level of knowledge the Staff Member possesses with respect to the language ability. HL7 suggests using values in HL7 Table 0404 - Language Proficiency.

Refer to HL7 Table 0404 – Language Proficiency in Chapter 2C, Code Tables, for valid values. This table contains values for excellent, poor, fair etc.

ORG - Practitioner Organization Unit Segment

The ORG segment relates a practitioner to an organization unit and adds detailed information regarding the practitioner's practicing specialty in that organization unit. An ORG segment may optionally follow an STF segment. An ORG segment must always have been preceded by a corresponding STF segment. If no organization unit is specified, this segment is used to relate practitioners with their practicing specialties, including effective and end dates. When it is not necessary to record organization unit or dates associated with the practicing specialty, this data is recorded in PRA-3-Practitioner Category.

HL7 Attribute Table - ORG - Practitioner Organization Unit Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
ORG
1 01459 Set ID – ORG SHALL [1..1] [1..4] SI
2 01460 Organization Unit Code [0..1] CWE
3 01625 Organization Unit Type Code [0..1] CWE
4 01462 Primary Org Unit Indicator [0..1] [1..1] ID
5 01463 Practitioner Org Unit Identifier [0..1] CX
6 01464 Health Care Provider Type Code [0..1] CWE
7 01614 Health Care Provider Classification Code [0..1] CWE
8 01615 Health Care Provider Area of Specialization Code [0..1] CWE
9 01465 Effective Date Range [0..1] DR
10 01276 Employment Status Code [0..1] CWE
11 01467 Board Approval Indicator [0..1] [1..1] ID
12 01468 Primary Care Physician Indicator [0..1] [1..1] ID
13 01891 Cost Center Code [0..*] CWE

ORG-1: Set ID – ORG (SI) 01459

Definition: This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc.

ORG-2: Organization Unit Code (CWE) 01460

Definition: This field contains the hierarchical components of the organization unit, as defined by the institution. Refer to User-defined Table 0405 - Organization Unit for suggested values.

Refer to User-defined Table 0405 – Organization Unit in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

ORG-3: Organization Unit Type Code (CWE) 01625

Definition: This field contains a code indicating the classification of the organization unit. HL7 suggests using values in User-defined Table 0474 - Organization Unit Type.

Refer to User-defined Table 0474 – Organization Unit Type in Chapter 2C, Code Tables, for valid values. This table contains values for department, facility etc.

ORG-4: Primary Org Unit Indicator (ID) 01462

Definition: This field contains an indicator for whether this organization unit is the primary organization unit for this practitioner. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  •     Y    this is the primary organization unit

  •     N    this is not the primary organization unit

ORG-5: Practitioner Org Unit Identifier (CX) 01463

Definition: This field contains an identification code used by the institution to identify this person at this specific organization unit. If the person is identified with the same code at all organization units, then this data should be coded in STF-2 Staff ID Codes.

ORG-6: Health Care Provider Type Code (CWE) 01464

Definition: This field contains the major grouping of the service or occupation of the practitioner at a specific organization unit, for example, Behavioral Health & Social Service. HL7 suggests using values derived from the ANSI ASC X12 Health Care Provider Taxonomy, Level 1 - Type.

Refer to HL7 Table 0452 – Health Care Provider Type Code in Chapter 2C, Code Tables, for valid values.

ORG-7: Health Care Provider Classification Code (CWE) 01614

Definition: This field contains the more specific service or occupation within the health care provider type of the practitioner at a specific organization unit, for example, Counselor. HL7 suggests using values derived from the ANSI ASC X12 Health Care Provider Taxonomy, Level 2 – Classification.

Refer to HL7 Table 0453 – Health Care Provider Classification in Chapter 2C, Code Tables, for valid values.

ORG-8: Health Care Provider Area of Specialization Code (CWE) 01615

Definition: This field contains the segment of the population that a health care provider chooses to service, a specific medical service, a specialization in treating a specific disease, or any other descriptive characteristic about the provider's practice relating to the services rendered of the practitioner at a specific organization unit, for example, Mental Health. HL7 suggests using values derived from the ANSI ASC X12 Health Care Provider Taxonomy, Level 3 - specialization.

Refer to HL7 Table 0454 – Health Care Provider Area of Specialization in chapter 2C for valid values.

ORG-9: Effective Date Range (DR) 01465

Definition: This field contains the date range in which the practitioner started and ended working at the specific organization unit in the specific practicing specialty category.

ORG-10: Employment Status Code (CWE) 01276

(Definition from ORG.10 in Ch. 15)

Definition: This field contains a code indicating the working relationship of the practitioner at this organization unit. It may be different than the work status specified in STF-20. Refer to User-defined Table 0066 - Employment Status, in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.20 in Ch. 15)

Definition: This field contains the code that indicates the staff member's employment status, e.g., full-time, part-time, self-employed, etc. Refer to User-defined Table 0066 - Employment Status in Chapter 2C, Code Tables, for suggested values.

ORG-11: Board Approval Indicator (ID) 01467

Definition: This field contains an indicator for whether this practice specialty requires board approval. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    this practice specialty requires board approval

  • N    this practice specialty does not require board approval

ORG-12: Primary Care Physician Indicator (ID) 01468

Definition: This field contains an indicator for whether this practice specialty may act as a primary care physician (PCP). Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    this practice specialty may act as a primary care physician

  • N    this practice specialty may not act as a primary care physician

ORG-13: Cost Center Code (CWE) 01891

(Definition from ORG.13 in Ch. 15)

Definition: This field contains the cost center name or code assigned to this organization unit. Refer to HL7 User-defined Table 0539 – Cost Center Code for valid values.

(Definition from STF.36 in Ch. 15)

Definition: This field describes the organization unit in the General Ledger to which the staff member is currently assigned. It is sometimes referred to as the "home" cost center because it is the organization unit to which the staff member's regular costs are accrued. Refer to User-defined Table 0539 – Cost Center Code in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

PRA - Practitioner Detail Segment

The Technical Steward for the PRA segment is PA and Personnel Management.

The PRA segment adds detailed medical practitioner information to the personnel identified by the STF segment. A PRA segment may optionally follow an STF segment. A PRA segment must always have been preceded by a corresponding STF segment. The PRA segment may also be used for staff who work in healthcare who are not practitioners but need to be certified, e.g., "medical records staff."

HL7 Attribute Table - PRA - Practitioner Detail Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
PRA
1

00685 Primary Key Value - PRA MAY
True:
False:
C
[1..1]
[0..1]
CWE
2 00686 Practitioner Group [0..*] CWE
3 00687 Practitioner Category [0..*] CWE
4 00688 Provider Billing [0..1] [1..1] ID
5 00689 Specialty [0..*] SPD
6 00690 Practitioner ID Numbers B [0..*] PLN
7 00691 Privileges [0..*] PIP
8 01296 Date Entered Practice [0..1] DT
9 01613 Institution [0..1] CWE
10 01348 Date Left Practice [0..1] DT
11 01388 Government Reimbursement Billing Eligibility [0..*] CWE
12 01616 Set ID - PRA MAY
True:
False:
C
[1..1]
[0..1]
[1..4] SI

PRA-1: Primary Key Value - PRA (CWE) 00685

Definition: For MFN Master File Notification, this field is required and must match MFE-4 Primary Key Value to identify which entry is being referenced. For all other messages, this field should not be used. Refer to Table 0681 - Primary Key Value - PRA in Chapter 2C for valid values.

PRA-2: Practitioner Group (CWE) 00686

Definition: This field contains the name and/or code of a group of practitioners to which this practitioner belongs. Refer to User-defined Table 0358 Practitioner Group for suggested values.

Refer to User.defined Table 0358 – Practitioner Group in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

PRA-3: Practitioner Category (CWE) 00687

Definition: This field contains the category of practitioner. Refer to User-defined Table 0186 - Practitioner Category for suggested values. Values may include codes for staff physician, courtesy physician, resident, physician assistant, physical therapist, psychiatrist, psychologist, pharmacist, registered nurse, licensed practical nurse, licensed vocational nurse, nurse practitioner, etc. If the provider works in different Practitioner Categories in different organization units, then this information should be recorded separately in ORG-6,7,8.

Refer to User.defined Table 0186 – Practitioner Category in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

PRA-4: Provider Billing (ID) 00688

Definition: This field indicates how provider services are billed. Refer to HL7 Table 0187 - Provider Billing for valid values.

Refer to HL7 Table 0187 – Provider Billing for valid values. This table contains values for provider or institutional billing.

PRA-5: Specialty (SPD) 00689

Definition: This repeating field is made up of multiple components to record the practitioner's specialties. The multiple components of each specialty are: (1) specialty name or abbreviation, identifies provider's specialty, (2) name of specialty governing board, (3) Certification Status, (4) certified date contains the date of certification, if certified. Refer to HL7 Table 0337 – Certification Status for valid values.

Refer to HL7 Table 0337 – Certification Status in Chapter 2C, Code Tables, for valid values. This table contains values for certified or eligible.

PRA-6: Practitioner ID Numbers (PLN) 00690

Definition: As of version 2.5, this field has been retained for backward compatibility only. Practitioner ID numbers should be contained in STF-2 Staff Identifier List. This repeating field contains this practitioner's license numbers and other ID numbers. This is a field made up of the following components: (1) the ID number, and (2) the type of number, and optionally (3) the state or province in which it is valid, if relevant, or other qualifying information. It is recommended that state qualifications use the abbreviations from the postal service of the country. The practitioner ID number type (component 2) is a user-defined table (User-defined Table 0338 – Practitioner ID Number in Chapter 2C, Code Tables).

PRA-7: Privileges (PIP) 00691

Definition: This field contains the institutional privileges which this provider may exercise. Depends upon institutional needs. For example, admit, transfer, discharge, place orders, verify orders, review results, etc. Can also be used for privileges other than patient services. This is a repeating field, with each privilege made up of the following components: (1) privilege; (2) privilege class; (3) privilege expiration date, if any; (4) privilege activation date, if any, and (5) facility. Note that the privilege and privilege class components are CWE data types, and thus they are encoded with the subcomponent delimiter (&) rather than the component delimiter (^). The facility component is an EI data type specifying the facility to which the privilege applies and is encoded with the subcomponent delimiter (&) rather than the component delimiter (^). The facility component is an EI data type specifying the facility to which the privilege applies and is encoded with the subcomponent delimiter (&) rather than the component delimiter (^).

PRA-8: Date Entered Practice (DT) 01296

Definition: This field contains the date the practitioner began practicing at the present institution (e.g., at hospital, at physician organization, at managed care network).

PRA-9: Institution (CWE) 01613

Definition: This field contains the institution the practitioner began or intends to begin practicing at (e.g., at hospital, at physician organization, at managed care network). Refer to User-defined Table 0537 - Institution for valid values.

Refer to User-defined Table 0537 – Institution in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

PRA-10: Date Left Practice (DT) 01348

Definition: This field contains the date the practitioner ended or intends to end practicing at the given institution (e.g., at hospital, at physician organization, at managed care network).

PRA-11: Government Reimbursement Billing Eligibility (CWE) 01388

Definition: This field contains a code that indicates the agency that the practitioner is authorized to bill for medical services. Refer to User-defined Table 0401 – Government Reimbursement Program in Chapter 2C, Code Tables,for valid values. This table contains the associated code values for medicaid and medical. This is a repeating field.

PRA-12: Set ID - PRA (SI) 01616

Definition: For all messages except the Staff/Practitioner Master File Notification, this field is required and contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one; for the second occurrence, the sequence number shall be two; etc. For the Staff/Practitioner Master File Notification message, this field should not be used.

ROL - Role Segment

Attention: This segment is retained for backwards compatibility as of v 2.7. The reader is referred to the PRT segment described in Chapter 7.

The role segment contains the data necessary to add, update, correct, and delete from the record persons involved, as well as their functional involvement with the activity being transmitted.

In general, the ROL segment is used to describe a person playing a particular role within the context of the message. In PM, for example, in the Grant Certificate/Permission message (B07), the ROL segment is used to describe the roles a person may perform pertinent to the certificate in the message.

The positional location of the ROL segment in ADT and Finance messages indicates the relationship. When the segment is used following the IN3 segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the health plan. When the segment is used following the PID segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the person. When the segment is used following the PV2 segment, and the role-ROL value is PCP or FHCP, the PP or FHCP is related to the patient visit.

HL7 Attribute Table - ROL - Role Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
ROL
1 01206 Role Instance ID EI
2 00816 Action Code [2..2] ID
3 01197 Role-ROL CWE
4 01198 Role Person XCN
5 01199 Role Begin Date/Time DTM
6 01200 Role End Date/Time DTM
7 01201 Role Duration CWE
8 01205 Role Action Reason CWE
9 01510 Provider Type CWE
10 01461 Organization Unit Type CWE
11 00679 Office/Home Address/Birthplace XAD
12 00678 Phone XTN
13 02183 Person's Location PL
14 02377 Organization XON

ROL-1: Role Instance ID (EI) 01206

ROL-2: 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.

ROL-3: Role-ROL (CWE) 01197

ROL-4: Role Person (XCN) 01198

ROL-5: Role Begin Date/Time (DTM) 01199

ROL-6: Role End Date/Time (DTM) 01200

ROL-7: Role Duration (CWE) 01201

ROL-8: Role Action Reason (CWE) 01205

ROL-9: Provider Type (CWE) 01510

ROL-10: Organization Unit Type (CWE) 01461

ROL-11: Office/Home Address/Birthplace (XAD) 00679

Definition: This field contains the office, and home address and/or place of birth of the staff person. This is a repeating field. The address type identifies the usage.

ROL-12: Phone (XTN) 00678

Definition: This field contains the staff person's phone number. This is a repeating field with a component for indicating which phone number is which.

ROL-13: Person's Location (PL) 02183

ROL-14: Organization (XON) 02377

STF - Staff Identification Segment

The Technical Steward for the STF segment is PA and Personnel Management.

The STF segment can identify any personnel referenced by information systems. These can be providers, staff, system users, and referring agents. In a network environment, this segment can be used to define personnel to other applications, for example, order entry clerks, insurance verification clerks, admission clerks, as well as provider demographics. When using the STF and PRA segments in the Staff/Practitioner Master File message, MFE-4-primary key value is used to link all the segments pertaining to the same master file entry. Therefore, in the MFE segment, MFE-4-primary key value must be filled in. Other segments may follow the STF segment to provide data for a particular type of staff member. The PRA segment (practitioner) is one such. It may optionally follow the STF segment in order to add practitioner-specific data. Other segments may be defined as needed. When using the segments included in this chapter for other then Staff/Practitioner Master File messages, disregard references to MFE-4 - primary key value.

HL7 Attribute Table - STF - Staff Identification Segment
Seq# DataElement Description Must Implement Flags Cardinality Length C.LEN Vocabulary DataType
STF
1

00671 Primary Key Value – STF MAY
True:
False:
C
[1..1]
[0..1]
CWE
2 00672 Staff Identifier List [0..*] CX
3 00673 Staff Name [0..*] XPN
4 00674 Staff Type [0..*] CWE
5 00111 Administrative Sex [0..1] CWE
6 00110 Date/Time of Birth [0..1] DTM
7 00675 Active/Inactive Flag [0..1] [1..1] ID
8 00676 Department [0..*] CWE
9 00677 Hospital Service – STF [0..*] CWE
10 00678 Phone [0..*] XTN
11 00679 Office/Home Address/Birthplace [0..*] XAD
12 00680 Institution Activation Date [0..*] DIN
13 00681 Institution Inactivation Date [0..*] DIN
14 00682 Backup Person ID [0..*] CWE
15 00683 E-Mail Address B= [0..*] 40 ST
16 00684 Preferred Method of Contact [0..1] CWE
17 00119 Marital Status [0..1] CWE
18 00785 Job Title # [0..1] 20 ST
19 00786 Job Code/Class [0..1] JCC
20 01276 Employment Status Code [0..1] CWE
21 01275 Additional Insured on Auto [0..1] [1..1] ID
22 01302 Driver's License Number – Staff [0..1] DLN
23 01229 Copy Auto Ins [0..1] [1..1] ID
24 01232 Auto Ins Expires [0..1] DT
25 01298 Date Last DMV Review [0..1] DT
26 01234 Date Next DMV Review [0..1] DT
27 00113 Race [0..1] CWE
28 00125 Ethnic Group [0..1] CWE
29 01596 Re-activation Approval Indicator [0..1] [1..1] ID
30 00129 Citizenship [0..*] CWE
31 01886 Date/Time of Death [0..1] DTM
32 01887 Death Indicator [0..1] [1..1] ID
33 01888 Institution Relationship Type Code [0..1] CWE
34 01889 Institution Relationship Period [0..1] DR
35 01890 Expected Return Date [0..1] DT
36 01891 Cost Center Code [0..*] CWE
37 01892 Generic Classification Indicator [0..1] [1..1] ID
38 01893 Inactive Reason Code [0..1] CWE
39 02184 Generic resource type or category [0..*] CWE
40 00120 Religion [0..1] CWE
41 01861 Signature [0..1] ED

STF-1: Primary Key Value – STF (CWE) 00671

Definition: For MFN Master File Notification, this field is required and must match MFE-4 Primary Key Value to identify which entry is being referenced. For all other messages, this field should not be used. Refer to Table 0786 - Primary Key Value – STF in Chapter 2C for valid values.

STF-2: Staff Identifier List (CX) 00672

Definition: This field contains the list of identifiers (one or more) used by the institution to identify this person. Refer to HL7 Table 0061 - Check Digit Scheme (component 2), User-defined Table 0203 - Identifier Type (component 5) and User-defined Table 0363 - Assigning Authority (component 4) for valid values (see Chapter 2A). If a Staff Member has institution identifiers that are valid only in specific organization units, that Staff identifier should be recorded in the ORG Practitioner Organization Unit segment.

STF-3: Staff Name (XPN) 00673

Definition: This field contains the staff person's name. This field may repeat to transmit multiple names for the same person.

STF-4: Staff Type (CWE) 00674

Definition: This field contains a code identifying what type of staff. Refer to User-defined Table 0182 - Staff type in Chapter 2C, Code Tables, for suggested values. This table contains no suggested values. Values may include codes for staff, practitioner, referral agent or agency, etc. This field may repeat to allow for staff to be assigned multiple types.

Typically, this field would be populated with the most granular types that may be associated with the staff. If less granular typing or categorization of the staff is required in addition to the specific type(s) found in this field, the reader is referred to STF-39 Generic Resource Type or Category. Thus, while STF-4 may contain the code for a specific staff or practitioner type, STF-39 may contain "staff" or "practitioner". For further discussion of specific and generic types, the reader is referred to STF-39 Generic Resource Type or Category.

STF-5: Administrative Sex (CWE) 00111

(Definition from PID.8 in Ch. 3)

Definition: This field contains the patient's sex. Refer to User-defined Table 0001 - Administrative Sex in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.15 in Ch. 3)

Definition: This field contains the next of kin/associated party's sex. Refer to User-defined Table 0001 - Administrative Sex in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.5 in Ch. 15)

Definition: This field contains the staff person's sex. Refer to User-defined Table 0001 – Administrative Sex for suggested values.

STF-6: Date/Time of Birth (DTM) 00110

(Definition from PID.7 in Ch. 3)

Definition: This field contains the patient's date and time of birth.

(Definition from NK1.16 in Ch. 3)

Definition: This field contains the next of kin/associated party's birth date and time.

(Definition from STF.6 in Ch. 15)

Definition: This field contains a staff member's date and time of birth.

STF-7: Active/Inactive Flag (ID) 00675

(Definition from LDP.6 in Ch. 8)

Definition: This field indicates whether the entry for this location is currently an active, that is, valid, usable entry (disregarding whether it's waiting to be maintained by housekeeping). Refer to HL7 Table 0183 - Active/Inactive in Chapter 2C, Code Tables, for valid values.

(Definition from CDM.8 in Ch. 8)

Definition: This field indicates whether this is a usable CDM entry. Refer to HL7 Table 0183 - Active/Inactive in Chapter 2C, Code Tables, for valid values.

(Definition from PRC.16 in Ch. 8)

Definition: This indicates whether this is a usable CDM entry. Refer to HL7 Table 0183 - Active/Inactive in Chapter 2C, Code Tables, for valid values.

(Definition from STF.7 in Ch. 15)

Definition: This field indicates whether person is currently a valid staff member. Refer to HL7 Table 0183 - Active/Inactive in Chapter 2C, Code Tables, for valid values. This table contains values for active or inactive.

STF-8: Department (CWE) 00676

(Definition from PRC.3 in Ch. 8)

Definition: This field contains the department of the facility which accrues revenue/cost for this type of charge. When pricing is different for different departments within the same facility, this will indicate for which department the following pricing information is valid. Use only when the price is not the same for all departments, that is, a null value indicates that this pricing is valid for all departments.

When two PRC segments are sent the same key values but with different departments, the second is sent in addition to the first, not to replace the first. The effective unique identifier is the charge code (PRC-1 - Primary Key - PRC) plus the facility ID (PRC-2 - Facility ID) plus the department (PRC-3 - Department). Multiple departments can be sent in the same segment to indicate that those departments use the same pricing. Refer to User-defined Table 0184 - Department in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.8 in Ch. 15)

Definition: This field contains the institution department to which this person reports or belongs. Refer to User-defined Table 0184 - Department in Chapter 2C, Code Tables, for suggested values. This table contains no suggested values.

STF-9: Hospital Service – STF (CWE) 00677

Definition: This field contains the hospital or ancillary service with which this staff person is associated. Refer to User-defined Table 0069 - Hospital Service in Chapter 2C, Code Tables, for suggested values.

STF-10: Phone (XTN) 00678

Definition: This field contains the staff person's phone number. This is a repeating field with a component for indicating which phone number is which.

STF-11: Office/Home Address/Birthplace (XAD) 00679

Definition: This field contains the office, and home address and/or place of birth of the staff person. This is a repeating field. The address type identifies the usage.

STF-12: Institution Activation Date (DIN) 00680

Definition: This field contains the date when staff became active for an institution. This is a repeating field. Refer to User-defined Table 0537 - Institution in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

STF-13: Institution Inactivation Date (DIN) 00681

Definition: This field contains the date when staff became inactive for an institution. This is a repeating field. Refer to HL7 Table 0537 - Institution in Chapter 2C, Code Tables, for valid values.

STF-14: Backup Person ID (CWE) 00682

Definition: This field contains the MFE-4 Primary Key Value of the master file entry that corresponds to the designated backup person for this staff person.

STF-15: E-Mail Address (ST) 00683

Definition: This field has been retained for backward compatibility. (It is now present in the fourth component of STF-10 Phone).

STF-16: Preferred Method of Contact (CWE) 00684

(Definition from PRT.23 in Ch. 7)

Definition: This field contains the preferred method to use when communicating particularly when the contact is a person or organization This is typically used in combination with PRT-5 Person, and/or PRT-8 Organization. Refer to User-defined Table 0185 - Preferred Method of Contact in Chapter 2C, "Code Tables", for suggested values.

(Definition from PRD.6 in Ch. 11)

Definition: This field contains the preferred method to use when communicating with the provider. Refer to User-defined Table 0185 - Preferred Method of Contact in Chapter 2C, "Code Tables", for suggested values.

(Definition from CTD.6 in Ch. 11)

Definition: This field contains the preferred method to use when communicating with the contact person. Refer to User-defined Table 0185 - Preferred Method of Contact in Chapter 2C, "Code Tables", for suggested values.

(Definition from STF.16 in Ch. 15)

Definition: This field indicates which of a group of multiple phone numbers is the preferred method of contact for this person. Note that all values of this code refer to this segment's phone field, except for the value "E," which refers to the E-mail address field. If more than one phone number of the preferred type exists in STF-10-phone, this field refers to the first such instance. Refer to HL7 Table 0185 - Preferred Method of Contact in Chapter 2C, Code Tables, for valid values. This table contains values for beeper, cell phone etc.

STF-17: Marital Status (CWE) 00119

(Definition from PID.16 in Ch. 3)

Definition: This field contains the patient's marital (civil) status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.14 in Ch. 3)

Definition: This field contains the next of kin/associated party's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.43 in Ch. 6)

Definition: This field contains the insured's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.17 in Ch. 15)

Definition: This field contains the staff member's marital status. Refer to User-defined Table 0002 - Marital Status in Chapter 2C, Code Tables, for suggested values. Same values as those for PID-16 Marital Status.

STF-18: Job Title (ST) 00785

(Definition from GT1.49 in Ch. 6)

Definition: This field contains a descriptive name of the guarantor's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

(Definition from IN2.46 in Ch. 6)

Definition: This field contains a descriptive name for the insured's occupation (for example, Sr. Systems Analyst, Sr. Accountant).

(Definition from STF.18 in Ch. 15)

Definition: This field contains a descriptive name of the staff member's occupation (e.g., Sr. Systems Analyst, Sr. Accountant).

STF-19: Job Code/Class (JCC) 00786

(Definition from GT1.50 in Ch. 6)

Definition: This field contains the guarantor's job code and employee classification.

(Definition from IN2.47 in Ch. 6)

Definition: This field indicates a code that identifies the insured's job code (for example, programmer, analyst, doctor, etc.).

(Definition from STF.19 in Ch. 15)

Definition: This field contains the staff member's job code and employee classification. Refer to User-defined Table 0327 - Job Code and User-defined Table 0328 - Employee Classification in Chapter 2C, Code Tables, for suggested values.

STF-20: Employment Status Code (CWE) 01276

(Definition from ORG.10 in Ch. 15)

Definition: This field contains a code indicating the working relationship of the practitioner at this organization unit. It may be different than the work status specified in STF-20. Refer to User-defined Table 0066 - Employment Status, in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.20 in Ch. 15)

Definition: This field contains the code that indicates the staff member's employment status, e.g., full-time, part-time, self-employed, etc. Refer to User-defined Table 0066 - Employment Status in Chapter 2C, Code Tables, for suggested values.

STF-21: Additional Insured on Auto (ID) 01275

Definition: This field contains an indicator for whether the present institution is named as an additional insured on the staff member's auto insurance, especially for use when staff is a driver for the institution. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  •     Y    indicates that the institution is named as an additional insured

  •     N    indicates that the institution is not named as an additional insured

STF-22: Driver's License Number – Staff (DLN) 01302

Definition: This field contains the driver's license information of staff, especially for use when staff is a driver for the institution. For state or province refer to official postal codes for that country; for country refer to ISO 3166 for codes.

STF-23: Copy Auto Ins (ID) 01229

Definition: This field contains an indicator for whether the institution has on file a copy of the staff member's auto insurance, especially for use when staff is a driver for the institution. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  •     Y    indicates that the institution has a copy on file

  •     N    indicates that the institution does not have a copy on file

STF-24: Auto Ins Expires (DT) 01232

Definition: This field contains the date on which the staff member's driver's license expires, especially for use when staff is a driver for the institution.

STF-25: Date Last DMV Review (DT) 01298

Definition: This field contains the date of the staff member's most recent Department of Motor Vehicles review, especially for use when staff is a driver for the institution.

STF-26: Date Next DMV Review (DT) 01234

Definition: This field contains the date of the staff member's next Department of Motor Vehicles review, especially for use when staff is a driver for the institution.

STF-27: Race (CWE) 00113

(Definition from PID.10 in Ch. 3)

Definition: This field refers to the patient's race. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from NK1.35 in Ch. 3)

Definition: This field identifies the race of the next of kin/associated party. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from IN2.71 in Ch. 6)

Definition: Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

(Definition from STF.27 in Ch. 15)

Definition: This field refers to the person's race. Refer to User-defined Table 0005 - Race in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

STF-28: Ethnic Group (CWE) 00125

(Definition from PID.22 in Ch. 3)

Definition: This field further defines the patient's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from NK1.28 in Ch. 3)

Definition: This field contains the next of kin/associated party's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from GT1.44 in Ch. 6)

Definition: This field contains the guarantor's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from IN2.42 in Ch. 6)

Definition: This field indicates the insured's ethnic group. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second triplet of the CE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the US, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

(Definition from STF.28 in Ch. 15)

  • Definition: This field further defines the person's ancestry. Refer to User-defined Table 0189 - Ethnic Group in Chapter 2C, Code Tables, for suggested values. The second couplet of the CWE data type for ethnic group (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes. In the United States, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

STF-29: Re-activation Approval Indicator (ID) 01596

Definition: This field contains an indicator for whether the re-activation of this record requires special approval. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

  • Y    the re-activation requires approval

  • N    this re-activation does not require approval

STF-30: Citizenship (CWE) 00129

(Definition from PID.26 in Ch. 3)

This field contains the information related to a person's country citizenship. For country citizenship HL7 recommends using ISO table 3166. For a local definition, User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables, should be used.

This field repeats since persons can be citizens of more than one country. The Name of Coding System component(s) of the CWE datatype should be used to identify the table from which citizenship membership is drawn.

In the Netherlands, this field is used for "Nationaliteit".

(Definition from NK1.19 in Ch. 3)

Definition: This field contains the code to identify the next of kin/associated party's citizenship. HL7 recommends using ISO 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from GT1.35 in Ch. 6)

Definition: This field contains the code to identify the guarantor's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship in Chapter 2C, Code Tables.

(Definition from IN2.33 in Ch. 6)

Definition: This field contains the code that identifies the insured's citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship defined in Chapter 2C, Code Tables.

(Definition from STF.30 in Ch. 15)

Definition: This field contains the staff person's current country of citizenship. HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship (in Chapter 2C, Code Tables).

STF-31: Date/Time of Death (DTM) 01886

Definition: This field contains the date and time at which the staff person death occurred.

STF-32: Death Indicator (ID) 01887

Definition: This field indicates whether the staff person is deceased. Refer to HL7 Table 0136 - Yes/no Indicator in Chapter 2C, Code Tables, for valid values.

Y    the staff person is deceased
N    the staff person is not deceased

STF-33: Institution Relationship Type Code (CWE) 01888

Definition: This field specifies the relationship the staff person has with the institution for whom he/she provides services. Refer to User–defined Table 0538 – Institution Relationship Type in Chapter 2C, Code Tables, for suggested values. This table contains values for employee, volunteer, etc.

STF-34: Institution Relationship Period (DR) 01889

Definition: This field contains the period during which the staff person started and ended the relationship specified in STF-33 Institution Relationship Type Code.

STF-35: Expected Return Date (DT) 01890

Definition: This field contains the date on which an inactive staff member expects to return to work.

STF-36: Cost Center Code (CWE) 01891

(Definition from ORG.13 in Ch. 15)

Definition: This field contains the cost center name or code assigned to this organization unit. Refer to HL7 User-defined Table 0539 – Cost Center Code for valid values.

(Definition from STF.36 in Ch. 15)

Definition: This field describes the organization unit in the General Ledger to which the staff member is currently assigned. It is sometimes referred to as the "home" cost center because it is the organization unit to which the staff member's regular costs are accrued. Refer to User-defined Table 0539 – Cost Center Code in Chapter 2C, Code Tables, for valid values. This table contains no suggested values.

STF-37: Generic Classification Indicator (ID) 01892

Definition: This field describes whether or not this STF record represents an identifiable (i.e., real) human being or is a "placeholder" for one whose identity is not yet known. For example, work schedules may need to be created before the actual staff member has been hired, or appointments may be made with a floating resource who is not specifically known until the actual appointment date/time. Because these functions require a Staff Member ID code, it is important to distinguish whether or not the Staff Member is a real human resource or not. Refer to HL7 Table 0136 - Yes/no Indicator for valid values.

  • Y    indicates that the staff member is an identifiable human being

  • N    indicates that the staff member is not an identifiable human being

STF-38: Inactive Reason Code (CWE) 01893

Definition: This field contains the reason that the staff member is inactive. Refer to User-defined Table 0540 – Inactive Reason Code in Chapter 2C, Code Tables, for suggested values. This table contains values for leave of absence, terminated, etc.

STF-39: Generic resource type or category (CWE) 02184

Definition: This field transmits a code that represents a high level categorization of resources. This is a companion field for the STF-4 Staff Type and allows an institution or enterprise to impose a one or more super category levels. Refer to User-defined Table 0771 – Resource Type or Category in Chapter 2C, Code Tables, for suggested values. This table contains no suggested values.

An enterprise might have more than one method to categorize or type resources at a high level. Therefore, this field can repeat.

Example: An organization may define discreet staff types (e.g., Pediatric Oncologist, Gerontologist, Oncology Pharmacist, Pediatric Pharmacist, Critical Care Nurse, Nurse Case Manager – Cardiology) as well as broad categories (e.g., Physician, Pharmacist, Nurse, Pediatric, Oncology, Cardiology, Case Management, Nephrology). Employing STF-4 for the discreet terms and STF-39 for the more generic terms allows both the levels of granularity to be apply to the staff without confusing the specific types with generic types. Thus, one may see:

STF-4

STF-39

Custodian

Staff

Non-clinical Nursing Supervisor

Manager

Pediatric Oncologist

Physician ~ Pediatrics ~ Oncology

Gerontologist

Physician

Oncology Pharmacist

Pharmacist ~ Oncology

Pediatric Pharmacist

Pediatrics ~ Pharmacist

Critical Care Nurse

Nurse

Nurse Case Manager – Cardiology

Nurse ~ Cardiology ~ Case Management


STF-40: Religion (CWE) 00120

(Definition from PID.17 in Ch. 3)

Definition: This field contains the patient's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from NK1.25 in Ch. 3)

Definition: This field indicates the type of religion practiced by the next of kin/associated party. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from GT1.41 in Ch. 6)

Definition: This field indicates the type of religion practiced by the guarantor. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from IN2.39 in Ch. 6)

Definition: This field indicates the type of religion practiced by the insured. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

(Definition from STF.40 in Ch. 15)

Definition: This field contains the staff member's religion. Refer to User-defined Table 0006 - Religion in Chapter 2C, Code Tables, for suggested values.

STF-41: Signature (ED) 01861

(Definition from CER.6 in Ch. 15)

Definition: Digital Signature of the certifying authority. The Digital Signature includes a seal concept and is verifiable.

(Definition from STF.41 in Ch. 15)

Definition: Digital Signature of the staff member. The Digital Signature includes a seal concept and is verifiable.

EXAMPLE TRANSACTIONS

Add Personnel Record - Event B01

MSH|^~VALUEamp;|HL7REG|UH|HL7LAB|CH|199902280700||PMU^B01^PMU_B01|MSGID002|P|2.8|<cr<

EVN|B01|199902280700|<cr>

STF||U2246^^^PLW~111223333^^^USSSA^SS|HIPPOCRATES^HAROLD^H^JR^DR^M.D.|P|M|19511004|A|^ICU|^MED|(555)555-1003X345CO~(555)555-3334CH(555)555-1345X789CB|1003 HEALTHCARE DRIVE^SUITE 200^ANNARBOR^MI^98199^U.S.A.^H~3029 HEALTHCARE DRIVE^^ANN ARBOR, MI^98198^U.S.A.^O |19890125^DOCTORSAREUS MEDICAL SCHOOL&L01||PMF88123453334|74160.2326@COMPUSERV.COM|B

PRA||^HIPPOCRATES FAMILY PRACTICE|ST|I|OB/GYN^STATE BOARD OF OBSTETRICS AND GYNECOLOGY^C^19790123|1234887609^UPIN~1234987^CTY^MECOSTA~223987654^TAX~1234987757^DEA~12394433879^MDD^CA|ADMIT&&ADT^MED&&L2^19941231~DISCH&&ADT^MED&&L2^19941231|

AFF|1|AMERICAN MEDICAL ASSOCIATION|123 MAIN STREET^^OUR TOWN^CA^98765^U.S.A.^M |19900101|

LAN|1|ESL^SPANISH^ISO639|1^READ^HL70403|1^EXCELLENT^HL70404|

LAN|2|ESL^SPANISH^ISO639|2^WRITE^HL70403|2^GOOD^HL70404|

LAN|3|FRE^FRENCH^ISO639|3^SPEAK^HL70403|3^FAIR^HL70404|

EDU|1|BA^BACHELOR OF ARTS^HL70360|19810901^19850601|19810901^19850601|19850701|YALE UNIVERSITY^L|U^HL70402|456 CONNECTICUT AVENUE^^NEW HAVEN^CO^87654^U.S.A.^M|

EDU|2|MD^DOCTOR OF MEDICINE^HL70360|19850901^19890601|19850901^19890601|19850701|HARVARD MEDICAL SCHOOL^L |M^HL70402|123 MASSACHUSETTS AVENUE^^CAMBRIDGE^MA^76543^U.S.A.^M|

Outstanding Issues

Proposals for the specification of additional events and messages should be submitted to the Personnel Management WG.