HL7 v2.5.1 Specificationsv2.5.1

↑↓ to moveEnter to openTry PID-5, ADT, 0004

ERR segment

The ERR segment is used to add error comments to acknowledgment messages. Use Cases: Severity: A receiving application generates two messages, one an error, and the other a warning and sends each of them. The application displays them both, prefixing the messages appropriately with the severity. Application Error Code: A receiving application generates an error that reports an application error code and returns this information in its response. This code in turn is used by helpdesk staff to pinpoint the exact

The shape of one line

segmentERR|ERR-1Error Code and Location|ERR-2Error Location|ERR-3HL7 Error Code|ERR-4Severity|ERR-5Application Error Code|ERR-6Application Error…|ERR-7Diagnostic Information|ERR-8User Message|ERR-9Inform Person Indicator|ERR-10Override Ty ep| …2 more

required optional kept for older systems, still counted

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 ERR-3 and its value arrives as ERR-2, so the receiver stores HL7 Error Code as Error Location.

This page carries the ERR 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 ERR.

Every field

SEQLENDTOPTRP/#TBL#ITEM#Element nameCardinality
493ELDBY00024Error Code and Location deprecated0..*

ERR-1 is a ELD, which holds 4 components separated by carets.

SEQLENDTOPTTBL#Component name
ELD.13STOSegment ID
ELD.22NMOSegment Sequence
ELD.32NMOField Position
ELD.4483CEO0357Code Identifying Error
18ERLOY01812Error Location0..*

ERR-2 is a ERL, which holds 6 components separated by carets.

SEQLENDTOPTTBL#Component name
ERL.13STRSegment ID
ERL.22NMRSegment Sequence
ERL.32NMOField Position
ERL.42NMOField Repetition
ERL.52NMOComponent Number
ERL.62NMOSub-Component Number
705CWER035701813HL7 Error Code1..1

ERR-3 is a CWE, which holds 9 components separated by carets.

SEQLENDTOPTTBL#Component name
CWE.120STOIdentifier
CWE.2199STOText
CWE.320IDO0396Name of Coding System
CWE.420STOAlternate Identifier
CWE.5199STOAlternate Text
CWE.620IDO0396Name of Alternate Coding System
CWE.710STCCoding System Version ID
CWE.810STOAlternate Coding System Version ID
CWE.9199STOOriginal Text
ERR-42IDR051601814Severity1..1
705CWEO053301815Application Error Code0..1

ERR-5 is a CWE, which holds 9 components separated by carets.

SEQLENDTOPTTBL#Component name
CWE.120STOIdentifier
CWE.2199STOText
CWE.320IDO0396Name of Coding System
CWE.420STOAlternate Identifier
CWE.5199STOAlternate Text
CWE.620IDO0396Name of Alternate Coding System
CWE.710STCCoding System Version ID
CWE.810STOAlternate Coding System Version ID
CWE.9199STOOriginal Text
ERR-680STOY/1001816Application Error Parameter0..10
ERR-72048TXO01817Diagnostic Information0..1
ERR-8250TXO01818User Message0..1
ERR-920ISOY051701819Inform Person Indicator0..*
705CWEO051801820Override Ty ep0..1

ERR-10 is a CWE, which holds 9 components separated by carets.

SEQLENDTOPTTBL#Component name
CWE.120STOIdentifier
CWE.2199STOText
CWE.320IDO0396Name of Coding System
CWE.420STOAlternate Identifier
CWE.5199STOAlternate Text
CWE.620IDO0396Name of Alternate Coding System
CWE.710STCCoding System Version ID
CWE.810STOAlternate Coding System Version ID
CWE.9199STOOriginal Text
705CWEOY051901821Override Reason Code0..*

ERR-11 is a CWE, which holds 9 components separated by carets.

SEQLENDTOPTTBL#Component name
CWE.120STOIdentifier
CWE.2199STOText
CWE.320IDO0396Name of Coding System
CWE.420STOAlternate Identifier
CWE.5199STOAlternate Text
CWE.620IDO0396Name of Alternate Coding System
CWE.710STCCoding System Version ID
CWE.810STOAlternate Coding System Version ID
CWE.9199STOOriginal Text
652XTNOY01822Help Desk Contact Point0..*

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

ERR appears in 53 message structures, belonging to 36 message types.