HL7 Tables

From IHE Wiki
Jump to: navigation, search

This page defines table-based values for HL7 messages in IHE Technical Framework.
Common tables (for #MSH, MSA, #PID, #PV1, #AL1, and #ZFU segments) are provided.
In addition, specific tables for each transaction are listed in the subsequent sections:


Contents

Codes for segments common to several HL7 transactions

Coding Scheme Designators

All HL7 fields with the data type CE shall be encoded with the IHE-defined Coding Scheme Designator value in the third and, if required, sixth component .

Value Description
99IHE Codes used during connectathon and demonstration

MSH

SEQ LEN DT OPT TBL# ITEM# ELEMENT NAME
1 1 ST R IHE001 00001 #Field Separator
2 4 ST R IHE002 00002 #Encoding Characters
3 180 HD R 0361 00003 Sending Application (#Sending/Receiving Application or Facility)
4 180 HD R 0362 00004 Sending Facility (#Sending/Receiving Application or Facility)
5 180 HD R 0361 00005 Receiving Application (#Sending/Receiving Application or Facility)
6 180 HD R 0362 00006 Receiving Facility (#Sending/Receiving Application or Facility)
7 26 TS O   00007 Date/Time Of Message
8 40 ST O   00008 Security
9 7 CM R 0076
0003
00009 Message Type
10 20 ST R   00010 Message Control ID
11 3 PT R 0103 00011 #Processing ID
12 8 ID R 0104 00012 #Version ID
13 15 NM O   00013 Sequence Number
14 180 ST O   00014 Continuation Pointer
15 2 ID O 0155 00015 Accept Acknowledgment Type
16 2 ID O 0155 00016 Application Acknowledgment Type
17 2 ID O   00017 Country Code
18 6 ID C 0211 00692 Character Set
19 60 CE O   00693 Principal Language Of Message
20 20 ID O 0356 01317 #Alternate Character Set Handling Scheme


Field Separator

Table IHE001 -
Field Separators
Value Description
Field Separator    |


Encoding Characters

Field MSH-2 Encoding Characters shall be encoded with four characters in the order suggested in the HL7 standard.

Table IHE002 Encoding Characters
Delimiter Value Encoding Character Position
Component Separator^1
Subcomponent Separator&4
Repetition Separator~2
Escape Character\3


Sending/Receiving Application or Facility

Fields MSH-3 Sending Application and MSH-5 Receiving Application shall contain only one component (Namespace ID) which shall be drawn from the following HL7 Table 0361.
Fields MSH-4 Sending Facility and MSH-6 Receiving Facility shall contain only one component (Namespace ID) which shall be drawn from the following HL7 Table 0361.


HL7 Table 0361 Receiving/Sending Application HL7 Table 03612 Receiving/Sending Facility
Value Description
System Company
MESA_ADTMESA Tools ADT 
MESA_OPMESA Tools OP 
MESA_OFMESA Tools OF 
facility name Gazelle system nameCompany Name
etc  


Processing ID

HL7 Table 0103 Processing ID
Value Description
P Production


Version ID

HL7 Table 0104 Version ID
Value Description
2.3.1Release 2.3.1


Alternate Character Set

HL7 Table 0211 Alternate Character Sets
Value Description
ASCIIThe printable 7-bit ASCII character set. (This is the default if this field is omitted. Connectathon only and IHE-I participant may use it.
8859/1The printable ISO 8859/1 character set.All IHE-F, IHE-D, IHE-I and IHE-UK participants shall use this value


PID

PID segment
SEQ LEN DT OPT TBL# ITEM# ELEMENT NAME
1 4 SI O   00104 Set ID - Patient ID
2 20 CX O   00105 Patient ID (External ID)
3 20 CX R   00106 Patient ID (Internal ID) (includes #Assigning Authority sub-component)
4 20 CX O   00107 Alternate Patient ID - PID (includes #Assigning Authority sub-component)
5 48 XPN R   00108 Patient Name
6 48 XPN O   00109 Mother s Maiden Name
7 26 TS R2   00110 Date/Time of Birth
8 1 IS R 0001 00111 #Sex
9 48 XPN O   00112 Patient Alias
10 1 IS R2 0005 00113 #Race
11 106 XAD R2   00114 Patient Address
124ISO 00115County Code
1340XTNO 00116Phone Number - Home
1440XTNO 00117Phone Number - Business
1560CEO029600118Primary Language
16 1 IS O 0002 00119 #Marital Status
173ISO000600120Religion
1820CXR 00120Patient Account Number
1916STO 00122SSN Number - Patient
2025DLNO 00123Driver's License Number - Patient
2120CXO 00124Mother's Identifier
20 3ISO018900125Ethnic Group
2360STO 00126Birth Place
242IDO013600127Multiple Birth Indicator
252NMO 00128Birth Order
264ISO017100129Citizenship
2760CEO017200130Veterans Military Status
2880CEO 00739Nationality
2926TSO 00740Patient Death Date and Time
301IDO013600741Patient Death Indicator


Forbidden PID Fields

The use of fields PID-10 (Race) and PID-22 (Ethnic Group) is forbidden in France.

PID-3 Patient Identifier List

Field PID-3 Patient Identifier List shall be encoded as a single repetition.
Use of check digit scheme for Patient ID is optional, thus components 2 and 3 of the field value may be omitted.
Component 4 -- the value Assigning Authority shall be present and contain only one subcomponent. Value of that subcomponent shall be drawn from the Table 0363 #Assigning Authority.

Patient ID Prefix

Patient Identifiers are 6 digit identifiers that begin with a two-digit code that identifies the system producing the ID. Thus, if your prefix is 13, your Patient Identifiers will be in the range of 100000 to 109999.

Patient ID Prefix
Prefix System
13 Gazelle system name
14 etc
15  
16  
17  
18  
19  
20  
21  
22  
23  
24  
25  


Assigning Authority

This table contains values for Assigning Authority for Patient Identifiers:

HL7 Table 0363 Assigning Authority
Value Description
MADTFor use in MESA testing (MESA ADT system) 
M_OPFor use in MESA testing (MESA Order Filler) 
IHOP ADT Patient Registration IHEJ
XXXX Gazelle system name
etc  


Sex

HL7 Table 0001 Sex Codes
Value Description
FFemale
MMale
OOther
UUnknown



Race

The value of the field PID-10 Race shall contain three components and be drawn from the user-defined table 0005 Race . First component shall be a code value from the table, second component a description from the same table, and third component is one of the #Coding Scheme Designators.
It is forbidden to transmit race information in France and in Germany.

User Table 0005 Race
Value Description
AIAmerican Indian or Alaskan Native
APAsian or Pacific Islander
BLBlack
HIHispanic
WHWhite


Marital Status

HL7 Table 0002 Marital Status Codes
Value Description French interpretation
A SeparatedSéparé
D DivorcedDivorcé
M MarriedMarié
S SingleCélibataire
W WidowedVeuf/Veuve
G Living TogetherConcubin
P Domestic PartnerPacte civil de solidarité (PACS)
U UnknownInconnu


PV1

PV1 Segment
SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
14SIO

00131SetID - PV1
21ISR
0004 00132#Patient Class
380PLC
IHE00300133#Assigned Patient Location
42ISO
000700134Admission Type
520CXO

00135Preadmit Number
680PLO

00136Prior Patient Location
760XCNCY 001000137Attending #Doctor
860XCNCY 0010 00138Referring #Doctor
960XCNR2Y 001000139Consulting #Doctor
103ISC
006900140#Hospital Service
1180PLO

00141Temporary Location
122ISO
008700142Preadmit Test Indicator
132ISO
009200143Readmission Indicator
143ISO
002300144Admit Source
152ISCY 000900145#Ambulatory Status
162ISO
009900146VIP Indicator
1760XCNCY001000147Admitting Doctor
182ISO
001800148Patient Type
1920CXC

00149Visit Number
2050FCOY006400150Financial Class
212ISO
003200151Charge Price Indicator
222ISO
004500152Courtesy Code
232ISO
004600153Credit Rating
242ISOY004400154Contract Code
258DTOY
00155Contract Effective Date
2612NMOY
00156Contract Amount
273NMOY
00157Contract Period
282ISO
007300158Interest Code
291ISO
011000159Transfer to Bad Debt Code
308DTO

00160Transfer to Bad Debt Date
3110ISO
002100161Bad Debt Agency Code
3212NMO

00162Bad Debt Transfer Amount
3312NMO

00163Bad Debt Recovery Amount
341ISO
011100164Delete Account Indicator
358DTO

00165Delete Account Date
363ISO
011200166Discharge Disposition
3725CMO
011300167Discharged to Location
382ISO
0114 00168#Diet Type
392ISO
011500169#Servicing Facility
401ISO
011600170Bed Status
412ISO
011700171Account Status
4280PLO

00172Pending Location
4380PLO

00173Prior Temporary Location
4426TSO

00174Admit Date/Time
4526TSO

00175Discharge Date/Time
4612NMO

00176Current Patient Balance
4712NMO

00177Total Charges
4812NMO

00178Total Adjustments
4912NMO

00179Total Payments
5020CXO
019200180Alternate Visit ID
511ISC
032601226Visit Indicator
5260XCNOY001001224Other Healthcare Provider


Patient Class

HL7 Table 0004 Patient Class
Value Description
EEmergency
IInpatient
OOutpatient
PPreadmit
RRecurring Patient
BObstetrics
DDay Hospital
WWeek Hospital
SPsychiatric
KNewborn


Assigned Patient Location

Value of the field PV1-3 Assigned Location may consist of one or four components as specified in the following tables.

Table IHE003 Assigned Patient Location
Value Description
CLClinic
NHNursing home
DPDepartment
NSNursing station
EDEmergency Department
<POINT_OF_CARE>^<ROOM>^<BED>^ <FACILITY>

POINT OF CARE is the general department or location and must be from the associated #Points of care table.
ROOM must be a valid room number from the #Rooms table .
BED is a numeric bed number from #Beds.

FACILITY is a facility code from the #Facilities table.


Points of care
Table IHE003 - Assigned Patient Location (Points of Care)
Value Description Information for French participants
1ENursing Station 1-EastHospitalisation
1WNursing Station 1-WestConsultation
2ENursing Station 2-EastConsultation
2WNursing Station 2-WestHospitalisation
0NEmergencyUrgence


Rooms
Table IHE003 - Assigned Patient Location (Rooms)
Value Description
101Room 101 (in 1-East)
102Room 102 (in 1-East)
103Room 103 (in 1-East)
104Room 104 (in 1-East)
105Room 105 (in 1-East)
106Room 106 (in 1-East)
107Room 107 (in 1-East)
108Room 108 (in 1-East)
109Room 109 (in 1-East)
110Room 110 (in 1-East)
111Room 111 (in 2-West)
112Room 112 (in 2-West)
113Room 113 (in 2-West)
114Room 114 (in 2-West)
115Room 115 (in 2-West)
116Room 116 (in 2-West)
117Room 117 (in 2-West)
118Room 118 (in 2-West)
119Room 119 (in 2-West)
120Room 120 (in 2-West)
201Room 201 (in 1-East)
202Room 202 (in 1-East)
203Room 203 (in 1-East)
204Room 204 (in 1-East)
205Room 205 (in 1-East)
206Room 206 (in 1-East)
207Room 207 (in 1-East)
208Room 208 (in 1-East)
209Room 209 (in 1-East)
210Room 210 (in 1-East)
211Room 211 (in 2-West)
212Room 212 (in 2-West)
213Room 213 (in 2-West)
214Room 214 (in 2-West)
215Room 215 (in 2-West)
216Room 216 (in 2-West)
217Room 217 (in 2-West)
218Room 218 (in 2-West)
219Room 219 (in 2-West)
220Room 220 (in 2-West)
301Room 301 (in 1-East)
302Room 302 (in 1-East)
303Room 303 (in 1-East)
304Room 304 (in 1-East)
305Room 305 (in 1-East)
306Room 306 (in 1-East)
307Room 307 (in 1-East)
308Room 308 (in 1-East)
309Room 309 (in 1-East)
310Room 310 (in 1-East)
311Room 311 (in 1-West)
312Room 312 (in 1-West)
313Room 313 (in 1-West)
314Room 314 (in 1-West)
315Room 315 (in 1-West)
316Room 316 (in 1-West)
317Room 317 (in 1-West)
318Room 318 (in 1-West)
319Room 319 (in 1-West)
320Room 320 (in 1-West)
401Room 401 (in 2-East)
402Room 402 (in 2-East)
403Room 403 (in 2-East)
404Room 404 (in 2-East)
405Room 405 (in 2-East)
406Room 406 (in 2-East)
407Room 407 (in 2-East)
408Room 408 (in 2-East)
409Room 409(in 2-East)
410Room 410 (in 2-East)
411Room 411 (in 1-West)
412Room 412 (in 1-West)
413Room 413 (in 1-West)
414Room 414 (in 1-West)
415Room 415 (in 1-West)
416Room 416 (in 1-West)
417Room 417 (in 1-West)
418Room 418 (in 1-West)
419Room 419 (in 1-West)
420Room 420 (in 1-West)



Beds

Note for French participants, there is a need for a mapping between the Beds and the Functional Units.

  • Beds in rooms 101 to 105 may belong to functional units 5000 to 6999
  • Beds in rooms 110 to 115 may belong to functional units 7000 to 7999
  • Beds in rooms 201 to 205 may belong to functional units 8000 to 8999 except 8210 (emergency)
  • Beds in rooms 211 to 215 may belong to functional units 9000 to 9999


All rooms have 3 beds.


Table IHE003 - Assigned Patient Location (Beds)
Value Description
1Window
2Aisle
3Middle


Facilities
Table IHE003 - Assigned Patient Location (Facilities)
Value Description
XYZ_HOSPITALMESA Tests
NORTH_HOSPITALConnectathon tests only
SOUTH_HOSPITALConnectathon tests only
EAST_HOSPITALConnectathon tests only
WEST_HOSPITALConnectathon tests only
FRENCH_HOSPITALConnectathon tests only
GERMAN_HOSPITALConnectathon tests only
ITALIAN_HOSPITALConnectathon tests only
BRITISH_HOSPITALConnectathon tests only


Doctor

Values of fields in PV1, ORC and OBR segments conveying names and identifiers of physicians and other providers shall be drawn from the User Table 0010.

Table 0010 - Physician ID
Value
1234^WEAVER^TIMOTHY^P^^DR
3456^ROSZEK^JEANETTE^G^^DR
5678^BAXA^TIMOTHY^P^^DR
7890^CHAVEZ^JULIO^^^DR
9012^JIANG^WEI^^^DR
 
5101^NELL^FREDERICK^P^^DR
5202^SCHULTZ^KEVIN^G^^DR
5303^BAJWA^AMNA^^^DR
5404^CAIN^LAUAREN^^^DR
5505^BYRNE^NEIL^^^DR
 
6101^DANKE^LOREN^P^^DR
6202^YIU^CHENG^^^DR
6303^LOPEZ^GABRIELLA^^^DR
6404^WYNN^DONALD^^^DR
6505^BANDA^REUBEN^J^^DR
 
7101^ESTRADA^JAIME^P^^DR
7202^ESSELMAN^HENRY^G^^DR
7303^DARROW^BARBARA^P^^DR
7404^PRUST^RALPH^^^DR
7505^RA^KYU^^^DR
 
8202^GLASER^GREGORY^P^^DR
8303^MADDOX^THERESA^G^^DR
15101^Fouéré^Yannick^P^^DR
25101^Klötzler^Carmen^P^^DR
2345^Taetinger^Robert^P^^DR
21234^Schulze^Jürgen^P^^DR
21235^Davies^Siân^L^^Dr


Hospital Service

HL7 Table 0069 Hospital Service
Value Description French German Italian
A01UnspecifiedNon SpécifiéUnbekanntSconosciuto 
A02SurgeryChirurgieChirurgieChirurgia 
A03CardiologyCardiologieKardiologieCardiologia 
A04EmergencyUrgencesNotabnahmePronto soccorso 
A05NeurologyNeurologieNeurologieNeurologia 


Ambulatory Status

HL7 Table 0009 Ambulatory Status
Value Description French German Italian
A0No functional limitations   
A1Ambulates with assistive device   
A2Wheelchair/stretcher bound   
A3Comatose; non-responsive   
A4Disoriented   
A5Vision impaired   
A6Hearing impaired   
A7Speech impaired   
A8Non-English speaking   
A9Functional level unknown   
B1Oxygen therapy   
B2Special equipment (tubes, IVs, catheters)   
B3Amputee   
B4Mastectomy   
B5Paraplegic   
B6Pregnant   



Diet Type

 
HL7 Table 0114 Diet
Value Description
 


Servicing Facility

HL7 Table 0115 Servicing Facility
Value Description
101Schedule Workflow Group France
102Schedule Workflow Group Germany
103Schedule Workflow Group Italy
104Schedule Workflow Group United Kingdom
105Schedule Workflow Group Others


AL1

AL1 Segment
SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
14SIR

00203SetID - AL1
22ISx
012700204Allergy Type
360CER2
IHE004 00205 #Allergy Code/Mnemonic/Description
42ISx
012800206Allergy Severity
515STR2

00207Allergy Reaction
68DTR2

00208Identification Date


Allergy Code/Mnemonic/Description

Table IHE004 Allergy Code/Mnemonic/Description
Value Description
IHEALG0001Codeine
IHEALG0002Iodine
IHEALG0003Penicillin
IHEALG0004Aspirin


ZFU

IHE-France private segment

A major difference between the management of responsibilities between the USA and France is that the responsibility for a patient is often managed at the the level of a functional unit rather than at the level of an attending doctor. For this purpose the Z Segment ZFU has been created.


For IHE-F, It shall be used for messages A01, A02, A04, A05, A06, A07 (possibly for A08).


</TR
ZFU segment
SEQLENDT OPTTBL#ITEM#ELEMENT NAME
160 XONC IHE-F001  Nursing #Functional Unit
260TSC  Nursing Functional Unit Start date/time
360XONC IHE-F001  Housing #Functional Unit
460TSC  Housing Functional Unit Start date/time
560XONC IHE-F001  Medical #Functional Unit
660TSC  Medical Functional Unit Start date/time



Functional Unit

Conditions: At least one of these three Functional Units is required (name and date/time that the patient has entered the functional unit). Two or three of them can have the same value.


Table IHE-F001 List of Functional Units
Value Description
5450 CHIRURGIE VISCERALE
5452 CHIRURGIE UROLOGIQUE
5510 O.R.L.
5520 OPHTALMOLOGIE
5780 PEDIATRIE
6100 MEDECINE DIGESTIVE
6400 CARDIOLOGIE
7140 CONSULTATIONS NEPHROLOGIE
7141 CONSULTATIONS CARDIOLOGIE
7150 CONSULTATIONS LABO
7160 CONSULTATIONS IMAGERIE
7161 CONSULTATIONS SCANNOGRAPHIE
7162 CONSULTATIONS ECHOGRAPHIE
7170 CONSULTATIONS ALGOLOGIE
7180 CONSULTATIONS URGENCES
7190 CONSULTATIONS KINESITHERAPIE
8001 RADIOLOGIE
8210 URGENCES
8300 MOYENS COMMUNS BLOCS
8310 BLOC GYNECOLOGIE-OBSTETRIQUE
8320 BLOC CHIRURGIE VISCERALE
8321 BLOC CHIRURGIE PEDIATRIQUE
8322 BLOC CHIRURGIE VASCULAIRE
8330 BLOC CHIRURGIE ORTHOPEDIQUE
8340 BLOC UROLOGIE
8350 BLOC CHIRURGIE POLYVALENTE
8360 BLOC O.R.L.
8370 BLOC OPHTALMOLOGIE
8380 BLOC STOMATOLOGIE
9620 MALADIES INFECTIEUSES
9630 MOYEN SEJOUR POLYVALENT
9640 SOINS PALLIATIFS
9800 LONG SEJOUR SOINS
9810 LONG SEJOUR HEBERGEMENT
9820 DIALYSE (Recurent)


RAD-1: Patient Registration

Message Segments: Patient Registration

Patient Registration transaction may be conveyed by the in-patient & out-patient registration and in-patient pre-admission messages, plus admission and pre-admission cancel messages. Required message segments are documented in the following table: RAD TF-2: 4.1.4.1.2 for A01/A04/A05 messages, and RAD TF-2:4.1.4.2.2 for A11/A38 messages.

RAD-1: Required Message Segments
Message Type Technical Framework Reference
A01/A04/A05RAD TF-2:4.1.4.1.2
A11/A38RAD TF-2:4.1.4.2.2

Note: for the French implementation, the ZFU segment is required in the case of an ADT message of type A01/A04/A05.


MSH Segment

See previous #MSH section for the MSH-related tables.

Value of the field MSH-9 shall be defined as described below.

Field MSH-9 Message Type

First component value is taken from HL7 Table 0076 Message Type.
Second component value is taken from HL7 Table 0003 Event Type.
 

HL7 Table 0076 Message Type
Value Description
ACKGeneral acknowledgment message
ADTADT message


HL7 Table 0003 Event Type (Patient Class Update and Patient Transfer
Value Description
A01Admit a patient
A04Register a patient
A05Pre-admit a patient
A11Cancel registration
A38Cancel pre-admit


EVN Segment
No defined codes for elements in the EVN segment.

PID Segment
See the #PID-related tables.

PV1 Segment
See the #PV1-related tables.

AL1 Segment
See the #AL1-related tables.


RAD-2 and RAD-3: Placer and Filler Order Management

Message Segments: Order Management Messsage

Segments of the messages are listed in tables below:


RAD-12: Required Message Segments
Message Type Technical Framework Reference
RAD-2 New Order from Order PlacerRAD TF-2:4.2.4.1.2
RAD-2 Order Cancelled by Order PlacerRAD TF-2:4.2.4.2.2
RAD-3 New Order from Order Filler RAD TF-2:4.3.4.1.2
RAD-3 Order Status UpdateRAD TF-2:4.3.4.2.2
RAD-3 Order Cancelled by Order FillerRAD TF-2:4.3.4.3.2



MSH Segment

See previous #MSH Section for the MSH-related tables. Value of the field MSH-9 shall be defined as described below.

Field MSH-9 Message Type

Field MSH-9 Message Type contains two components. First component value is taken from the HL7 Table 0076 Message Type. Second component value is taken from HL7 Table 0003 Event Type.


HL7 Table 0076 Message Type
Value Description
ACKGeneral acknowledgment message
ORMGeneral order message
ORRGeneral order response message (Order Response message only)


HL7 Table 0003 Event Type
Value Description
O01 New Order, Order Status Update, Order Cancel messages and ACK to them
O02 Order response message and ACK to it only


MSA Segment
No defined codes for elements in the MSA segment.

PID Segment
See the #PID-related tables.

PV1 Segment
See the #PV1-related tables.

ORC

ORC Segment
SEQLENDTOPTTBL#ITEM#ELEMENT NAME
1 2 ID R011900215#Order Control
2 22 EI C 00216Placer Order Number
3 22 EIR2 00217Filler Order Number
4 22 EI C 00218Placer Group Number
5 2 ID C003800219#Order Status
6 1 ID X012100220Response Flag
7200 TQ C 00221#Quantity/Timing
8200 CM C 00222Parent
9 26 TS R 00223Date/Time of Transaction
10120XCNR2 00224Entered By
11120XCN X 00225Verified By
12120XCN R001000226Ordering Provider (#Doctor)
13 80 PL X 00227Enterer's Location
14 40XTNR2 00228Call Back Phone Number
15 26 TS R 00229Order Effective Date/Time
16200 CE X 00230Order Control Code Reason
17 60 CE RIHE00500231#Entering Organization
18 60 CE X 00232Entering Device
19120XCN X 00233Action By


Order Control

HL7 Table 0119 Order Control (New Order Message)

Value Description Originator
NWRNew orderP
PAOParent orderF
CHOChild orderF,P
SNRSend order numberF
R - Required
O - Optional

NOTE: The use of Required/Optional subscripts in the Value column is an IHE extension and is not part of the HL7 Standard.

HL7 Table 0119 Order Control (Order Response Message)

Value Description Originator
NANumber assignedP


HL7 Table 0119 Order Control (Order Status Update Message)

Order status is sent by an Order Filler but not by an Order Placer.

Value Description Originator
SCStatus ChangedP


HL7 Table 0119 - Order Control Code (Order Cancel Message)
Value Description Originator
CACancel order requestP
DCDiscontinue order requestP
OCOrder CancelledF


Order Status

HL7 Table 0038 Order States

Order status is sent by an Order Filler but not by an Order Placer.

Value Description
CMOrder is completed
DCOrder was discontinued
IPIn process, unspecified


Quantity/Timing


Component 6 of the Quantity/Timing Field will contain the value mapped to Requested Procedure Priority in Modality Worklist. The supported values for Component 6 follow:


Value Description
SSTAT
AASAP
RROUTINE
PPRE-OP
CCALLBACK
TTIMING


Entering Organization
IHE005 Entering Organization
Identifier Value Coding System
922229-10IHE-RAD IHE-CODE-231


OBR

OBR Segment
SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
14SIC

00237Set ID - OBR
275 EIC

00216Placer Order Number
375 EIC

00217Filler Order Number +
4200CER
IHE00600238#Universal Service ID
52IDX

00239Priority
626TS X

00240Requested Date/time
726TSX

00241Observation Date/Time #
826TS X

00242Observation End Date/Time #
920CQ X

00243Collection Volume *
1060XCNXY
00244Collector Identifier *
111IDX
006500245Specimen Action Code *
1260CER2
IHE00700246#Danger Code
13300STR2

00247Relevant Clinical Info.
1426TSX

00248Specimen Received Date/Time *
15300CMC
007000249Specimen Source *
1680XCNRY
00226Ordering Provider
1740XTNXY/2
00250Order Callback Phone Number
1860STX

00251Placer field 1
1960STX

00252Placer field 2
2060STX

00253Filler Field 1 +
2160STX

00254Filler Field 2 +
2226TSX

00255Results Rpt/Status Chng - Date/Time +
2340CMX

00256Charge to Practice +
2410IDX
007400257Diagnostic Serv Sect ID
251IDX
012300258Result Status +
26400CMX

00259Parent Result +
27200TQRY
00221#Quantity Timing
28150XCNXY/5
00260Result Copies To
29150CMC

00261Parent *
3020IDR2
012400262#Transportation Mode
31300CER2Y
00263Reason for Study
32200 CMX

00264Principal Result Interpreter +
33200 CMXY
00265Assistant Result Interpreter +
34200 CMXY
00266Technician +
35200 CMXY
00267Transcriptionist +
3626TSX

00268Scheduled Date/Time +
374NMX

01028Number of Sample Containers *
3860CEXY
01029Transport Logistics of Collected Sample *
39200CEXY
01030Collector\'s Comment *
4060CER2

01031Transport Arrangement Responsibility
4130IDX
022401032#Transport Arranged
421IDX
022501033Escort Required
43200CEXY
01034Planned Patient Transport Comment




Notes on Ordering, Procedure and Scheduling Codes

There are different codes used in the sequence of placing orders, and scheduling and performing procedure steps.

The "Ordering Code" is the coded value used by either the Order Placer or Order Filler when placing the original order. This coded value (3 value triplet) goes in the first 3 components of OBR-4 #Universal Service ID in the original order (transaction RAD-2 or transaction RAD-3).

The "Requested Procedure Code" is owned by the Order Filler and is mapped from the "Ordering Code" (#Universal Service ID). In a clinical installation, the Requested Procedure Code could be different from the Ordering Code and might be taken from a different vocabulary or coding system. To make things easier for MESA tests and demonstrations, we use the same values for "Requested Procedure Code" and "Ordering Code". The "Requested Procedure Code" goes in the first 3 components of OBR-4 #Universal Service ID in the scheduling message sent to the Image Manager (RAD-4) and is also found in Modality Worklist entries.

Protocol Code Items are the codes used to give Acquisition Modality detailed instructions. Each Scheduled Procedure Step will have one or more Protocol Code Items. In the simplest case, one SPS will contain one Protocol Code Item. In some MESA tests, we use two Protocol Code Items in one SPS. Protocol Code Items are placed in components 4-6 of the #Universal Service ID in the scheduling message sent to the Image Manager (RAD-4) and are also found in Modality Worklist entries.

The Protocol Code Items referred to above are for Scheduled Procedure Steps (SPS). Protocol Code Items can also be included in Modality Performed Procedure Step (MPPS) messages. For MESA testing and IHE demonstrations, we use the same code values for Protocol Code Items in Performed Procedure Steps and Scheduled Procedure Steps. The tables in this section will list the coded values used for MESA tests and define any maps between the coding systems.

Universal Service ID

Value of the field OBR-4 Universal Service ID shall contain three components where first and second components are drawn from Identifier and Text columns of Table IHE006 Universal Service ID. Third component shall contain a value from #Coding Scheme Designators.

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Table IHE006 - Universal Service ID
Clinical Scenario # Identifier Text Coding Scheme
MESA Tests P1Procedure 199IHE
MESA Tests P2Procedure 299IHE
MESA Tests P3Procedure 399IHE
MESA Tests P4Procedure 499IHE
MESA Tests P5Procedure 599IHE
MESA Tests P6Procedure 699IHE
MESA Tests P7Procedure 799IHE
MESA Tests P8Procedure 899IHE
MESA Tests P9Procedure 999IHE
MESA Tests P10Procedure 1099IHE
MESA Tests P20Procedure 2099IHE
MESA Tests P21Procedure 2199IHE
MESA Tests P22Procedure 2299IHE
MESA Tests P23Procedure 2399IHE
MESA Tests P101Mammography Screening99IHE
MESA Tests CATH.001CATH Consultation99IHE
MESA Tests ECHO.001TTE99IHE
MESA Tests ECHO.002STRESS ECHO99IHE
Demonstration 10110 US Procedure 1 99IHE
Demonstration 10150 US Procedure 2 99IHE
Demonstration 10210 Radiological Examination: Chest X-Ray99IHE
Demonstration 10250 Radiological Examination: Abdominal X-Ray99IHE
Demonstration 10310 Ultrasound Examination: Cardiac Screening99IHE
Demonstration 10350 Ultrasound Examination: Stress Echo99IHE
Demonstration 10410 Radiological Examination: Left Leg99IHE
Demonstration 10450 Radiological Examination: Left Ankle99IHE
Demonstration 10510 Unassigned99IHE
Demonstration 10550 Unassigned99IHE
Demonstration 10610 Radiological Examination: Left Hand99IHE
Demonstration 10650 Radiological Examination: Left Wrist99IHE
Demonstration 10710 Transabdominal Ultrasound Scan99IHE
Demonstration 10750 Endovaginal Pelvic Scan99IHE
Demonstration 10810 Radiological Examination: Right Leg99IHE
Demonstration 10850 Radiological Examination: Right Ankle99IHE
Demonstration 10910 Computed Tomography: Chest99IHE
Demonstration 10950 Computed Tomography: Abdomen99IHE
Demonstration 11010 Magnetic Resonance Imaging: Head99IHE
Demonstration 11050 Magnetic Resonance Imaging: Neck99IHE
Demonstration 11110 Unassigned99IHE
Demonstration 11150 Unassigned99IHE
Demonstration 11210 Angiography: Cardiac99IHE
Demonstration 11250 Angiography: Carotid99IHE
Demonstration 11310 Unassigned99IHE
Demonstration 11350 Unassigned99IHE
Demonstration 11410 XRay: Ankle99IHE
Demonstration 11450 XRay: Foot99IHE
Demonstration 11510 Radiological Examination: Mammography99IHE
Demonstration 11550 Unassigned99IHE
Demonstration 11610 Radiological Examination: Skull99IHE
Demonstration 11650 Radiological Examination: C- Spine99IHE
Demonstration 11710Unassigned99IHE
Demonstration 11750Unassigned99IHE
Demonstration 11810OB-GYN Ultrasound99IHE
Demonstration 11850Unassigned99IHE
Demonstration 11910Venogram99IHE
Demonstration 11950Upper GI99IHE
Demonstration 12010Magnetic Resonance Imaging: Left Knee99IHE
Demonstration 12050Magnetic Resonance Imaging: Back99IHE
Demonstration 12110Radiological Examination: Hand R99IHE
Demonstration 12150Radiological Examination: Wrist R99IHE
Demonstration 12210Unassigned99IHE
Demonstration 12250Unassigned99IHE
Demonstration 12310Unassigned99IHE
Demonstration 12350Unassigned99IHE
Demonstration 12410Unassigned99IHE
Demonstration 12450Unassigned99IHE
Demonstration 12510Magnetic Resonance Imaging: Brain99IHE
Demonstration 12550Unassigned99IHE
Demonstration 13110Pulmonary ventilation/perfusion study99IHE
Demonstration 13115CD/DVD Import99IHE
Demonstration 13120Scanned Film Import99IHE
Demonstration 13130Scanned Document Import99IHE
Demonstration 13140Network Import99IHE
Demonstration 13150NM: Procedure 1399IHE
Demonstration 16110DEXA Exam: AP Spine99IHE
Demonstration 16150DEXA Exam: Left Femur99IHE
Demonstration 16151DEXA Exam: Right Femur99IHE
Demonstration 16210Magnetic Resonance Imaging: Ankle99IHE
Demonstration 16310Dynamic - Renalgram99IHE
Demonstration 16350Gated Spect - Cardiac Gated Spect99IHE
Demonstration 16370Spect - Bone Spect99IHE
Demonstration 16410Radiological Examination: Ankle99IHE
Demonstration 17110RF Examination: Stomach99IHE
Demonstration 17130RF Examination: Colon99IHE
Demonstration 18110Angiography: Diagnostic Catheterization99IHE
Demonstration 18111Angiography: Therapeutic Catheterization99IHE
Demonstration 19110Electrophysiology: Diagnostic ECG99IHE
Demonstration 20110Group Test99IHE
Laboratory Test85027Hemogram and platelet count, automatedCPT4
Laboratory Test85027Hemogram and platelet count, automatedCPT4


Danger Code
Table IHE007 - Danger Code
Identifier Text Coding Scheme
HIHIV positive 99IHE
TBActive tuberculosis 99IHE


Quantity Timing

Value of the field OBR-27 shall be equal to the value of the field ORC-7 #Quantity/Timing.


Transportation Mode
HL7 Table 0124 Transportation Mode
Value Description
CARTCart - patient travels on cart or gurney
PORTThe examining device goes to patient's location
WALKPatient walks to diagnostic service
WHLCWheelchair


Transportation Arranged
HL7 Table 0224 - Transport Arranged
Value Description
AArranged
NNot Arranged
UUnknown


OBX

OBX Segment
SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
110SIO  00569Set ID - OBX
22IDC 012500570#Value Type
3590CER  00571#Observation Identifier
420STC  00572Observation Sub-ID
5655361*CY2 00573Observation Value
660CEO  00574#Units
710STO  00575References Range
85IDOY/5007800576Abnormal Flags
95NMO  00577Probability
102IDOY008000578Nature of Abnormal Test
111IDR 008500579Observ Result Status
1226TSO  00580Date Last Obs Normal Values
1320STO  00581User Defined Access Checks
1426TSO  00582Date/Time of the Observation
1560CEO  00583Producer's ID
1680XCNO  00584Responsible Observer
1760CEOY 00936Observation Method


Value Type


OBX-2 is used to determine type of values sent for Patient Size and Patient Weight. The value of this field must be one of the values from the following table:

00571 Value Type
Value
NM


Observation Identifier


The second component of OBX-2 this element is used to differentiate between values sent for Patient Size and Patient Weight. The value in the second component must be one of the values from the following table:

00571 Observation Identifier
Value
BODY WEIGHT
BODY HEIGHT


Units


The value of OBX-2 is used to indicate the unit of measurement for Patient Size and Patient Weight. The value in the second component must be one of the values from the following table:

00574 Supported Units
Value
kg^^ISO+
m^^ISO+


RAD-4: Procedure Scheduled

Message Segments: Procedure Scheduled

The required message segments are documented in RAD TF-2:4.4.4.1.2.

MSH Segment

See previous #MSH Section for the MSH-related tables. Value of the field MSH-9 shall be defined as described below.

Field MSH-9 Message Type

First component value is taken from HL7 Table 0076 Message Type.
Second component value is taken from HL7 Table 0003 Event Type.
 

HL7 Table 0076 Message Type
Value Description
ORMGeneral order message



HL7 Table 0003 Event Type
Value Description
O01 New Order


PID Segment
See the #PID-related tables.
PV-1 Segment
See the #PV-1-related tables.
ORC Segment
See the #ORC-related tables. Note that the value of ORC-1 (Order Control) is limited to the value NW only .

HL7 Table 0119 - Order Control
Value Description
NWNew order


OBR Segment
See the #OBR-related tables.

RAD-5: MWL Map for Requested Procedures and Scheduling Codes

<p> This section contains maps showing the relationship between requested procedures, scheduled procedure steps and protocol items. That is, for a given requested procedure, Order Fillers

will/shall schedule the protocol items found in the Modality Worklist Map table below.

The coded values (Protocol Code, Protocol Code Meaning, #Coding Scheme Designator) are also the values transmitted in components 4-6 of OBR-4: #Universal Service ID that is sent to the Image Manager for transaction RAD-4: Procedure Scheduled.

In the Mod column, an asterisk (*) means the value will depend on the test. For a modality running MESA tests, that value will be set by the user running the test (CR, CT, MR, US, …). For Order Filler tests, the value will be dictated by the test instructions. For Connectathon tests, the Mod column will contain fixed values that should be used by the Order Filler. The column labeled Modality AE Titles will contain AE Titles of modalities tested at the Connectathon. This will help Order Filler actors schedule steps for the proper systems.


Modality Worklist Map: Requested Procedures to Action Item Codes
Clinical Scenario #Req. ProcedureSPS DescriptionProtocol CodeModProtocol Code MeaningCoding Scheme Designator
MESA Tests P1 P1 10 X1_A1  SP Action Item X1_A199IHE
MESA Tests P2 P2 20 X2_A1  SP Action Item X2_A199IHE
MESA Tests P3 P3 30 X3A_A1 SP Action Item X3A_A199IHE
P3 31 X3B_A1 SP Action Item X3B_A199IHE
MESA Tests P4 P4 40 X4A_A1 SP Action Item X4A_A199IHE
P4 41 X4B_A1 SP Action Item X4B_A1 99IHE
X4B_A2  SP Action Item X4B_A2 99IHE
MESA Tests P5 P5 50 X5_A1  SP Action Item X5_A1 99IHE
MESA Tests P6 P6 60 X6_A1  SP Action Item X6_A1 99IHE
MESA Tests P7 P7 70 X7_A1  SP Action Item X7_A199IHE
MESA Tests P8 P8 80 X8A_A1 SP Action Item X8A_A1 99IHE
P8 81 X8B_A1 SP Action Item X8B_A199IHE
MESA Tests P9 P9 90 X9_A1  SP Action Item X9_A1 99IHE
MESA Tests P10 P10 100 X10_A1 SP Action Item X10_A199IHE
MESA Tests P20 P20 200 X20_A1 SP Action Item X20A_A199IHE
MESA Tests P21 P21 210 X21_A1 SP Action Item X21_A1 99IHE
MESA Tests P22 P22 220 X22_A1 SP Action Item X22_A1 99IHE
MESA Tests P23 P23 230 X23_A1 SP Action Item X23_A1 99IHE
MESA Tests P101 P101 Mammography Screening X101_A1 SP Action Item X101_A1 99IHE
MESA Tests P102 P102 3D CT Reconstruction X102_A1 SP Action Item X102_A1 99IHE
MESA Tests CATH.001 Left Heart Cath XX-200011 Left Heart Cath 99IHE
IVUS Left Heart Cath XX-200012 IVUS Left Heart Cath 99IHE
XA Left Heart Cath XX-200013 XA Left Heart Cath 99IHE
Connectathon 10110 US Procedure 1910110 US US: One 99IHE
Connectathon 10150 US Procedure 2910150 US US: Two 99IHE
Connectathon 10210 Radiological Examination Chest X-Ray910210 CR CR: CXR 99IHE
Connectathon 10250 Radiological Examination Abdominal X-Ray 910250 CR CR: Abdomen 99IHE
Connectathon 10310 Ultrasound Examination Cardiac Screening910310 US US: Screening 99IHE
Connectathon 10350 Ultrasound Examination Stress Echo910350 US US: Stress Echo 99IHE
Connectathon STRESS-7131CStress Test: BalkeP2-7131C ECG Balke Protocol 99IHE
Connectathon STRESS-7131CStress Test: BalkeSTR-NM1 NM Stress-NM199IHE
Connectathon STRESS-7131CStress Test: BalkeSTR-US1 US Stress-US199IHE
Connectathon STRESS-7131EStress Test: RampP2-7131E ECG Ramp Protocol 99IHE
Connectathon STRESS-7131EStress Test: RampSTR-NM2 NM Stress-NM299IHE
Connectathon STRESS-7131EStress Test: RampSTR-US2 NM Stress-US299IHE
Connectathon STR-DOBUTAMINEStress Test: DobutamineDOBUTAMINE NM Dobutamine Stress Protocol99IHE
Connectathon 10410 Radiological Examination Left Leg910410 DX DX: Left Leg 99IHE
Connectathon 10450 Radiological Examination Left Ankle914050 DX DX: Left Ankle 99IHE
Connectathon 10510   unassigned   99IHE
Connectathon 10550   unassigned   99IHE
Connectathon 10610 Radiological Examination Hand 910610 CR CR: Hand 99IHE
Connectathon 10650 Radiological Examination Wrist910650 CR CR: Wrist 99IHE
Connectathon 10710 Transabdominal Ultrasound Scan 910710 US US: Transabdominal99IHE
Connectathon 10750 Endovaginal Pelvis Ultrasound Scan 910750 US US: Endovaginal Pelvis 99IHE
Connectathon 10810 Radiological Examination Right Leg910810 CR CR: Right Leg 99IHE
Connectathon 10850 Radiological Examination Right Ankle910850 CR CR: Right Ankle 99IHE
Connectathon 10910 Computed Tomography Chest910910 CT CT: Chest 99IHE
Connectathon 10950 Computed Tomography Abdomen910950 CT CT: Abdomen 99IHE
Connectathon 10950 Computed Tomography Head910960 CT CT: Head 99IHE
Connectathon 11010 Magnetic Resonnance Imaging Head911010 MR MR: Head 99IHE
Connectathon 11050 Magnetic Resonnance Imaging Neck911050 MR MR: Neck 99IHE
Connectathon 11110   unassigned  99IHE
Connectathon 11150   unassigned  99IHE
Connectathon 11210 Angiography Cardiac911210 XA XA: Cardiac 99IHE
Connectathon 11250 Angiography Carotid911250 XA XA: Carotid 99IHE
Connectathon 11260CTA: Coronary CT Angiography911260 CT CT: CT Angiography99IHE
Connectathon 11270EP: Ablation911270 EP EP: Ablation Procedure99IHE
Connectathon 11310   unassigned  99IHE
Connectathon 11350   unassigned  99IHE
Connectathon 11410 Radiological Examination Ankle 911410 DX DX: Ankle 99IHE
Connectathon 11450 Radiological Examination Foot911450 DX DX: Foot 99IHE
Connectathon 11510 Radiological Examination Mammography 911510 MG MG: Mammography99IHE
Connectathon 11550   unassigned  99IHE
Connectathon 11610 Radiological Examination Skull911610 CR CR: Skull 99IHE
Connectathon 11650 Radiological Examination C-Spine911650 CR CR: C-Spine 99IHE
Connectathon 11710   unassigned  99IHE
Connectathon 11750   unassigned  99IHE
Connectathon 11810 OB-GYN Ultrasound911810 US US: OB-GYN 99IHE
Connectathon 11850   unassigned  99IHE
Connectathon 11910Venogram911910 RF XRF: Venogram99IHE
Connectathon 11950Upper GI911950 RF XRF: Upper GI99IHE
Connectathon 12010 Magnetic Resonnance Imaging Left Knee912010 MR MR: Left Knee99IHE
Connectathon 12050 Magnetic Resonnance Imaging Back 912050 MR MR: Back 99IHE
Connectathon 12110 Radiological Examination Right Hand912110 DX DX: Hand R 99IHE
Connectathon 12150 Radiological Examination Right Wrist912150 DX DX: Wrist R 99IHE
Connectathon 12210   unassigned  99IHE
Connectathon 12250   unassigned  99IHE
Connectathon 12310   unassigned  99IHE
Connectathon 12350   unassigned  99IHE
Connectathon 12410   unassigned  99IHE
Connectathon 12450   unassigned  99IHE
Connectathon 12510 Magnetic Resonnance Imaging Brain912510 MR MR: Brain 99IHE
Connectathon 12550   unassigned  99IHE
Connectathon 13110 CD/DVD Import13110 OT CD/DVD Import99IHE
Connectathon 13120 Scanned Film Import13120 OT Scanned Film Import99IHE
Connectathon 13130 Scanned Document Import13130 OT Scanned Document Import99IHE
Connectathon 13140 Network Import13140 OT Network Import99IHE
Connectathon 16110 DXA Exam: AP Spine916110 OT OT: AP Spine99IHE
Connectathon 16150 DXA Exam: Left Femur916150 OT OT: Left Femur99IHE
Connectathon 16151 DXA Exam: Right Femur916151 OT OT: Right Femur99IHE
Connectathon 16210 Magnetic Resonance Imaging: Ankle916210 MR MR: Ankle99IHE
Connectathon 16310 Dynamic Renalgram916310 NM NM: Renalgram 99IHE
Connectathon 16350 Cardiac Gated Spect916350 NM NM: Cardiac Gated Spect99IHE
Connectathon 16370 Spect - Bone Spect916370 NM NM: Bone Spect99IHE
Connectathon 16410 Radiological Examination: Ankle916410 CR CR: Ankle99IHE
Connectathon 17110 RF Examination Stomach917110RF RF: Stomach99IHE
Connectathon 17130 RF Examination Colon917130RF RF: Colon99IHE
Connectathon 18110 Angiography Diagnostic CatherizationXX-40041XA Diagnostic Catherization99IHE
Connectathon 18111 Angiography Therapeutic CatherizationXX-40061XA Therapeutic Catherization99IHE
Connectathon 19110 Electrophysiology Diagnostic ECGXX-40081XA Diag ECG99IHE
Connectathon 20110 Group TestP1_A1OT SP Action Item P1_A199IHE
Connectathon 20110 Group TestP2_A1OT SP Action Item P2_A199IHE


RAD-12: Patient Update

Message Segments: Patient Update

Patient Update transaction may be conveyed by the Patient Class Update, Patient Transfer, Patient Information Update and Patient Merge messages. The required message segments are documented in the following table:


RAD-12: Required Message Segments
Message Type Technical Framework Reference
A02RAD TF-2:4.12.4.1.2
A03/A06/A07RAD TF-2:4.12.4.2.2
A08RAD TF-2:4.12.4.3.2
A40RAD TF-2:4.12.4.4.2
A12/A13RAD TF-2:4.12.4.5.2


Note: for the French implementation, the ZFU segment is required in the case of an ADT message of type A02.


MSH Segment

See previous #MSH section for the MSH-related tables.

Value of the field MSH-9 shall be defined as described below.

Field MSH-9 Message Type

First component value is taken from HL7 Table 0076 Message Type.
Second component value is taken from HL7 Table 0003 Event Type.
 

HL7 Table 0076 Message Type
Value Description
ACKGeneral acknowledgment message
ADTADT message


HL7 Table 0003 Event Type (Patient Class Update and Patient Transfer
Value Description
A02Transfer Patient
A03 Patient Discharge
A06Outpatient to Inpatient
A07 Inpatient to Outpatient


HL7 Table 0003 Event Type (Patient Information Update Message Segments)
Value Description
A08 Patient Information Update


HL7 Table 0003 Event Type (Patient Merge Message Segments)
Value Description
A40 Patient Merge


EVN Segment
No defined codes for elements in the EVN segment.

PID Segment
See the #PID-related tables.

PV1 Segment
See the #PV1-related tables.

AL1 Segment
See the #AL1-related tables.

MRG Segment
No defined codes for elements in the MRG segment.

RAD-13: Procedure Update

This message has the same structure as the #RAD-4 Procedure Scheduled message. Note that the ORC-1 field values shall be drawn from RAD TF-2:4.13.4.2.