15. Personnel Management


Contents



15 . Personnel Management

Chapter-Chair:

Dr. Bernd Blobel University of Magdeburg

Chapter-Chair/Editor:

Frank Oemig HL7 Germany, Ringholm GmbH Integration Consulting

15.1 CHAPTER 15 CONTENTS

15.2 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.

15.2.1 Usage of Chapter 15 vs. Chapter 8

Chapter 8 deals with master file maintenance.

Chapter 15 manages operational relationships based on trigger events.

15.3 TRIGGER EVENTS AND MESSAGE DESCRIPTIONS

15.3.1 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB
[ { PRA } ] Practitioner
15 DB
[ { ORG } ] Organization
15 DB
[ { AFF } ] Affiliation
15 DB
[ { LAN } ] Language
15 DB
[ { EDU } ] Education
15 DB
[ { CER } ] Certificate
15 DB

ACK^B01^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.2 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB
[ { PRA } ] Practitioner
15 DB
[ { ORG } ] Organization
15 DB
[ { AFF } ] Affiliation
15 DB
[ { LAN } ] Language
15 DB
[ { EDU } ] Education
15 DB
[ { CER } ] Certificate
15 DB

ACK^B02^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.3 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB

ACK^B03^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.4 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB
[ { PRA } ] Practitioner
15 DB
[ { ORG } ] Organization
15 DB

ACK^B04^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.5 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB
[ { PRA } ] Practitioner
15 DB
[ { ORG } ] Organization
15 DB

ACK^B05^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.6 PMU/ACK _ Terminate Practicing Person (Event B06)

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

PMU^B06^PMU_B04 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
3 DB
STF Staff
15 DB
[ { PRA } ] Practitioner
15 DB
[ { ORG } ] Organization
15 DB

ACK^B06^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.7 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.

Query ID Q25
Query Type Query
Query Name Personnel Information by Segment
Query Trigger QBP^Q25^QBP_Q21
Both
Response Trigger RSP^K25^RSP_K25
Query Characteristics Returns response sorted by STF-3-Staff Name
Query 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.
Query Trigger QBP^Q25^QBP_Q21

QBP^Q25^QBP_Q21 Personnel Information Message Status Chapter DB Ref.

see
3.3.56 DB

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 CE O Y in 0296 LAN.2
LAN-2: Language
5 LanguageAbility
Y 60 CE C Y in 0403 LAN.3
LAN-3: Language Ability
6 LanguageProficiency
Y 60 CE C Y in 0404 LAN.4
LAN-4: Language Proficiency

Input Parameter Comp Name DT Description
StaffIDCode
CX Components: ^ ^ ^ ^ ^



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
CE 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
CE 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
CE 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 Message Status Chapter DB Ref.
MSH Message Header
2.16.9 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgement
2.16.8 DB
[ { ERR } ] Error
2.16.5 DB
QAK Query Acknowledgement
5.5.2 DB
QPD Query Parameter Definition
5.5.4 DB
RCP Response Control Parameter
5.5.6 DB
{ --- STAFF begin


STF Staff
15.4.6 DB
[ { PRA } ] Practitioner
15.4.5 DB
[ { ORG } ] Organization
15.4.4 DB
[ { AFF } ] Affiliation
15.4.1 DB
[ { LAN } ] Language
15.4.3 DB
[ { EDU } ] Education
15.4.2 DB
[ { CER } ] Certificate
15 DB
} --- STAFF end


[ DSC ] Continuation Pointer
2.16.4 DB

15.3.8 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
2 DB
STF Staff
15 DB
[ PRA ] Practitioner
15 DB
[ --- CERTIFICATE begin


{



CER Certificate
15 DB
[ { ROL } ] Role
15 DB
}



] --- CERTIFICATE end


ACK^B07^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software

DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.3.9 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 PMU Message Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
EVN Event Type
2 DB
STF Staff
15 DB
[ PRA ] Practitioner
15 DB
[ { CER } ] Certificate
15 DB

ACK^B08^ACK General Acknowledgment Status Chapter DB Ref.
MSH Message Header
2 DB
[ { SFT } ] Software
2 DB
MSA Message Acknowledgment
2 DB
[ { ERR } ] Error
2 DB

15.4 MESSAGE SEGMENTS

The following segments are defined for the Personnel Management messages.

15.4.1 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 60 SI R

01427 Set ID _ AFF DB
2 250 XON R

01444 Professional Organization DB
3 250 XAD O

01445 Professional Organization Address DB
4 52 DR O Y
01446 Professional Organization Affiliation Date Range DB
5 60 ST O

01447 Professional Affiliation Additional Information DB

15.4.1.0 AFF Field Definitions

15.4.1.1 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.

15.4.1.2 AFF-2 Professional Organization (XON) 01444

Components: <Organization Name (ST)> ^ <Organization Name Type Code (IS)> ^ <DEPRECATED-ID Number (NM)> ^ <Check Digit (NM)> ^ <Check Digit Scheme (ID)> ^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Name Representation Code (ID)> ^ <Organization Identifier (ST)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

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

