15
Co-Chair: |
|
Co-Chair: |
Irma Jongeneel-de HaasHL7 Netherlands |
Co-Chair: |
Brian PostlethwaiteHealth Connex |
Co-Chair: |
Line SaeleHL7 Norway |
Chapter Chair & Editor |
Frank OemigDeutsche Telekom Healthcare and Security Solutions GmbH, HL7 Germany |
Sponsoring Working Group: |
Patient Administration WG |
List Server: |
pafm@lists.hl7.org |
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.
Chapter 8 deals with master file maintenance.
Chapter 15 manages operational relationships based on trigger events.
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.
Segment | Cardinality | Implement | Status |
---|---|---|---|
PMU^B01^PMU_B01 | |||
MSH Message Header |
[1..1] | SHALL | |
SFT Software Segment |
|||
UAC User Authentication Credential Segment |
[0..1] | ||
EVN Event Type |
[1..1] | SHALL | |
STF Staff Identification |
[1..1] | SHALL | |
PRA Practitioner Detail |
|||
ORG Practitioner Organization Unit |
|||
AFF Professional Affiliation |
|||
LAN Language Detail |
|||
EDU Educational Detail |
|||
CER Certificate Detail |
|||
NK1 Next of Kin / Associated Parties |
|||
PRT Participation Information |
|||
ROL Role |
deprecated |
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B02^ACK |
Blank | Blank | - | ACK^B01^ACK |
NE | NE | - | - |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B02^ACK |
NE | AL, SU, ER | - | ACK^B01^ACK |
AL, SU, ER | AL, SU, ER | ACK^B02^ACK | ACK^B02^ACK |
AL, SU, ER | AL, SU, ER | ACK^B01^ACK | ACK^B01^ACK |
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).
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.
Segment | Cardinality | Implement | Status |
---|---|---|---|
PMU^B02^PMU_B01 | |||
MSH Message Header |
[1..1] | SHALL | |
SFT Software Segment |
|||
UAC User Authentication Credential Segment |
[0..1] | ||
EVN Event Type |
[1..1] | SHALL | |
STF Staff Identification |
[1..1] | SHALL | |
PRA Practitioner Detail |
|||
ORG Practitioner Organization Unit |
|||
AFF Professional Affiliation |
|||
LAN Language Detail |
|||
EDU Educational Detail |
|||
CER Certificate Detail |
|||
NK1 Next of Kin / Associated Parties |
|||
PRT Participation Information |
|||
ROL Role |
deprecated |
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B02^ACK |
Blank | Blank | - | ACK^B01^ACK |
NE | NE | - | - |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B02^ACK |
NE | AL, SU, ER | - | ACK^B01^ACK |
AL, SU, ER | AL, SU, ER | ACK^B02^ACK | ACK^B02^ACK |
AL, SU, ER | AL, SU, ER | ACK^B01^ACK | ACK^B01^ACK |
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).
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.
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B03^ACK |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B03^ACK |
AL, SU, ER | AL, SU, ER | ACK^B03^ACK | ACK^B03^ACK |
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).
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.
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B06^ACK |
Blank | Blank | - | ACK^B05^ACK |
Blank | Blank | - | ACK^B04^ACK |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B06^ACK |
NE | AL, SU, ER | - | ACK^B05^ACK |
NE | AL, SU, ER | - | ACK^B04^ACK |
AL, SU, ER | AL, SU, ER | ACK^B06^ACK | ACK^B06^ACK |
AL, SU, ER | AL, SU, ER | ACK^B05^ACK | ACK^B05^ACK |
AL, SU, ER | AL, SU, ER | ACK^B04^ACK | ACK^B04^ACK |
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).
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.
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B06^ACK |
Blank | Blank | - | ACK^B05^ACK |
Blank | Blank | - | ACK^B04^ACK |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B06^ACK |
NE | AL, SU, ER | - | ACK^B05^ACK |
NE | AL, SU, ER | - | ACK^B04^ACK |
AL, SU, ER | AL, SU, ER | ACK^B06^ACK | ACK^B06^ACK |
AL, SU, ER | AL, SU, ER | ACK^B05^ACK | ACK^B05^ACK |
AL, SU, ER | AL, SU, ER | ACK^B04^ACK | ACK^B04^ACK |
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).
An event B06 signals that the formal relationship between a staff member and the institution has ended (i.e., upon termination).
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B06^ACK |
Blank | Blank | - | ACK^B05^ACK |
Blank | Blank | - | ACK^B04^ACK |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B06^ACK |
NE | AL, SU, ER | - | ACK^B05^ACK |
NE | AL, SU, ER | - | ACK^B04^ACK |
AL, SU, ER | AL, SU, ER | ACK^B06^ACK | ACK^B06^ACK |
AL, SU, ER | AL, SU, ER | ACK^B05^ACK | ACK^B05^ACK |
AL, SU, ER | AL, SU, ER | ACK^B04^ACK | ACK^B04^ACK |
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).
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.
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | RSP^K22^RSP_K22 |
Blank | Blank | - | RSP^K23^RSP_K23 |
Blank | Blank | - | RSP^K25^RSP_K25 |
Blank | Blank | - | RSP^K32^RSP_K32 |
Blank | Blank | - | RSP^K2^4^RSP_K24 |
Blank | Blank | - | RSP^K21^RSP_K21 |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
NE | NE | - | - |
AL, SU, ER | NE | ACK^Q23^ACK | - |
AL, SU, ER | NE | ACK^Q22^ACK | - |
AL, SU, ER | NE | ACK^Q24^ACK | - |
AL, SU, ER | NE | ACK^Q32^ACK | - |
AL, SU, ER | NE | ACK^Q21^ACK | - |
NE | AL, SU, ER | - | RSP^K25^RSP_K25 |
NE | AL, SU, ER | - | RSP^K22^RSP_K22 |
NE | AL, SU, ER | - | RSP^K21^RSP_K21 |
NE | AL, SU, ER | - | RSP^K23^RSP_K23 |
AL, SU, ER | AL, SU, ER | ACK^Q25^ACK | RSP^K25^RSP_K25 |
NE | AL, SU, ER | - | RSP^K24^RSP_K24 |
NE | AL, SU, ER | - | RSP^K32^RSP_K32 |
AL, SU, ER | AL, SU, ER | ACK^Q22^ACK | RSP^K22^RSP_K22 |
AL, SU, ER | AL, SU, ER | ACK^Q21^ACK | RSP^K21^RSP_K21 |
AL, SU, ER | AL, SU, ER | ACK^Q24^ACK | RSP^K24^RSP_K24 |
AL, SU, ER | AL, SU, ER | ACK^Q32^ACK | RSP^K32^RSP_K32 |
AL, SU, ER | AL, SU, ER | ACK^Q23^ACK | RSP^K23^RSP_K23 |
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).
Segment | Cardinality | Implement | Status |
---|---|---|---|
RSP^K25^RSP_K25 | |||
MSH Message Header |
[1..1] | SHALL | |
SFT Software Segment |
|||
UAC User Authentication Credential Segment |
[0..1] | ||
MSA Message Acknowledgment |
[1..1] | SHALL | |
ERR Error |
|||
QAK Query Acknowledgment |
[1..1] | SHALL | |
QPD Query Parameter Definition |
[1..1] | SHALL | |
RCP Response Control Parameter |
[1..1] | SHALL | |
STAFF | [1..*] | SHALL | |
STF Staff Identification |
[1..1] | SHALL | |
PRA Practitioner Detail |
|||
ORG Practitioner Organization Unit |
|||
AFF Professional Affiliation |
|||
LAN Language Detail |
|||
EDU Educational Detail |
|||
CER Certificate Detail |
|||
NK1 Next of Kin / Associated Parties |
|||
PRT Participation Information |
|||
ROL Role |
deprecated | ||
DSC Continuation Pointer |
[0..1] |
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | ACK^K25^ACK | - |
NE | NE | - | - |
AL, ER, SU | NE | ACK^K25^ACK | - |
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).
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.
Segment | Cardinality | Implement | Status |
---|---|---|---|
PMU^B07^PMU_B07 | |||
MSH Message Header |
[1..1] | SHALL | |
SFT Software Segment |
|||
UAC User Authentication Credential Segment |
[0..1] | ||
EVN Event Type |
[1..1] | SHALL | |
STF Staff Identification |
[1..1] | SHALL | |
PRA Practitioner Detail |
[0..1] | ||
CERTIFICATE | |||
CER Certificate Detail |
[1..1] | SHALL | |
PRT Participation Information |
|||
ROL Role |
deprecated |
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B07^ACK |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B07^ACK |
AL, SU, ER | AL, SU, ER | ACK^B07^ACK | ACK^B07^ACK |
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).
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.
MSH-15 | MSH-16 | Immediate ACK | Application Ack |
---|---|---|---|
Blank | Blank | - | ACK^B08^ACK |
NE | NE | - | - |
NE | AL, SU, ER | - | ACK^B08^ACK |
AL, SU, ER | AL, SU, ER | ACK^B08^ACK | ACK^B08^ACK |
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).
MSH|^~\&|HL7REG|UH|HL7LAB|CH|199902280700||PMU^B01^PMU_B01|MSGID002|P|2.8| EVN|B01|199902280700| 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| Proposals for the specification of additional events and messages should be submitted to the Personnel Management WG.
29.5 Outstanding Issues (15.6)