Attention: This segment is retained for backwards compatibility as of v 2.7. The reader is referred to the PRT segment described in Chapter 7.
The role segment contains the data necessary to add, update, correct, and delete from the record persons involved, as well as their functional involvement with the activity being transmitted.
In general, the ROL segment is used to describe a person playing a particular role within the context of the message. In PM, for example, in the Grant Certificate/Permission message (B07), the ROL segment is used to describe the roles a person may perform pertinent to the certificate in the message.
The positional location of the ROL segment in ADT and Finance messages indicates the relationship. When the segment is used following the IN3 segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the health plan. When the segment is used following the PID segment, and the role-ROL value is PP or FHCP, the PP or FHCP is related to the person. When the segment is used following the PV2 segment, and the role-ROL value is PCP or FHCP, the PP or FHCP is related to the patient visit.
HL7 Attribute Table - ROL - Role
Base Framework | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
ROL | ||||||||||
1 | 01206 | Role Instance ID | - Element is deprecated! | SHALL NOT | [0..0] | EI Entity Identifier | ||||
2 | 00816 | Action Code | - Element is deprecated! | SHALL NOT | [0..0] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | ||
3 | 01197 | Role-ROL | - Element is deprecated! | SHALL NOT | [0..0] | ProviderRole (CD) | CWE Coded with Exceptions | |||
4 | 01198 | Role Person | - Element is deprecated! | SHALL NOT | [0..0] | XCN Extended Composite ID Number and Name for Persons | ||||
5 | 01199 | Role Begin Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | ||||
6 | 01200 | Role End Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | ||||
7 | 01201 | Role Duration | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
8 | 01205 | Role Action Reason | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
9 | 01510 | Provider Type | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
10 | 01461 | Organization Unit Type | - Element is deprecated! | SHALL NOT | [0..0] | ex.:ParticipantOrganizationUnitType (CD) | CWE Coded with Exceptions | |||
11 | 00679 | Office/Home Address/Birthplace | - Element is deprecated! | SHALL NOT | [0..0] | XAD Extended Address | ||||
12 | 00678 | Phone | - Element is deprecated! | SHALL NOT | [0..0] | XTN Extended Telecommunication Number | ||||
13 | 02183 | Person's Location | - Element is deprecated! | SHALL NOT | [0..0] | PL Person Location | ||||
14 | 02377 | Organization | - Element is deprecated! | SHALL NOT | [0..0] | XON Extended Composite Name and Identification Number for Organizations |
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
---|---|---|---|---|---|---|---|---|---|---|
ROL | ||||||||||
1 | 01206 | Role Instance ID | - Element is deprecated! | SHALL NOT | [0..0] | EI Entity Identifier | ||||
2 | 00816 | Action Code | - Element is deprecated! | SHALL NOT | [0..0] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | ||
3 | 01197 | Role-ROL | - Element is deprecated! | SHALL NOT | [0..0] | ProviderRole (CD) hl7VS-providerRole (VS) providerRole (CS) | CWE Coded with Exceptions | |||
4 | 01198 | Role Person | - Element is deprecated! | SHALL NOT | [0..0] | XCN Extended Composite ID Number and Name for Persons | ||||
5 | 01199 | Role Begin Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | ||||
6 | 01200 | Role End Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | ||||
7 | 01201 | Role Duration | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
8 | 01205 | Role Action Reason | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
9 | 01510 | Provider Type | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | ||||
10 | 01461 | Organization Unit Type | - Element is deprecated! | SHALL NOT | [0..0] | ex.:ParticipantOrganizationUnitType (CD) hl7VS-organizationUnitType (VS) organizationUnitType (CS) | CWE Coded with Exceptions | |||
11 | 00679 | Office/Home Address/Birthplace | - Element is deprecated! | SHALL NOT | [0..0] | XAD Extended Address | ||||
12 | 00678 | Phone | - Element is deprecated! | SHALL NOT | [0..0] | XTN Extended Telecommunication Number | ||||
13 | 02183 | Person's Location | - Element is deprecated! | SHALL NOT | [0..0] | PL Person Location | ||||
14 | 02377 | Organization | - Element is deprecated! | SHALL NOT | [0..0] | XON Extended Composite Name and Identification Number for Organizations |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
ROL | ||||||||||||
1 | 01206 | Role Instance ID | - Element is deprecated! | SHALL NOT | [0..0] | EI Entity Identifier | SHALL NOT | |||||
2 | 00816 | Action Code | - Element is deprecated! | SHALL NOT | [0..0] | [2..2] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | SHALL NOT | |||
3 | 01197 | Role-ROL | - Element is deprecated! | SHALL NOT | [0..0] | ProviderRole (CD) | CWE Coded with Exceptions | SHALL NOT | hl7VS-providerRole (VS) providerRole (CS) | |||
4 | 01198 | Role Person | - Element is deprecated! | SHALL NOT | [0..0] | XCN Extended Composite ID Number and Name for Persons | SHALL NOT | |||||
5 | 01199 | Role Begin Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | SHALL NOT | |||||
6 | 01200 | Role End Date/Time | - Element is deprecated! | SHALL NOT | [0..0] | DTM Date/Time | SHALL NOT | |||||
7 | 01201 | Role Duration | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | SHALL NOT | |||||
8 | 01205 | Role Action Reason | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | SHALL NOT | |||||
9 | 01510 | Provider Type | - Element is deprecated! | SHALL NOT | [0..0] | CWE Coded with Exceptions | SHALL NOT | |||||
10 | 01461 | Organization Unit Type | - Element is deprecated! | SHALL NOT | [0..0] | ex.:ParticipantOrganizationUnitType (CD) | CWE Coded with Exceptions | SHALL NOT | hl7VS-organizationUnitType (VS) organizationUnitType (CS) | |||
11 | 00679 | Office/Home Address/Birthplace | - Element is deprecated! | SHALL NOT | [0..0] | XAD Extended Address | SHALL NOT | |||||
12 | 00678 | Phone | - Element is deprecated! | SHALL NOT | [0..0] | XTN Extended Telecommunication Number | SHALL NOT | |||||
13 | 02183 | Person's Location | - Element is deprecated! | SHALL NOT | [0..0] | PL Person Location | SHALL NOT | |||||
14 | 02377 | Organization | - Element is deprecated! | SHALL NOT | [0..0] | XON Extended Composite Name and Identification Number for Organizations | SHALL NOT |
Base Framework | Base Standard Profile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
ROL | ||||||||||||
1 | 01206 | Role Instance ID | - | EI Entity Identifier |
||||||||
2 | 00816 | Action Code | - | [2..2] | ID Coded Value for HL7 Defined Tables |
(0206) | ||||||
3 | 01197 | Role-ROL | - | CWE Coded with Exceptions |
(0443) | |||||||
4 | 01198 | Role Person | - | Y | XCN Extended Composite ID Number and Name for Persons |
|||||||
5 | 01199 | Role Begin Date/Time | - | DTM Date/Time |
||||||||
6 | 01200 | Role End Date/Time | - | DTM Date/Time |
||||||||
7 | 01201 | Role Duration | - | CWE Coded with Exceptions |
||||||||
8 | 01205 | Role Action Reason | - | CWE Coded with Exceptions |
||||||||
9 | 01510 | Provider Type | - | Y | CWE Coded with Exceptions |
|||||||
10 | 01461 | Organization Unit Type | - | CWE Coded with Exceptions |
(0406) | |||||||
11 | 00679 | Office/Home Address/Birthplace | - | Y | XAD Extended Address |
|||||||
12 | 00678 | Phone | - | Y | XTN Extended Telecommunication Number |
|||||||
13 | 02183 | Person's Location | - | PL Person Location |
||||||||
14 | 02377 | Organization | - | XON Extended Composite Name and Identification Number for Organizations |
Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
---|---|---|---|---|---|---|---|---|---|
ROL | |||||||||
1 | 01206 | Role Instance ID | - | EI Entity Identifier |
|||||
2 | 00816 | Action Code | - | [2..2] | (0206) | ID Coded Value for HL7 Defined Tables |
|||
3 | 01197 | Role-ROL | - | (0443) | CWE Coded with Exceptions |
||||
4 | 01198 | Role Person | - | Y | XCN Extended Composite ID Number and Name for Persons |
||||
5 | 01199 | Role Begin Date/Time | - | DTM Date/Time |
|||||
6 | 01200 | Role End Date/Time | - | DTM Date/Time |
|||||
7 | 01201 | Role Duration | - | CWE Coded with Exceptions |
|||||
8 | 01205 | Role Action Reason | - | CWE Coded with Exceptions |
|||||
9 | 01510 | Provider Type | - | Y | CWE Coded with Exceptions |
||||
10 | 01461 | Organization Unit Type | - | (0406) | CWE Coded with Exceptions |
||||
11 | 00679 | Office/Home Address/Birthplace | - | Y | XAD Extended Address |
||||
12 | 00678 | Phone | - | Y | XTN Extended Telecommunication Number |
||||
13 | 02183 | Person's Location | - | PL Person Location |
|||||
14 | 02377 | Organization | - | XON Extended Composite Name and Identification Number for Organizations |