15.4.1.3 AFF-3 Professional Organization Address (XAD) 01445

Components: <Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State or Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code (IS)> ^ <Census Tract (IS)> ^ <Address Representation Code (ID)> ^ <DEPRECATED-Address Validity Range (DR)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)>

Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street Name (ST)> & <Dwelling Number (ST)>

Subcomponents for DEPRECATED-Address Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

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

Components: <Range Start Date/Time (TS)> ^ <Range End Date/Time (TS)>

Subcomponents for Range Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Range End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

15.4.1.5 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.

15.4.2 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

SEQ LEN DT OPT RP/# TBL# ITEM # ELEMENT NAME DB Ref.
1 4 SI R

01856 Set ID _ CER DB
2 80 ST O

01857 Serial Number DB
3 80 ST O

01858 Version DB
4 250 XON O

01859 Granting Authority DB
5 250 XCN O

01860 Issuing Authority DB
6 65536 ED O

01861 Signature of Issuing Authority DB
7 3 ID O
0399 01862 Granting Country DB
8 250 CWE O
0347 01863 Granting State/Province DB
9 250 CWE O
0289 01864 Granting County/Parish DB
10 250 CWE O

01865 Certificate Type DB
11 250 CWE O

01866 Certificate Domain DB
12 250 ID C

01867 Subject ID DB
13 250 ST R

01907 Subject Name DB
14 250 CWE O Y
01868 Subject Directory Attribute Extension (Health Professional Data) DB
15 250 CWE O

01869 Subject Public Key Info DB
16 250 CWE O

01870 Authority Key Identifier DB
17 250 ID O
0136 01871 Basic Constraint DB
18 250 CWE O Y
01872 CRL Distribution Point DB
19 3 ID O
0399 01875 Jurisdiction Country DB
20 250 CWE O
0347 01873 Jurisdiction State/Province DB
21 250 CWE O
0289 01874 Jurisdiction County/Parish DB
22 250 CWE O Y 0547 01895 Jurisdiction Breadth DB
23 26 TS O

01876 Granting Date DB
24 26 TS O

01877 Issuing Date DB
25 26 TS O

01878 Activation Date DB
26 26 TS O

01879 Inactivation Date DB
27 26 TS O

01880 Expiration Date DB
28 26 TS O

01881 Renewal Date DB
29 26 TS O

01882 Revocation Date DB
30 250 CE O

01883 Revocation Reason Code DB
31 250 CWE O
0536 01884 Certificate Status DB

15.4.2.0 CER - Field Definitions

15.4.2.1 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.

15.4.2.2 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)).

15.4.2.3 CER-3 Version (ST) 01858

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

15.4.2.4 CER-4 Granting Authority (XON) 01859

Components: <Organization Name (ST)> ^ <Organization Name Type Code (IS)> ^ <DEPRECATED-ID Number (NM)> ^ <Check Digit (NM)> ^ <Check Digit Scheme (ID)> ^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Name Representation Code (ID)> ^ <Organization Identifier (ST)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

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

15.4.2.5 CER-5 Issuing Authority (XCN) 01860

Components: <ID Number (ST)> ^ <Family Name (FN)> ^ <Given Name (ST)> ^ <Second and Further Given Names or Initials Thereof (ST)> ^ <Suffix (e.g., JR or III) (ST)> ^ <Prefix (e.g., DR) (ST)> ^ <DEPRECATED-Degree (e.g., MD) (IS)> ^ <Source Table (IS)> ^ <Assigning Authority (HD)> ^ <Name Type Code (ID)> ^ <Identifier Check Digit (ST)> ^ <Check Digit Scheme (ID)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Name Representation Code (ID)> ^ <Name Context (CE)> ^ <DEPRECATED-Name Validity Range (DR)> ^ <Name Assembly Order (ID)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)> ^ <Professional Suffix (ST)> ^ <Assigning Jurisdiction (CWE)> ^ <Assigning Agency or Department (CWE)>

