|
Co-Chair: |
Alexander de Leon |
|
Co-Chair: |
Irma Jongeneel-de Haas |
|
Co-Chair: |
Brian Postlethwaite |
|
Co-Chair: |
Line Saele |
|
Chapter Chair & Editor |
Frank Oemig |
|
Sponsoring Working Group: |
Patient Administration WG |
|
List Server: |
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 | Must Implement | Status |
|---|---|---|---|
PMU_B01
|
|||
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
|
AFF
|
0..* | additional | |
|
LAN
|
0..* | additional | |
|
EDU
|
0..* | additional | |
|
CER
|
0..* | additional | |
|
NK1
|
0..* | additional | |
|
PRT
|
0..* | additional | |
ROL
|
0..* | deprecated | |
Send Application Ack: ACK^B01^ACK
When the MSH-15 value of a PMU^B01^PMU_B01 message is AL or ER or SU, an ACK^B01^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B01^PMU_B01 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B01^PMU_B01 message is AL or ER or SU, an ACK^B01^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B01^PMU_B01 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B01^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B01^ACK |
| NE, AL, ER, SU | (none) |
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 | Must Implement | Status |
|---|---|---|---|
|
PMU_B01
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
|
AFF
|
0..* | additional | |
|
LAN
|
0..* | additional | |
|
EDU
|
0..* | additional | |
|
CER
|
0..* | additional | |
|
NK1
|
0..* | additional | |
|
PRT
|
0..* | additional | |
|
ROL
|
0..* | deprecated | |
Send Application Ack: ACK^B02^ACK
When the MSH-15 value of a PMU^B02^PMU_B01 message is AL or ER or SU, an ACK^B02^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B02^PMU_B01 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B02^PMU_B01 message is AL or ER or SU, an ACK^B02^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B02^PMU_B01 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B02^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B02^ACK |
| NE, AL, ER, SU | (none) |
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.
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
PMU_B03
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
Send Application Ack: ACK^B03^ACK
When the MSH-15 value of a PMU^B03^PMU_B03 message is AL or ER or SU, an ACK^B03^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B03^PMU_B03 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B03^PMU_B03 message is AL or ER or SU, an ACK^B03^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B03^PMU_B03 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B03^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B03^ACK |
| NE, AL, ER, SU | (none) |
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.
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
PMU_B04
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
Send Application Ack: ACK^B04^ACK
When the MSH-15 value of a PMU^B04^PMU_B04 message is AL or ER or SU, an ACK^B04^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B04^PMU_B04 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B04^PMU_B04 message is AL or ER or SU, an ACK^B04^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B04^PMU_B04 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B04^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B04^ACK |
| NE, AL, ER, SU | (none) |
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.
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
PMU_B04
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
Send Application Ack: ACK^B05^ACK
When the MSH-15 value of a PMU^B05^PMU_B04 message is AL or ER or SU, an ACK^B05^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B05^PMU_B04 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B05^PMU_B04 message is AL or ER or SU, an ACK^B05^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B05^PMU_B04 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B05^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B05^ACK |
| NE, AL, ER, SU | (none) |
An event B06 signals that the formal relationship between a staff member and the institution has ended (i.e., upon termination).
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
PMU_B04
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
Send Application Ack: ACK^B06^ACK
When the MSH-15 value of a PMU^B06^PMU_B04 message is AL or ER or SU, an ACK^B06^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B06^PMU_B04 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B06^PMU_B04 message is AL or ER or SU, an ACK^B06^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B06^PMU_B04 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B06^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B06^ACK |
| NE, AL, ER, SU | (none) |
The following trigger event is served by the following Conformance Statement: Another application determines a need for Personnel data about a person and sends a query to a system providing this information.
|
Conformance Statement ID: |
Q25 |
|
Query Table Type: |
Query |
|
Query Name: |
Personnel Information by Segment |
|
Query Trigger: |
QBP^Q25^QBP_Q21 |
|
Query Mode: |
Both |
|
Response Trigger: |
RSP^K25^RSP_K25 |
|
Query Characteristics |
Returns response sorted by STF-3 Staff Name |
|
Purpose: |
Retrieve all available personnel information based upon the values of one or more commonly used search parameters |
|
Response Characteristics: |
Returns response sorted by StaffName unless otherwise specified. |
|
Based on Segment Pattern: |
PMU_B01 |
|
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 |
PRA.3 |
PRA-3: Practitioner Category |
||
|
4 |
Language |
S |
Y |
60 |
CWE |
O |
Y |
in |
LAN.2 |
LAN-2: Language |
||
|
5 |
LanguageAbility |
Y |
60 |
CWE |
C |
Y |
in |
LAN.3 |
LAN-3: Language Ability |
|||
|
6 |
LanguageProficiency |
Y |
60 |
CWE |
C |
Y |
in |
LAN.4 |
LAN-4: Language Proficiency |
|
Input Parameter |
Comp Name |
DT |
Description |
|
StaffIDCode |
CX |
Components: <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility (HD)> |
|
|
This field contains a personnel identification code or institution user number, used by the institution to identify the requested person. |
|||
|
If this field is not valued, all values for this field are considered to be a match. |
|||
|
The following components may be specified: |
|||
|
ID |
If this field, STF.2.1, is not valued, all values for this field are considered to be a match. |
||
|
Assigning Authority |
If this field, STF.2.4, is not valued, all values for this field are considered to be a match. |
||
|
Identifier type code |
If this field, STF.2.5, is not valued, all values for this field are considered to be a match. |
||
|
StaffName |
XPN |
If this field is not valued, all values for this field are considered to be a match. |
|
|
PractitionerCategory |
IS |
If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified. |
|
|
Language |
CWE |
If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified. |
|
|
LanguageAbility |
CWE |
The Server will evaluate this field only if the Language field is specified; otherwise, this field will be ignored. If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified. |
|
|
LanguageProficiency |
CWE |
The Server will evaluate this field only if the Language field is specified; otherwise, this field will be ignored. If this field is not valued, all values for this field are considered to be a match. If this field contains multiple values, the Server will record a match for any of the match values specified. |
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).
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
QBP_Q21
|
|||
Send Application Ack: RSP^K25^RSP_K25
When the MSH-15 value of a QBP^Q25^QBP_Q21 message is AL or ER or SU, an ACK^Q25^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a QBP^Q25^QBP_Q21 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a QBP^Q25^QBP_Q21 message is AL or ER or SU, a RSP^K25^RSP_K25 message SHALL be sent as an application ack.
When the MSH-16 value of a QBP^Q25^QBP_Q21 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^Q25^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: RSP^K25^RSP_K25 |
| NE, AL, ER, SU | (none) |
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
RSP_K25
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
MSA
|
1..1 | Yes | additional |
|
ERR
|
0..* | additional | |
|
QAK
|
1..1 | Yes | additional |
|
QPD
|
1..1 | Yes | additional |
|
RCP
|
1..1 | Yes | additional |
STAFF
|
1..* | Yes | additional |
STF
|
1..1 | Yes | additional |
|
PRA
|
0..* | additional | |
|
ORG
|
0..* | additional | |
|
AFF
|
0..* | additional | |
|
LAN
|
0..* | additional | |
|
EDU
|
0..* | additional | |
|
CER
|
0..* | additional | |
|
NK1
|
0..* | additional | |
|
PRT
|
0..* | additional | |
|
ROL
|
0..* | deprecated | |
|
DSC
|
0..1 | additional | |
Send Immediate Ack: ACK^K25^ACK
When the MSH-15 value of a RSP^K25^RSP_K25 message is AL or ER or SU, an ACK^K25^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a RSP^K25^RSP_K25 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a RSP^K25^RSP_K25 message is AL or ER or SU, a message SHALL be sent as an application ack.
When the MSH-16 value of a RSP^K25^RSP_K25 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^K25^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: |
| NE, AL, ER, SU | (none) |
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 | Must Implement | Status |
|---|---|---|---|
|
PMU_B07
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..1 | additional | |
CERTIFICATE
|
0..* | additional | |
CER
|
1..1 | Yes | additional |
|
PRT
|
0..* | additional | |
|
ROL
|
0..* | deprecated | |
Send Application Ack: ACK^B07^ACK
When the MSH-15 value of a PMU^B07^PMU_B07 message is AL or ER or SU, an ACK^B07^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B07^PMU_B07 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B07^PMU_B07 message is AL or ER or SU, an ACK^B07^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B07^PMU_B07 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B07^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B07^ACK |
| NE, AL, ER, SU | (none) |
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.
| Segment | Cardinality | Must Implement | Status |
|---|---|---|---|
|
PMU_B08
|
|||
|
MSH
|
1..1 | Yes | additional |
|
SFT
|
0..* | additional | |
|
UAC
|
0..1 | additional | |
|
EVN
|
1..1 | Yes | additional |
|
STF
|
1..1 | Yes | additional |
|
PRA
|
0..1 | additional | |
|
CER
|
0..* | additional | |
Send Application Ack: ACK^B08^ACK
When the MSH-15 value of a PMU^B08^PMU_B08 message is AL or ER or SU, an ACK^B08^ACK message SHALL be sent as an immediate ack.
When the MSH-15 value of a PMU^B08^PMU_B08 message is NE or AL or ER or SU, an immediate ack SHALL NOT be sent.
When the MSH-16 value of a PMU^B08^PMU_B08 message is AL or ER or SU, an ACK^B08^ACK message SHALL be sent as an application ack.
When the MSH-16 value of a PMU^B08^PMU_B08 message is NE or AL or ER or SU, an application ack SHALL NOT be sent.
| Field | Value | Send Response |
|---|---|---|
| MSH-15 | AL, ER, SU | immediate ack: ACK^B08^ACK |
| NE, AL, ER, SU | (none) | |
| MSH-16 | AL, ER, SU | application ack: ACK^B08^ACK |
| NE, AL, ER, SU | (none) |
The AFF segment adds detailed information regarding professional affiliations with which the staff member identified by the STF segment is/was associated.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
AFF
|
|||||||||
|
1
|
Set ID – AFF | SI | R | [1..1] | 01427 | [1..4] | |||
|
2
|
Professional Organization | XON | R | [1..1] | 01444 | ||||
|
3
|
Professional Organization Address | XAD | O | [0..1] | 01445 | ||||
|
4
|
Professional Organization Affiliation Date Range | DR | O | [0..*] | 01446 | ||||
|
5
|
Professional Affiliation Additional Information | ST | O | [0..1] | 01447 | 60 | # | ||
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.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
CER
|
|||||||||
|
1
|
Set ID – CER | SI | R | [1..1] | 01856 | [1..4] | |||
|
2
|
Serial Number | ST | O | [0..1] | 01857 | 80 | # | ||
|
3
|
Version | ST | O | [0..1] | 01858 | 80 | # | ||
|
4
|
Granting Authority | XON | O | [0..1] | 01859 | ||||
|
5
|
Issuing Authority | XCN | O | [0..1] | 01860 | ||||
|
6
|
Signature | ED | O | [0..1] | 01861 | ||||
|
7
|
Granting Country | ID | O | [0..1] | 01862 | [3..3] | |||
|
8
|
Granting State/Province | CWE | O | [0..1] | 01863 | ||||
|
9
|
Granting County/Parish | CWE | O | [0..1] | 01864 | ||||
|
10
|
Certificate Type | CWE | O | [0..1] | 01865 | ||||
|
11
|
Certificate Domain | CWE | O | [0..1] | 01866 | ||||
|
12
|
Subject ID | EI | C | [0..1] | 01867 | ||||
|
13
|
Subject Name | ST | R | [1..1] | 01907 | 250 | # | ||
|
14
|
Subject Directory Attribute Extension | CWE | O | [0..*] | 01868 | ||||
|
15
|
Subject Public Key Info | CWE | O | [0..1] | 01869 | ||||
|
16
|
Authority Key Identifier | CWE | O | [0..1] | 01870 | ||||
|
17
|
Basic Constraint | ID | O | [0..1] | 01871 | [1..1] | |||
|
18
|
CRL Distribution Point | CWE | O | [0..*] | 01872 | ||||
|
19
|
Jurisdiction Country | ID | O | [0..1] | 01875 | [3..3] | |||
|
20
|
Jurisdiction State/Province | CWE | O | [0..1] | 01873 | ||||
|
21
|
Jurisdiction County/Parish | CWE | O | [0..1] | 01874 | ||||
|
22
|
Jurisdiction Breadth | CWE | O | [0..*] | 01895 | ||||
|
23
|
Granting Date | DTM | O | [0..1] | 01876 | ||||
|
24
|
Issuing Date | DTM | O | [0..1] | 01877 | ||||
|
25
|
Activation Date | DTM | O | [0..1] | 01878 | ||||
|
26
|
Inactivation Date | DTM | O | [0..1] | 01879 | ||||
|
27
|
Expiration Date | DTM | O | [0..1] | 01880 | ||||
|
28
|
Renewal Date | DTM | O | [0..1] | 01881 | ||||
|
29
|
Revocation Date | DTM | O | [0..1] | 01882 | ||||
|
30
|
Revocation Reason Code | CWE | O | [0..1] | 01883 | ||||
|
31
|
Certificate Status Code | CWE | O | [0..1] | 01884 | ||||
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.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
EDU
|
|||||||||
|
1
|
Set ID – EDU | SI | R | [1..1] | 01448 | [1..4] | |||
|
2
|
Academic Degree | CWE | O | [0..1] | 01449 | ||||
|
3
|
Academic Degree Program Date Range | DR | O | [0..1] | 01597 | ||||
|
4
|
Academic Degree Program Participation Date Range | DR | O | [0..1] | 01450 | ||||
|
5
|
Academic Degree Granted Date | DT | O | [0..1] | 01451 | ||||
|
6
|
School | XON | O | [0..1] | 01452 | ||||
|
7
|
School Type Code | CWE | O | [0..1] | 01453 | ||||
|
8
|
School Address | XAD | O | [0..1] | 01454 | ||||
|
9
|
Major Field of Study | CWE | O | [0..*] | 01885 | ||||
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.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
LAN
|
|||||||||
|
1
|
Set ID – LAN | SI | R | [1..1] | 01455 | [1..4] | |||
|
2
|
Language Code | CWE | R | [1..1] | 01456 | ||||
|
3
|
Language Ability Code | CWE | O | [0..*] | 01457 | ||||
|
4
|
Language Proficiency Code | CWE | O | [0..1] | 01458 | ||||
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.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
ORG
|
|||||||||
|
1
|
Set ID – ORG | SI | R | [1..1] | 01459 | [1..4] | |||
|
2
|
Organization Unit Code | CWE | O | [0..1] | 01460 | ||||
|
3
|
Organization Unit Type Code | CWE | O | [0..1] | 01625 | ||||
|
4
|
Primary Org Unit Indicator | ID | O | [0..1] | 01462 | [1..1] | |||
|
5
|
Practitioner Org Unit Identifier | CX | O | [0..1] | 01463 | ||||
|
6
|
Health Care Provider Type Code | CWE | O | [0..1] | 01464 | ||||
|
7
|
Health Care Provider Classification Code | CWE | O | [0..1] | 01614 | ||||
|
8
|
Health Care Provider Area of Specialization Code | CWE | O | [0..1] | 01615 | ||||
|
9
|
Effective Date Range | DR | O | [0..1] | 01465 | ||||
|
10
|
Employment Status Code | CWE | O | [0..1] | 01276 | ||||
|
11
|
Board Approval Indicator | ID | O | [0..1] | 01467 | [1..1] | |||
|
12
|
Primary Care Physician Indicator | ID | O | [0..1] | 01468 | [1..1] | |||
|
13
|
Cost Center Code | CWE | O | [0..*] | 01891 | ||||
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."
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
PRA
|
|||||||||
|
1
|
Primary Key Value - PRA | CWE | C | [0..1] | 00685 | ||||
|
2
|
Practitioner Group | CWE | O | [0..*] | 00686 | ||||
|
3
|
Practitioner Category | CWE | O | [0..*] | 00687 | ||||
|
4
|
Provider Billing | ID | O | [0..1] | 00688 | [1..1] | |||
|
5
|
Specialty | SPD | O | [0..*] | 00689 | ||||
|
6
|
Practitioner ID Numbers | PLN | B | [0..*] | 00690 | ||||
|
7
|
Privileges | PIP | O | [0..*] | 00691 | ||||
|
8
|
Date Entered Practice | DT | O | [0..1] | 01296 | ||||
|
9
|
Institution | CWE | O | [0..1] | 01613 | ||||
|
10
|
Date Left Practice | DT | O | [0..1] | 01348 | ||||
|
11
|
Government Reimbursement Billing Eligibility | CWE | O | [0..*] | 01388 | ||||
|
12
|
Set ID - PRA | SI | C | [0..1] | 01616 | [1..4] | |||
Attention: This segment is retained for backwards compatibility as of v 2.7. The reader is referred to the PRT segment described in Chapter 7.
The role segment contains the data necessary to add, update, correct, and delete from the record persons involved, as well as their functional involvement with the activity being transmitted.
In general, the ROL segment is used to describe a person playing a particular role within the context of the message. In PM, for example, in the Grant Certificate/Permission message (B07), the ROL segment is used to describe the roles a person may perform pertinent to the certificate in the message.
The positional location of the ROL segment in ADT and Finance messages indicates the relationship. When the segment is used following the IN3 segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the health plan. When the segment is used following the PID segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the person. When the segment is used following the PV2 segment, and the role-ROL value is PCP or FHCP, the PP or FHCP is related to the patient visit.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
ROL
|
|||||||||
|
1
|
Role Instance ID | EI | - | 01206 | |||||
|
2
|
Action Code | ID | - | 00816 | [2..2] | ||||
|
3
|
Role-ROL | CWE | - | 01197 | |||||
|
4
|
Role Person | XCN | - | 01198 | |||||
|
5
|
Role Begin Date/Time | DTM | - | 01199 | |||||
|
6
|
Role End Date/Time | DTM | - | 01200 | |||||
|
7
|
Role Duration | CWE | - | 01201 | |||||
|
8
|
Role Action Reason | CWE | - | 01205 | |||||
|
9
|
Provider Type | CWE | - | 01510 | |||||
|
10
|
Organization Unit Type | CWE | - | 01461 | |||||
|
11
|
Office/Home Address/Birthplace | XAD | - | 00679 | |||||
|
12
|
Phone | XTN | - | 00678 | |||||
|
13
|
Person's Location | PL | - | 02183 | |||||
|
14
|
Organization | XON | - | 02377 | |||||
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.
| Seq# | Data Element Name | DataType | Usage | Vocabulary | Cardinality | Item # | Length | C.LEN | Flags |
|---|---|---|---|---|---|---|---|---|---|
|
STF
|
|||||||||
|
1
|
Primary Key Value – STF | CWE | C | [0..1] | 00671 | ||||
|
2
|
Staff Identifier List | CX | O | [0..*] | 00672 | ||||
|
3
|
Staff Name | XPN | O | [0..*] | 00673 | ||||
|
4
|
Staff Type | CWE | O | [0..*] | 00674 | ||||
|
5
|
Administrative Sex | CWE | O | [0..1] | 00111 | ||||
|
6
|
Date/Time of Birth | DTM | O | [0..1] | 00110 | ||||
|
7
|
Active/Inactive Flag | ID | O | [0..1] | 00675 | [1..1] | |||
|
8
|
Department | CWE | O | [0..*] | 00676 | ||||
|
9
|
Hospital Service – STF | CWE | O | [0..*] | 00677 | ||||
|
10
|
Phone | XTN | O | [0..*] | 00678 | ||||
|
11
|
Office/Home Address/Birthplace | XAD | O | [0..*] | 00679 | ||||
|
12
|
Institution Activation Date | DIN | O | [0..*] | 00680 | ||||
|
13
|
Institution Inactivation Date | DIN | O | [0..*] | 00681 | ||||
|
14
|
Backup Person ID | CWE | O | [0..*] | 00682 | ||||
|
15
|
E-Mail Address | ST | B | [0..*] | 00683 | 40 | # | ||
|
16
|
Preferred Method of Contact | CWE | O | [0..1] | 00684 | ||||
|
17
|
Marital Status | CWE | O | [0..1] | 00119 | ||||
|
18
|
Job Title | ST | O | [0..1] | 00785 | 20 | # | ||
|
19
|
Job Code/Class | JCC | O | [0..1] | 00786 | ||||
|
20
|
Employment Status Code | CWE | O | [0..1] | 01276 | ||||
|
21
|
Additional Insured on Auto | ID | O | [0..1] | 01275 | [1..1] | |||
|
22
|
Driver's License Number – Staff | DLN | O | [0..1] | 01302 | ||||
|
23
|
Copy Auto Ins | ID | O | [0..1] | 01229 | [1..1] | |||
|
24
|
Auto Ins Expires | DT | O | [0..1] | 01232 | ||||
|
25
|
Date Last DMV Review | DT | O | [0..1] | 01298 | ||||
|
26
|
Date Next DMV Review | DT | O | [0..1] | 01234 | ||||
|
27
|
Race | CWE | O | [0..1] | 00113 | ||||
|
28
|
Ethnic Group | CWE | O | [0..1] | 00125 | ||||
|
29
|
Re-activation Approval Indicator | ID | O | [0..1] | 01596 | [1..1] | |||
|
30
|
Citizenship | CWE | O | [0..*] | 00129 | ||||
|
31
|
Date/Time of Death | DTM | O | [0..1] | 01886 | ||||
|
32
|
Death Indicator | ID | O | [0..1] | 01887 | [1..1] | |||
|
33
|
Institution Relationship Type Code | CWE | O | [0..1] | 01888 | ||||
|
34
|
Institution Relationship Period | DR | O | [0..1] | 01889 | ||||
|
35
|
Expected Return Date | DT | O | [0..1] | 01890 | ||||
|
36
|
Cost Center Code | CWE | O | [0..*] | 01891 | ||||
|
37
|
Generic Classification Indicator | ID | O | [0..1] | 01892 | [1..1] | |||
|
38
|
Inactive Reason Code | CWE | O | [0..1] | 01893 | ||||
|
39
|
Generic resource type or category | CWE | O | [0..*] | 02184 | ||||
|
40
|
Religion | CWE | O | [0..1] | 00120 | ||||
|
41
|
Signature | ED | O | [0..1] | 01861 | ||||
MSH|^~VALUEamp;|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|
®© HL7.org 2019+. HL7 v2+ generated on March 14, 2022
Links:
Version History
|
Propose a change
|
License
The Demo site for our new HL7 Version 2+ (plus) Standard
