HL7 v2.5.1 Specificationsv2.5.1

to moveEnter to openTry PID-5, ADT, 0004

ROL 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. 15.4.7.0 ROL - Field Definitions 15.4.7.1 ROL-1 Role instance ID (EI) 01206 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

The shape of one line

segmentROL|ROL-1Role Instance ID|ROL-2Action Code|ROL-3Role-ROL|ROL-4Role Person|ROL-5Role Begin Date/Time|ROL-6Role End Date/Time|ROL-7Role Duration|ROL-8Role Action Reason|ROL-9Provider Type|ROL-10Organization Unit Type| …2 more

required required in some cases optional

Count the pipes to find a field, and count the empty ones too: an empty field still holds its place. Leave out the separator before ROL-2 and its value arrives as ROL-1, so the receiver stores Action Code as Role Instance ID.

This page carries the ROL field table as published and nothing beyond it. The field notes, vendor behaviour, FHIR mapping and parsing guidance that thePID page has are still to be written for ROL.

Every field

SEQLENDTOPTRP/#TBL#ITEM#Element nameCardinality
60EIC01206Role Instance ID0..1

ROL-1 is a EI, which holds 4 components separated by carets.

SEQLENDTOPTTBL#Component name
EI.1199STOEntity Identifier
EI.220ISO0363Namespace ID
EI.3199STCUniversal ID
EI.46IDC0301Universal ID Type
ROL-22IDR028700816Action Code1..1
250CER044301197Role-ROL1..1

ROL-3 is a CE, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
CE.120STOIdentifier
CE.2199STOText
CE.320IDO0396Name of Coding System
CE.420STOAlternate Identifier
CE.5199STOAlternate Text
CE.620IDO0396Name of Alternate Coding System
250XCNRY01198Role Person1..*

ROL-4 is a XCN, which holds 23 components separated by carets.

SEQLENDTOPTTBL#Component name
XCN.115STOID Number
XCN.2194FNOFamily Name
XCN.330STOGiven Name
XCN.430STOSecond and Further Given Names or Initials Thereof
XCN.520STOSuffix (e.g., JR or III)
XCN.620STOPrefix (e.g., DR)
XCN.75ISB0360Degree (e.g., MD)
XCN.84ISC0297Source Table
XCN.9227HDO0363Assigning Authority
XCN.101IDO0200Name Type Code
XCN.111STOIdentifier Check Digit
XCN.123IDC0061Check Digit Scheme
XCN.135IDO0203Identifier Type Code
XCN.14227HDOAssigning Facility
XCN.151IDO0465Name Representation Code
XCN.16483CEO0448Name Context
XCN.1753DRBName Validity Range
XCN.181IDO0444Name Assembly Order
XCN.1926TSOEffective Date
XCN.2026TSOExpiration Date
XCN.21199STOProfessional Suffix
XCN.22705CWEOAssigning Jurisdiction
XCN.23705CWEOAssigning Agency or Department
26TSO01199Role Begin Date/Time0..1

ROL-5 is a TS, which holds 2 components separated by carets.

SEQLENDTOPTTBL#Component name
TS.124DTMRTime
TS.21IDB0529Degree of Precision
26TSO01200Role End Date/Time0..1

ROL-6 is a TS, which holds 2 components separated by carets.

SEQLENDTOPTTBL#Component name
TS.124DTMRTime
TS.21IDB0529Degree of Precision
250CEO01201Role Duration0..1

ROL-7 is a CE, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
CE.120STOIdentifier
CE.2199STOText
CE.320IDO0396Name of Coding System
CE.420STOAlternate Identifier
CE.5199STOAlternate Text
CE.620IDO0396Name of Alternate Coding System
250CEO01205Role Action Reason0..1

ROL-8 is a CE, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
CE.120STOIdentifier
CE.2199STOText
CE.320IDO0396Name of Coding System
CE.420STOAlternate Identifier
CE.5199STOAlternate Text
CE.620IDO0396Name of Alternate Coding System
250CEOY01510Provider Type0..*

ROL-9 is a CE, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
CE.120STOIdentifier
CE.2199STOText
CE.320IDO0396Name of Coding System
CE.420STOAlternate Identifier
CE.5199STOAlternate Text
CE.620IDO0396Name of Alternate Coding System
250CEO040601461Organization Unit Type0..1

ROL-10 is a CE, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
CE.120STOIdentifier
CE.2199STOText
CE.320IDO0396Name of Coding System
CE.420STOAlternate Identifier
CE.5199STOAlternate Text
CE.620IDO0396Name of Alternate Coding System
250XADOY00679Office/Home Address/Birthplace0..*

ROL-11 is a XAD, which holds 14 components separated by carets.

SEQLENDTOPTTBL#Component name
XAD.1184SADOStreet Address
XAD.2120STOOther Designation
XAD.350STOCity
XAD.450STOState or Province
XAD.512STOZip or Postal Code
XAD.63IDO0399Country
XAD.73IDO0190Address Type
XAD.850STOOther Geographic Designation
XAD.920ISO0289County/Parish Code
XAD.1020ISO0288Census Tract
XAD.111IDO0465Address Representation Code
XAD.1253DRBAddress Validity Range
XAD.1326TSOEffective Date
XAD.1426TSOExpiration Date
250XTNOY00678Phone0..*

ROL-12 is a XTN, which holds 12 components separated by carets.

SEQLENDTOPTTBL#Component name
XTN.1199STBTelephone Number
XTN.23IDO0201Telecommunication Use Code
XTN.38IDO0202Telecommunication Equipment Type
XTN.4199STOEmail Address
XTN.53NMOCountry Code
XTN.65NMOArea/City Code
XTN.79NMOLocal Number
XTN.85NMOExtension
XTN.9199STOAny Text
XTN.104STOExtension Prefix
XTN.116STOSpeed Dial Code
XTN.12199STCUnformatted Telephone number

Message types carrying ROL

ROL appears in 35 message structures, belonging to 24 message types.