Subcomponents for Family Name (FN): <Surname (ST)> & <Own Surname Prefix (ST)> & <Own Surname (ST)> & <Surname Prefix From Partner/Spouse (ST)> & <Surname From Partner/Spouse (ST)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Name Context (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Subcomponents for DEPRECATED-Name Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Assigning Jurisdiction (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

Subcomponents for Assigning Agency or Department (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

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

15.4.2.6 CER-6 Signature of Issuing Authority (ED) 01861

Components: <Source Application (HD)> ^ <Type of Data (ID)> ^ <Data Subtype (ID)> ^ <Encoding (ID)> ^ <Data (TX)>

Subcomponents for Source Application (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

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

15.4.2.7 CER-7 Granting Country (ID) 01862

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

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

Definition: State/province granting the certificate. Refer to HL7 Table 0347 _ State/Province for valid values in chapter 2.

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

Definition: County/parish granting the certificate. Refer to HL7 Table 0289 _ County/Parish for valid values in chapter 2.

15.4.2.10 CER-10 Certificate Type (CWE) 01865

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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

15.4.2.11 CER-11 Certificate Domain (CWE) 01866

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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

15.4.2.12 CER-12 Subject ID (ID) 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.

15.4.2.13 CER-13 Subject Name (ST) 01097

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

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

Definition: In individual identity certificates, this Subject Directory Attribute extension MAY contain an 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.

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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.

15.4.2.16 CER-16 Authority Key Identifier (CWE) 01870

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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).

15.4.2.17 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.

15.4.2.18 CER-18 CRL Distribution Point (CWE) 01872

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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.

15.4.2.19 CER-19 Jurisdiction Country (ID) 01875

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

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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

User-defined Table 0347 _ State/Province

Value Description Comment

see chapter 2B

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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

User-defined Table 0289 _ County/Parish

Value Description Comment

See section 3.4.2.13

15.4.2.22 CER-22 Jurisdiction Breadth (ID) 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.

User-defined Table 0547 _ Jurisdictional Breadth

Value Description Comment
C County/Parish
S State/Province
N Country

15.4.2.23 CER-23 Granting Date (TS) 01876

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.24 CER-24 Issuing Date (TS) 01877

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.25 CER-25 Activation Date (TS) 01878

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.26 CER-26 Inactivation Date (TS) 01879

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.27 CER-27 Expiration Date (TS) 01880

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.28 CER-28 Renewal Date (TS) 01881

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.29 CER-29 Revocation date (TS) 01882

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.2.30 CER-30 Revocation Reason Code (CWE) 01883

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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

15.4.2.31 CER-31 Certificate Status Code (CWE) 01884

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

Definition: This field contains the state of the certificate held by the health professional. HL7 suggest using values in User-defined table 0536 _ Certificate Status.

User-defined Table 0536 _ Certificate Status

Value Description Comment
P Provisional
R Revoked
V Active/Valid
E Expired
I Inactive

15.4.3 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 60 SI R

01448 Set ID _ EDU DB
2 10 IS O
0360 01449 Academic Degree DB
3 52 DR O

01597 Academic Degree Program Date Range DB
4 52 DR O

01450 Academic Degree Program Participation Date Range DB
5 8 DT O

01451 Academic Degree Granted Date DB
6 250 XON O

01452 School DB
7 250 CE O
0402 01453 School Type Code DB
8 250 XAD O

01454 School Address DB
9 250 CWE O Y
01885 Major Field of Study DB

15.4.3.0 EDU Field Definitions

15.4.3.1 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.

15.4.3.2 EDU-2 Academic Degree (IS) 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.

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

Components: <Range Start Date/Time (TS)> ^ <Range End Date/Time (TS)>

Subcomponents for Range Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Range End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

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

Components: <Range Start Date/Time (TS)> ^ <Range End Date/Time (TS)>

Subcomponents for Range Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Range End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

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

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

15.4.3.6 EDU-6 School (XON) 01452

Components: <Organization Name (ST)> ^ <Organization Name Type Code (IS)> ^ <DEPRECATED-ID Number (NM)> ^ <Check Digit (NM)> ^ <Check Digit Scheme (ID)> ^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Name Representation Code (ID)> ^ <Organization Identifier (ST)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

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

15.4.3.7 EDU-7 School Type Code (CE) 01453

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

User-defined Table 0402 - School type

Value Description Comment
D Dental
G Graduate
M Medical
U Undergraduate

15.4.3.8 EDU-8 School Address (XAD) 01454

Components: <Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State or Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code (IS)> ^ <Census Tract (IS)> ^ <Address Representation Code (ID)> ^ <DEPRECATED-Address Validity Range (DR)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)>

Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street Name (ST)> & <Dwelling Number (ST)>

Subcomponents for DEPRECATED-Address Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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.

15.4.4 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 60 SI R

01455 Set ID _ LAN DB
2 250 CE R
0296 01456 Language Code DB
3 250 CE O Y 0403 01457 Language Ability Code DB
4 250 CE O
0404 01458 Language Proficiency Code DB

15.4.4.0 LAN Field Definitions

15.4.4.1 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.

15.4.4.2 LAN-2 Language Code (CE) 01456

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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 - Language.

15.4.4.3 LAN-3 Language Ability Code (CE) 01457

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

HL7 Table 0403 _ Language Ability

Value Description Comment
1 Read
2 Write
3 Speak
4 Understand
5 Sign

15.4.4.4 LAN-4 Language Proficiency Code (CE) 01458

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

HL7 Table 0404 - Language Proficiency

Value Description Comment
1 Excellent
2 Good
3 Fair
4 Poor
5 Some (level unknown)
6 None

15.4.5 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 60 SI R

01459 Set ID _ ORG DB
2 250 CE O
0405 01460 Organization Unit Code DB
3 250 CE O
0474 01625 Organization Unit Type Code DB
4 1 ID O
0136 01462 Primary Org Unit Indicator DB
5 60 CX O

01463 Practitioner Org Unit Identifier DB
6 250 CE O
0452 01464 Health Care Provider Type Code DB
7 250 CE O
0453 01614 Health Care Provider Classification Code DB
8 250 CE O
0454 01615 Health Care Provider Area of Specialization Code DB
9 52 DR O

01465 Effective Date Range DB
10 250 CE O
0066 01276 Employment Status Code DB
11 1 ID O
0136 01467 Board Approval Indicator DB
12 1 ID O
0136 01468 Primary Care Physician Indicator DB

15.4.5.0 ORG Field Definitions

15.4.5.1 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.

15.4.5.2 ORG-2 Organization Unit Code (CE) 01460

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

User-defined Table 0405 _ Organization Unit

Value Description Comment

No suggested values defined

15.4.5.3 ORG-3 Organization Unit Type Code (CE) 01625

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

User-defined Table 0474 - Organization Unit Type

Value Description Comment
D Department
F Facility
U Subdepartment
S Subdivision
V Division

15.4.5.4 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

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

Components: <ID Number (ST)> ^ <Check Digit (ST)> ^ <Check Digit Scheme (ID)> ^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Effective Date (DT)> ^ <Expiration Date (DT)> ^ <Assigning Jurisdiction (CWE)> ^ <Assigning Agency or Department (CWE)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Jurisdiction (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

Subcomponents for Assigning Agency or Department (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

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.

15.4.5.6 ORG-6 Health Care Provider Type Code (CE) 01464

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

HL7 Table 0452 - Health care provider type code

Value Description Comment
SUGGESTION ANSI ASC X12 Health Care Provider Taxonomy, Level 1 - Type

15.4.5.7 ORG-7 Health Care Provider Classification Code (CE) 01614

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

HL7 Table 0453 - Health care provider classification

Value Description Comment
SUGGESTION ANSI ASC X12 Health Care Provider Taxonomy, Level 2 - Classification

15.4.5.8 ORG-8 Health Care Provider Area of Specialization Code (CE) 01615

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

HL7 Table 0454 - Health care provider area of specialization

Value Description Comment
SUGGESTION ANSI ASC X12 Health Care Provider Taxonomy, Level 3 - specialization

15.4.5.9 ORG-9 Effective Date Range (DR) 01465

Components: <Range Start Date/Time (TS)> ^ <Range End Date/Time (TS)>

Subcomponents for Range Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Range End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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.

15.4.5.10 ORG-10 Employment Status Code (CE) 01276

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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 for suggested values.

User-defined Table 0066 - Employment status

Value Description Comment

see chapter 6

15.4.5.11 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

15.4.5.12 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

15.4.6 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 250 CE C
9999 00685 Primary Key Value - PRA DB
2 250 CE O Y 0358 00686 Practitioner Group DB
3 3 IS O Y 0186 00687 Practitioner Category DB
4 1 ID O
0187 00688 Provider Billing DB
5 112 SPD O Y 0337 00689 Specialty DB
6 99 PLN B Y 0338 00690 Practitioner ID Numbers DB
7 770 PIP O Y
00691 Privileges DB
8 8 DT O

01296 Date Entered Practice DB
9 250 CE O
0537 01613 Institution DB
10 8 DT O

01348 Date Left Practice DB
11 250 CE O Y 0401 01388 Government Reimbursement Billing Eligibility DB
12 60 SI C

01616 Set ID - PRA DB

15.4.6.0 PRA Field Definitions

15.4.6.1 PRA-1 Primary Key Value - PRA (CE) 00685

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

15.4.6.2 PRA-2 Practitioner Group (CE) 00686

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

User-defined Table 0358 _ Practitioner group

Value Description Comment

No suggested values defined

15.4.6.3 PRA-3 Practitioner Category (IS) 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.

User-defined Table 0186 _ Practitioner category

Value Description Comment

No suggested values defined

15.4.6.4 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.

HL7 Table 0187 - Provider billing

Value Description Comment
I Institution bills for provider
P Provider does own billing

15.4.6.5 PRA-5 Specialty (SPD) 00689

Components: <Specialty Name (ST)> ^ <Governing Board (ST)> ^ <Eligible or Certified (ID)> ^ <Date of Certification (DT)>

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.

HL7 Table 0337 - Certification status

Value Description Comment
C Certified
E Eligible

15.4.6.6 PRA-6 Practitioner ID Numbers (PLN) 00690

Components: <ID Number (ST)> ^ <Type of ID Number (IS)> ^ <State/other Qualifying Information (ST)> ^ <Expiration Date (DT)>

Definition: As of version 2.5, this field has been retained for backward compatibility. 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 (Table 0338).

15.4.6.7 PRA-7 Privileges (PIP) 00691

Components: <Privilege (CE)> ^ <Privilege Class (CE)> ^ <Expiration Date (DT)> ^ <Activation Date (DT)> ^ <Facility (EI)>

Subcomponents for Privilege (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Subcomponents for Privilege Class (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Subcomponents for Facility (EI): <Entity Identifier (ST)> & <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

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 CE 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 (^).

15.4.6.8 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).

15.4.6.9 PRA-9 Institution (CE) 01613

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

User-defined Table 0537 - Institution

Value Description Comment

No suggested values

15.4.6.10 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).

15.4.6.11 PRA-11 Government Reimbursement Billing Eligibility (CE) 01388

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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 for valid values. This is a repeating field.

User-defined Table 0401 - Government reimbursement program

Value Description Comment
MM Medicare
C Medi-Cal

15.4.6.12 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.

15.4.7 ROL - Role Segment

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.

HL7 Attribute Table - ROL - Role

SEQ LEN DT OPT RP/# TBL# ITEM # ELEMENT NAME DB Ref.
1 60 EI C

01206 Role Instance ID DB
2 2 ID R
0287 00816 Action Code DB
3 250 CE R
0443 01197 Role-ROL DB
4 250 XCN R Y
01198 Role Person DB
5 26 TS O

01199 Role Begin Date/Time DB
6 26 TS O

01200 Role End Date/Time DB
7 250 CE O

01201 Role Duration DB
8 250 CE O

01205 Role Action Reason DB
9 250 CE O Y
01510 Provider Type DB
10 250 CE O
0406 01461 Organization Unit Type DB
11 250 XAD O Y
00679 Office/Home Address/Birthplace DB
12 250 XTN O Y
00678 Phone DB

15.4.7.0 ROL - Field Definitions

15.4.7.1 ROL-1 Role instance ID (EI) 01206

Components: <Entity Identifier (ST)> ^ <Namespace ID (IS)> ^ <Universal ID (ST)> ^ <Universal ID Type (ID)>

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

Conditionality Rule: This field is required when used in Patient Care and Personnel Management messages. The field is optional when used in ADT and Finance messages.

15.4.7.2 ROL-2 Action code (ID) 00816

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

15.4.7.3 ROL-3 Role-ROL (CE) 01197

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field indicates the functional involvement with the activity being transmitted (e.g., Case Manager, Evaluator, Transcriber, Nurse Care Practitioner, Midwife, Physician Assistant, etc.). Refer to User-defined table 0443 _ Provider role for valid values. When the ROL segment is used in conjunction with the Attending, Referring, or Admitting physician in the PV1 segment, the HL7 specified table values must be used. Additional site negotiated values are allowed.

Note: Table 0443 appears to have the similar use and similar values as Table 0286, but supports a more generic concept.

User-defined Table 0443 - Provider role

Value Description Used with
AD Admitting PV1-17 Admitting doctor
AT Attending PV1-7 Attending doctor
CP Consulting Provider
FHCP Family Health Care Professional
PP Primary Care Provider
RP Referring Provider PV1-8 Referring doctor
RT Referred to Provider

*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.

15.4.7.4 ROL-4 Role person (XCN) 01198

Components: <ID Number (ST)> ^ <Family Name (FN)> ^ <Given Name (ST)> ^ <Second and Further Given Names or Initials Thereof (ST)> ^ <Suffix (e.g., JR or III) (ST)> ^ <Prefix (e.g., DR) (ST)> ^ <DEPRECATED-Degree (e.g., MD) (IS)> ^ <Source Table (IS)> ^ <Assigning Authority (HD)> ^ <Name Type Code (ID)> ^ <Identifier Check Digit (ST)> ^ <Check Digit Scheme (ID)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Name Representation Code (ID)> ^ <Name Context (CE)> ^ <DEPRECATED-Name Validity Range (DR)> ^ <Name Assembly Order (ID)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)> ^ <Professional Suffix (ST)> ^ <Assigning Jurisdiction (CWE)> ^ <Assigning Agency or Department (CWE)>

Subcomponents for Family Name (FN): <Surname (ST)> & <Own Surname Prefix (ST)> & <Own Surname (ST)> & <Surname Prefix From Partner/Spouse (ST)> & <Surname From Partner/Spouse (ST)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Name Context (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Subcomponents for DEPRECATED-Name Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Assigning Jurisdiction (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

Subcomponents for Assigning Agency or Department (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

Definition: This field contains the identity of the person who is assuming the role that is being transmitted. This field correlates to STF-2 Staff ID Code and STF-3 Staff Name.

15.4.7.5 ROL-5 Role begin date/time (TS) 01199

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.7.6 ROL-6 Role end date/time (TS) 01200

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

Definition: This field contains the date/time when the role ended.

15.4.7.7 ROL-7 Role duration (CE) 01201

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains the qualitative length of time for performance of a role (e.g., until the next assessment, four days, until discharge, etc.).

15.4.7.8 ROL-8 Role action reason (CE) 01205

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field indicates the reason why the person is assuming (or changing) the role (e.g., shift change, new primary nurse, etc.).

15.4.7.9 ROL-9 Provider type (CE) 01510

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains a code identifying the provider type. This attribute correlates to the following master file attribute: STF-4 Staff Type. Coded values from the correlated master file table are used; the user defined master file table is used as the coding system for this attribute. For example, if you are using values from STF-2 Staff Type the coding system would be HL70182 which is the table number for the user defined Staff Type table. This field is included in this segment to support international requirements, and is not intended as a master file update.

15.4.7.10 ROL-10 Organization unit type (CE) 01461

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field identifies the environment in which the provider acts in the role specified in ROL-3. The provider environment is not the specialty for the provider. The specialty information for the provider is defined in the PRA segment. This attribute is included in the ROL segment to allow communication of this data when the provider information may not have been communicated previously in a master file. This attribute correlates to the master file attribute ORG-3 Organization unit type and references the same table. Refer to User-defined table 0406 - Organization unit type. This field is included in this segment to support international requirements, and is not intended as a master file update.

User-defined table 0406 - Organization unit type

Value Description
H Home
O Office
1 Hospital
2 Physician Clinic
3 Long Term Care
4 Acute Care
5 Other

15.4.7.11 ROL-11 Office/home address/Birthplace (XAD) 00679

Components: <Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State or Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code (IS)> ^ <Census Tract (IS)> ^ <Address Representation Code (ID)> ^ <DEPRECATED-Address Validity Range (DR)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)>

Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street Name (ST)> & <Dwelling Number (ST)>

Subcomponents for DEPRECATED-Address Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Definition: This field contains the office address and home address of the provider. This is a repeating field. This attribute is included in the ROL segment to allow communication of this data when the provider information may not have been communicated previously in a master file. This field is included in this segment to support international requirements, and is not intended as a master file update. This field correlates to STF-11 Office/Home Address.

15.4.7.12 ROL-12 Phone (XTN) 00678

Components: <DEPRECATED-Telephone Number (ST)> ^ <Telecommunication Use Code (ID)> ^ <Telecommunication Equipment Type (ID)> ^ <Email Address (ST)> ^ <Country Code (NM)> ^ <Area/City Code (NM)> ^ <Local Number (NM)> ^ <Extension (NM)> ^ <Any Text (ST)> ^ <Extension Prefix (ST)> ^ <Speed Dial Code (ST)> ^ <Unformatted Telephone number (ST)>

Definition: This field contains the provider_s phone number. This attribute is included in the ROL segment to allow communication of this data when the provider information may not have been communicated previously in a master file. This field is included in this segment to support international requirements, and is not intended as a master file update. This field correlates to STF-10 Phone.

15.4.8 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

SEQ LEN DT OPT RP/# TBL# ITEM# ELEMENT NAME DB Ref.
1 250 CE C
9999 00671 Primary Key Value - STF DB
2 250 CX O Y
00672 Staff Identifier List DB
3 250 XPN O Y
00673 Staff Name DB
4 2 IS O Y 0182 00674 Staff Type DB
5 1 IS O
0001 00111 Administrative Sex DB
6 26 TS O

00110 Date/Time of Birth DB
7 1 ID O
0183 00675 Active/Inactive Flag DB
8 250 CE O Y 0184 00676 Department DB
9 250 CE O Y 0069 00677 Hospital Service - STF DB
10 250 XTN O Y
00678 Phone DB
11 250 XAD O Y
00679 Office/Home Address/Birthplace DB
12 276 DIN O Y 0537 00680 Institution Activation Date DB
13 276 DIN O Y 0537 00681 Institution Inactivation Date DB
14 250 CE O Y
00682 Backup Person ID DB
15 40 ST O Y
00683 E-Mail Address DB
16 250 CE O
0185 00684 Preferred Method of Contact DB
17 250 CE O
0002 00119 Marital Status DB
18 20 ST O

00785 Job Title DB
19 20 JCC O

00786 Job Code/Class DB
20 250 CE O
0066 01276 Employment Status Code DB
21 1 ID O
0136 01275 Additional Insured on Auto DB
22 25 DLN O

01302 Driver_s License Number _ Staff DB
23 1 ID O
0136 01229 Copy Auto Ins DB
24 8 DT O

01232 Auto Ins. Expires DB
25 8 DT O

01298 Date Last DMV Review DB
26 8 DT O

01234 Date Next DMV Review DB
27 250 CE O
0005 00113 Race DB
28 250 CE O
0189 00125 Ethnic Group DB
29 1 ID O
0136 01596 Re-activation Approval Indicator DB
30 250 CWE O Y 0171 00129 Citizenship DB
31 8 TS O

01886 Death Date and Time DB
32 1 ID O
0136 01887 Death Indicator DB
33 250 CWE O
0538 01888 Institution Relationship Type Code DB
34 52 DR O

01889 Institution Relationship Period DB
35 8 DT O

01890 Expected Return Date DB
36 250 CWE O Y 0539 01891 Cost Center Code DB
37 1 ID O
0136 01892 Generic Classification Indicator DB
38 250 CWE O
0540 01893 Inactive Reason Code DB

15.4.8.0 STF Field Definitions

15.4.8.1 STF-1 Primary Key Value - STF (CE) 00671

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

15.4.8.2 STF-2 Staff Identifier List (CX) 00672

Components: <ID Number (ST)> ^ <Check Digit (ST)> ^ <Check Digit Scheme (ID)> ^ <Assigning Authority (HD)> ^ <Identifier Type Code (ID)> ^ <Assigning Facility (HD)> ^ <Effective Date (DT)> ^ <Expiration Date (DT)> ^ <Assigning Jurisdiction (CWE)> ^ <Assigning Agency or Department (CWE)>

Subcomponents for Assigning Authority (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Facility (HD): <Namespace ID (IS)> & <Universal ID (ST)> & <Universal ID Type (ID)>

Subcomponents for Assigning Jurisdiction (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

Subcomponents for Assigning Agency or Department (CWE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)> & <Coding System Version ID (ST)> & <Alternate Coding System Version ID (ST)> & <Original Text (ST)>

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. 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.

15.4.8.3 STF-3 Staff Name (XPN) 00673

Components: <Family Name (FN)> ^ <Given Name (ST)> ^ <Second and Further Given Names or Initials Thereof (ST)> ^ <Suffix (e.g., JR or III) (ST)> ^ <Prefix (e.g., DR) (ST)> ^ <DEPRECATED-Degree (e.g., MD) (IS)> ^ <Name Type Code (ID)> ^ <Name Representation Code (ID)> ^ <Name Context (CE)> ^ <DEPRECATED-Name Validity Range (DR)> ^ <Name Assembly Order (ID)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)> ^ <Professional Suffix (ST)>

Subcomponents for Family Name (FN): <Surname (ST)> & <Own Surname Prefix (ST)> & <Own Surname (ST)> & <Surname Prefix From Partner/Spouse (ST)> & <Surname From Partner/Spouse (ST)>

Subcomponents for Name Context (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Subcomponents for DEPRECATED-Name Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

15.4.8.4 STF-4 Staff Type (IS) 00674

Definition: This field contains a code identifying what type of staff. Refer to User-defined Table 0182 - Staff type for suggested values. Values may include codes for staff, practitioner (physician, nurse, therapist, etc.), referral agent or agency, etc.

User-defined Table 0182 _ Staff type

Value Description Comment
... No suggested values defined

15.4.8.5 STF-5 Administrative Sex (IS) 00111

Definition: This field contains the staff person_s sex. Refer to User-defined Table 0001 _ Administrative Sex for suggested values.

15.4.8.6 STF-6 Date/Time of Birth (TS) 00110

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

Definition: This field contains a staff member_s date and time of birth.

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

Definition: This field indicates whether person is currently a valid staff member. Refer to HL7 Table 0183 - Active/inactive for valid values.

HL7 Table 0183 - Active/Inactive

Value Description Comment
A Active Staff
I Inactive Staff

15.4.8.8 STF-8 Department (CE) 00676

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains the institution department to which this person reports or belongs. Refer to User-defined Table 0184 - Department for suggested values.

User-defined Table 0184 _ Department

Value Description Comment
... No suggested values defined

15.4.8.9 STF-9 Hospital Service - STF (CE) 00677

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains the hospital or ancillary service with which this staff person is associated. Refer to User-defined Table 0069 - Hospital service for suggested values.

15.4.8.10 STF-10 Phone (XTN) 00678

Components: <DEPRECATED-Telephone Number (ST)> ^ <Telecommunication Use Code (ID)> ^ <Telecommunication Equipment Type (ID)> ^ <Email Address (ST)> ^ <Country Code (NM)> ^ <Area/City Code (NM)> ^ <Local Number (NM)> ^ <Extension (NM)> ^ <Any Text (ST)> ^ <Extension Prefix (ST)> ^ <Speed Dial Code (ST)> ^ <Unformatted Telephone number (ST)>

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.

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

Components: <Street Address (SAD)> ^ <Other Designation (ST)> ^ <City (ST)> ^ <State or Province (ST)> ^ <Zip or Postal Code (ST)> ^ <Country (ID)> ^ <Address Type (ID)> ^ <Other Geographic Designation (ST)> ^ <County/Parish Code (IS)> ^ <Census Tract (IS)> ^ <Address Representation Code (ID)> ^ <DEPRECATED-Address Validity Range (DR)> ^ <Effective Date (TS)> ^ <Expiration Date (TS)>

Subcomponents for Street Address (SAD): <Street or Mailing Address (ST)> & <Street Name (ST)> & <Dwelling Number (ST)>

Subcomponents for DEPRECATED-Address Validity Range (DR): <Range Start Date/Time (TS)> & <Range End Date/Time (TS)>

Note subcomponent contains sub-subcomponents

Subcomponents for Effective Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Expiration Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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.

15.4.8.12 STF-12 Institution Activation Date (DIN) 00680

Components: <Date (TS)> ^ <Institution Name (CE)>

Subcomponents for Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Institution Name (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

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 for valid values.

User-defined Table 0537 _ Institution

Value Description Comment
... No suggested values defined

15.4.8.13 STF-13 Institution Inactivation Date (DIN) 00681

Components: <Date (TS)> ^ <Institution Name (CE)>

Subcomponents for Date (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Institution Name (CE): <Identifier (ST)> & <Text (ST)> & <Name of Coding System (ID)> & <Alternate Identifier (ST)> & <Alternate Text (ST)> & <Name of Alternate Coding System (ID)>

Definition: This field contains the date when staff became inactive for an institution. This is a repeating field. Refer to HL7 Table 0537 - Institution for valid values.

15.4.8.14 STF-14 Backup Person ID (CE) 00682

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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.

15.4.8.15 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).

15.4.8.16 STF-16 Preferred Method of Contact (CE) 00684

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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 for valid values.

HL7 Table 0185 - Preferred method of contact

Value Description Comment
B Beeper Number
C Cellular Phone Number
E E-Mail Address (for backward compatibility)
F FAX Number
H Home Phone Number
O Office Phone Number

15.4.8.17 STF-17 Marital Status (CE) 00119

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains the staff member_s marital status. Refer to User-defined Table 0002 - Marital status for suggested values. Same values as those for PID-16-marital status.

15.4.8.18 STF-18 Job Title (ST) 00785

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

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

Components: <Job Code (IS)> ^ <Job Class (IS)> ^ <Job Description Text (TX)>

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 for suggested values.

15.4.8.20 STF-20 Employment Status Code (CE) 01276

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

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 for suggested values.

User-defined Table 0066 _ Employment status

Value Description Comment

see chapter 6

15.4.8.21 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 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

15.4.8.22 STF-22 Driver_s License Number - Staff (DLN) 01302

Components: <License Number (ST)> ^ <Issuing State, Province, Country (IS)> ^ <Expiration Date (DT)>

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.

15.4.8.23 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 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

15.4.8.24 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.

15.4.8.25 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.

15.4.8.26 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.

15.4.8.27 STF-27 Race (CE) 00113

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field refers to the person's race. Refer to User-defined Table 0005 - Race 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.

User-defined Table 0005 - Race

Value Description Comment
... see chapter 3

15.4.8.28 STF-28 Ethnic Group (CE) 00125

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field further defines the person_s ancestry. Refer to User-defined Table 0189 - Ethnic group for suggested values. The second couplet 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 United States, a current use is to report ethnicity in line with US federal standards for Hispanic origin.

User-defined Table 0189 _ Ethnic group

Value Description Comment
... see chapter 3

15.4.8.29 STF-29 Re-activate 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 for valid values.

Y the re-activation requires approval

N this re-activation does not require approval

15.4.8.30 STF-30 Citizenship (CWE) 00129

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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.

User-defined Table 0171 - Citizenship

Value Description Comment

See Chapter 3

15.4.8.31 STF-31 Date of Death (TS) 01886

Components: <Time (DTM)> ^ <DEPRECATED-Degree of Precision (ID)>

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

15.4.8.32 STF-32 Death Indicator (ID) 01887

Definition: This field indicates whether the staff person is deceased. Refer to HL7 Table 0136 - Yes/no indicator for valid values.

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

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

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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 for suggested values.

User-defined Table 0538 _ Institution Relationship Type

Value Description Comment
EMP Employee
VOL Volunteer
CON Contractor
CST Consultant

15.4.8.34 STF-34 Institution Relationship Period (DR) 01889

Components: <Range Start Date/Time (TS)> ^ <Range End Date/Time (TS)>

Subcomponents for Range Start Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

Subcomponents for Range End Date/Time (TS): <Time (DTM)> & <DEPRECATED-Degree of Precision (ID)>

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

15.4.8.35 STF-35 Expected Return Date (DT) 01890

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

15.4.8.36 STF-36 Cost Center Code (CWE) 01891

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)> ^ <Coding System Version ID (ST)> ^ <Alternate Coding System Version ID (ST)> ^ <Original Text (ST)>

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 HL7 User-defined Table 0539 _ Cost center code for valid values.

User-defined Table 0539 _ Cost Center Code

Value Description Comment

no suggested values

15.4.8.37 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

15.4.8.38 STF-38 Inactive Reason Code (CE) 01893

Components: <Identifier (ST)> ^ <Text (ST)> ^ <Name of Coding System (ID)> ^ <Alternate Identifier (ST)> ^ <Alternate Text (ST)> ^ <Name of Alternate Coding System (ID)>

Definition: This field contains the reason that the staff member is inactive. Refer to User-defined Table 0540 _ Inactive Reason Code for suggested values.

User-defined Table 0540 _ Inactive Reason Code

Value Description Comment
L Leave of Absence
T Termination
R Retired

15.5 EXAMPLE TRANSACTIONS

15.5.1 Add Personnel Record - Event B01

MSH|^~\&|HL7REG|UH|HL7LAB|CH|199902280700||PMU^B01^PMU_B01|MSGID002|P|2.4|<cr<

EVN|B01|199902280700|<cr>

STF||U2246^^^PLW~111223333^^^USSSA^SS|KILDARE^RICHARD^J^JR^DR^M.D.|P|M|19511004|A|^ICU|^MED|(206)689-1999X345CO~(206)283-3334CH(206)689-1345X789CB|214 JOHNSON ST^SUITE 200^SEATTLE^WA^98199^H~3029 24TH AVE W^^SEATTLE, WA^98198^O |19890125^UMC&University Medical Center&L01||PMF88123453334|74160.2326@COMPUSERV.COM|B

PRA||^KILDARE 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|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|HARVARD MEDICAL SCHOOL^L |M^HL70402|123 MASSACHUSETTS AVENUE^CAMBRIDGE^MA^76543^U.S.A.^M|

15.6 OUTSTANDING ISSUES

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