Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If a value is the usual default for use in Australia it has been highlighted in blue.

Anchor
figure2-1
figure2-1
2.2.3.42 PV2-42 Patient condition code (CE) 01547

Figure 2-1. HL7 message segments 

Segment Name

HL7 Section Reference

BHS2.1.2
BTS2.1.3
DSC 2.1.4 
ERR2.1.5
FHS 2.1.6 
FTS 2.1.7 
MSA 2.1.8
MSH2.1.9

Anchor
bhs
bhs
Anchor
BHS
BHS

2.1.2 BHS - batch header segment

...

HL7 Attribute Table - BHS – Batch Header

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
11ST R  00081Batch Field Separator
23STR  00082Batch Encoding Characters
315STO  00083Batch Sending Application
420STO  00084Batch Sending Facility
515STO  00085Batch Receiving Application
620STO  00086Batch Receiving Facility
726TSO  00087Batch Creation Date/Time
840STO  00088Batch Security
920STO  00089Batch Name/ID/Type
1080STO  00090Batch Comment
1120STO  00091Batch Control ID
12 20ST   00092 Reference Batch Control ID 

Anchor
BHS-fd
BHS-fd
2.1.2.0 BHS field definitions

...

HL7 Attribute Table - BTS – Batch Trailer

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
110STO  00093Batch Message Count
280STO  00090Batch Comment
3100NM OY 00095Batch Totals

Anchor
BTS-1
BTS-1
2.1.3.1 BTS-1 Batch message count (ST) 00093

...

HL7 Attribute Table - DSC – Continuation Pointer

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
180 ST   00014Continuation Pointer
1ID  039801354 Continuation Style 

Anchor
DSC-1
DSC-1
2.1.4.1 DSC-1 Continuation pointer (ST) 00014

...

HL7 Table 0398 - Continuation style code

ValueDescription
FFragmentation
IInteractive Continuation

Anchor
err
err
Anchor
ERR
ERR

2.1.5 ERR - error segment

...

HL7 Attribute Table - ERR –Error

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
180CMRY 00024Error Code and Location

Anchor
ERR-fd
ERR-fd
2.1.5.0 ERR field definition

...

HL7 Attribute Table - FHS - File Header   

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
11STR  00067File Field Separator
24STR  00068File Encoding Characters
315STO  00069File Sending Application
420STO  00070File Sending Facility
515STO  00071File Receiving Application
620STO  00072File Receiving Facility
726TSO  00073File Creation Date/Time
840STO  00074File Security
920STO  00075File Name/ID
1080STO  00076File Header Comment
1120STO  00077File Control ID
1220STO  00078Reference File Control ID

Anchor
FHS-fd
FHS-fd
2.1.6.0 FHS field definitions

...

HL7 Attribute Table - FTS - File Trailer

SEQ LENDTOPTRP/#TBL#ITEM #ELEMENT NAME
110NMO  00079File Batch Count
280STO  00080File Trailer Comment

Anchor
FTS-fd
FTS-fd
2.1.7.0 FTS field definitions

...

HL7 Attribute Table - MSA - Message Acknowledgment

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
12IDR 000800018Acknowledgment Code
220STR  00010Message Control ID
380STO  00020Text Message
415NMO  00021Expected Sequence Number
51IDB 010200022Delayed Acknowledgment Type
6250 CEO 035700023Error Condition

The sending system must return the Message Control ID from the received message in the MSA segment. 

...

HL7 Table 0008 - Acknowledgment code

ValueDescription 
AAOriginal mode: Application Accept - Enhanced mode: Application acknowledgment: Accept 
AE Original mode: Application Error - Enhanced mode: Application acknowledgment: Error 
AROriginal mode: Application Reject - Enhanced mode: Application acknowledgment: Reject 
CA Enhanced mode: Accept acknowledgment: Commit Accept 
CEEnhanced mode: Accept acknowledgment: Commit Error 
CR Enhanced mode: Accept acknowledgment: Commit Reject 

Anchor
MSA-2
MSA-2
2.1.8.2 MSA-2 Message control ID (ST) 00010

...

HL7 Table 0102 - Delayed acknowledgment type

ValueDescription
DMessage received, stored for later processing
Facknowledgment after processing

Anchor
MSA-6
MSA-6
2.1.8.6 MSA-6 Error condition (CE) 00023

...

HL7 Table 0357 - Message error condition codes

Error Condition CodeError Condition Text Description/Comment
Success  
0Message accepted

Success. Optional, as the AA conveys success. Used for systems that must always return a status code.

Errors  
100Segment sequence errorThe message segments were not in the proper order, or required segments are missing.
101Required field missingA required field is missing from a segment
102Data type errorThe field contained data of the wrong data type, e.g. an NM field contained "FOO".
103Table value not foundA field of data type ID or IS was compared against the corresponding table, and no match was found.
Rejection  
200Unsupported message typeThe Message Type is not supported.
201Unsupported event codeThe Event Code is not supported.
202Unsupported processing idThe Processing ID is not supported.
203Unsupported version idThe Version ID is not supported.
204Unknown key identifierThe ID of the patient, order, etc., was not found. Used for transactions other than additions, e.g. transfer of a non-existent patient.
205Duplicate key identifierThe ID of the patient, order, etc., already exists. Used in response to addition transactions (Admit, New Order, etc.).
206 Application record locked  The transaction could not be performed at the application storage level, e.g. database locked. 
207 Application internal error   A catchall for internal errors not explicitly covered by other codes.

Anchor
msh
msh
Anchor
MSH
MSH

2.1.9 MSH - message header segment

...

HL7 Attribute Table - MSH - Message Header

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
11STR  00001Field Separator
2STR  00002Encoding Characters
3180 HDO 0361 00003Sending Application
4180HDO 036200004Sending Facility
5180HDO 036100005Receiving Application
6180HDO 036200006Receiving Facility
726TSR  00007Date/Time Of Message
840STO  00008Security
915†CM 0076 / 000300009Message Type
1036††STR  00010Message Control ID
113PTR  00011Processing ID
12
60
250††††VIDR 010400012Version ID
1315NMO  00013Sequence Number
14180STO  00014Continuation Pointer
152ID
O
R††† 015500015Accept Acknowledgment Type
162ID
O
R††† 015500016Application Acknowledgment Type
173ID
O
R†† 039900017Country Code
1816IDOY021100692Character Set
19250CE
O
R††  00693Principal Language Of Message
2020ID  035601317 Alternate Character Set Handling Scheme 
2110ID O0449 01598 
 Conformance
Conformance Statement ID

† Australian variation to HL7 V2.4 with the length changed from 13 to 15 characters.

† Australian variation to HL7 V2.4 with the length changed from 20 to 36 characters to accommodate a globally unique identifier.

†††Australian variation to HL7 V2.4, field optionality has been changed to required.

††††Australian variation to HL7 V2.4 with the length changed from 60 to 250 characters.

Anchor
MSH-fd
MSH-fd
2.1.9.0 MSH field definitions

...

User-defined Table 0361 – Sending/receiving application

ValueDescription
MERIDIAN^MERIDIAN:3.1.4 (Build 6934) [win32-i386]^LExample application identifier
Best Practice 1.8.5.743Application identifier with only namespace ID valued
PRSLT^HL7PIT^LExample Lab Sending application

Note: By site agreement, implementors may continue to use User-defined Table 0300 – Namespace ID for the first component.

...

User-defined Table 0362 – Sending/receiving facility

ValueDescription
Buderim GE Centre^7C3E3681-91F6-11D2-8F2C-444553540000^GUIDExample sending facility identified with GUID
QML^2184^AUSNATALab example using AUSNATA as coding scheme

Note: By site agreement, implementers may continue to use User-defined Table 0300 – Namespace ID  for the first component.

...

HL7 Table 0103 - Processing ID

ValueDescription
DDebugging
PProduction
TTraining

Anchor
table0207
table0207

HL7 Table 0207 - Processing mode

ValueDescription
AArchive
RRestore from archive
IInitial load
TCurrent processing, transmitted at intervals (scheduled or on demand)
Not presentNot present (the default, meaning current processing) 

Anchor
msh-12
msh-12
Anchor
MSH-12
MSH-12

...

HL7 Table 0104—Version ID

ValueDescription 
2.0 Release 2.0 September 1988
2.0D Demo 2.0 October 1988
2.1 Release 2. 1 March 1990
2.2 Release 2.2 December 1994
2.3 Release 2.3 March 1997
2.3.1 Release 2.3.1 May 1999
2.4 Release 2.4 November 2000

To indicate compliance with this localisation the <internationalization code (CE)> must be "AUS^Australia^AUS&Australia&ISO3166_1" and .

To indicate compliance with Pathology Orders and Results profile the <internal version ID (CE)> component must be valued "HL7AU-OO-201701^^L201701&&L".

To indicate compliance with Simplified Referral profile see Appendix 8 Simplified REF profile A8.3 Sender Conformance.

To indicate compliance with other profiles, refer to the profile specification.

Anchor
MSH-13
MSH-13
2.1.9.13 MSH-13 Sequence number (NM) 00013

...

Note: In the Australian context acknowledgements must always be used and the value should must be "AL".

Anchor
MSH-16
MSH-16
2.1.9.16 MSH-16 Application acknowledgment type (ID) 00016

...

HL7 Table 0155 - Accept/application acknowledgment conditions

ValueDescription
ALAlways
NENever
ERError/reject conditions only
SUSuccessful completion only

Note: In the Australian context application acknowledgements should be used and the value should must be "AL".

Note: If MSH-15-accept acknowledgment type and MSH-16-application acknowledgment type are omitted (or are both null), the original acknowledgment mode rules are used.

Anchor
MSH-17
MSH-17
2.1.9.17 MSH-17 Country code (ID) 00017

...

HL7 Table 0399 – Country code 

ValueDescription
ABWARUBA
AFGAFGHANISTAN
AFTFRENCH SOUTHERN TERRITORIES
AGOANGOLA
AIAANGUILLA
ALBALBANIA
ANDANDORRA
ANTNETHERLANDS ANTILLES
AREUNITED ARAB EMIRATES
ARGARGENTINA
ARMARMENIA
ASMAMERICAN SAMOA
ATAANTARCTICA
ATGANTIGUA AND BARBUDA
AUSAUSTRALIA
AUTAUSTRIA
AZEAZERBAIJAN
BDIBURUNDI
BELBELGIUM
BEN BENIN 
BFA  BURKINA FASO
BGD BANGLADESH 
BGRBULGARIA 
BHR BAHRAIN 
BHS BAHAMAS 
BIH BOSNIA AND HERZEGOVINA 
BLR BELARUS 
BLZ BELIZE
BMU BERMUDA 
BOL BOLIVIA 
BRA BRAZIL
BRB BARBADOS 
BRN BRUNEI DARUSSALAM 
BTN BHUTAN 
BVTBOUVET ISLAND
BWA BOTSWANA 
CAFCENTRAL AFRICAN REPUBLIC 
CAN CANADA 
CCK COCOS (KEELING) ISLANDS 
CHE SWITZERLAND 
CHL CHILE
CHN CHINA 
CIV COTE D'VOIRE 
CMR CAMEROON 
COD CONGO, THE DEMOCRATIC REPUBLIC OF THE 
COG CONGO 
COK COOK ISLAND 
COL COLOMBIA 
COM COMOROS 
CPV CAPE VERDE 
CRI COSTA RICA 
CUB CUBA
CXR CHRISTMAS ISLAND 
CYM CAYMAN ISLANDS 
CYP CYPRUS 
CZE CZECH REPUBLIC 
DEU GERMANY 
DJIDJIBOUTI 
DMA DOMINICA 
DNK DENMARK 
DOM DOMINICAN REPUBLIC 
DZA ALGERIA 
ECU ECUADOR 
EGY EGYPT 
ERI  ERITREA 
ESH WESTERN SAHARA 
ESP SPAIN
EST ESTONIA 
ETH ETHIOPIA 
FIN FINLAND 
FJI FIJI 
FLK FALKLAND ISLANDS (MALVINAS) 
FRA FRANCE 
FRO FAROE ISLANDS 
FSMMICRONESIA, FEDERATED STATES OF 
GAB GABON 
GBR UNITED KINGDOM 
GEO GEORGIA 
GHA GHANA 
GIB GIBRALTAR 
GIN GUINEA 
GLP GUADELOUPE 
GMB GAMBIA 
GNB GUINEA-BISSAU 
GNQ EQUATORIAL GUINEA 
GRC GREECE 
GRD GRENADA 
GRLGREENLAND
GTM GUATEMALA 
GUF FRENCH GUIANA 
GUM GUAM 
GUY GUYANA 
HKG HONG KONG 
HMD HEARD ISLAND AND MCDONALD ISLANDS 
HND HONDURAS 
HRV CROATIA 
HTI HAITI 
HUN HUNGARY 
IDN INDONESIA 
IND INDIA 
IOT BRITISH INDIAN OCEAN TERRITORY 
IRL IRELAND 
IRN IRAN, ISLAMIC REPUBLIC OF 
IRQ IRAQ 
ISL ICELAND
ISR ISRAEL 
ITA ITALY 
JAM JAMAICA 
JOR JORDAN 
JPN  JAPAN
KAZ  KAZAKSTAN
KEN KENYA 
KGZ KYRGYZSTAN 
KHMCAMBODIA 
KIRKIRIBATI 
KNA SAINT KITTS AND NEVIS 
KOR KOREA, REPUBLIC OF 
KWT KUWAIT 
LAOLAO PEOPLE'S DEMOCRATIC REPUBLIC 
LBN LEBANNON 
LBR LIBERIA 
LBY LIBYAN ARAB JAMAHIRIYA 
LCA SAINT LUCIA 
LIE LIECHTENSTEIN 
LKA SRI LANKA 
LSO LESOTHO 
LTU LITHUANIA 
LUX LUXEMBOURG 
LVA LATIVA 
MAC MACAU 
MAR MOROCCO 
MCO MONACO 
MDA MOLDOVA, REPUBLIC OF 
MDG MADAGASCAR 
MDV MALDIVES 
MEX MEXICO 
MHL MARSHALL ISLANDS 
MKD MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF 
MLI MALI 
MLT MALTA 
MMR MYANMAR 
MNG MONGOLIA 
MNP NORTHERN MARIANA ISLANDS 
MOZ MOZAMBIQUE 
MRT MAURITANIA 
MSR MONTSERRAT 
MTQ MARTINIQUE 
MUS MAURITUS 
MWI MALAWI 
MYS MALAYSIA 
MYT MAYOTTE 
NAMNAMIBIA 
NCL NEW CALEDONIA 
NER NIGER 
NFK NORFOLK ISLAND 
NGA NIGERIA 
NIC NICARAGUA 
NIU NIUE 
NLD NETHERLANDS 
NOR NORWAY 
NPL NEPAL 
NRU NAURU 
NZL NEW ZEALAND 
OMN OMAN 
PAK PAKISTAN 
PAN PANAMA 
PCN PITCAIRN 
PER PERU 
PHL PHILIPPINES 
PLW PALAU 
PNG PAPUA NEW GUINEA 
POL POLAND 
PRI PUERTO RICO 
PRK KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF 
PRT PORTUGAL 
PRY PARAGUAY 
PYFFRENCH POLYNESIA 
QAT QATAR 
REUREUNION 
ROM ROMANIA 
RUS RUSSIAN FEDERATION 
RWA RWANDA 
SAU SAUDI ARABIA 
SDN SUDAN 
SEN SENEGAL
SGP SINGAPORE
SGS SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS 
SHN SAINT HELENA 
SJM SVALBARD AND JAN MAYEN 
SLB  SOLOMON ISLANDS 
SLE SIERRA LEONE 
SLV EL SALVADOR 
SMR SAN MARINO 
SOMSOMALIA 
SPM SAINT PIERRE AND MIQUELON 
STP SAO TOME AND PRINCIPE 
SUR SURINAME 
SVK SLOVAKIA 
SVN SLOVENIA 
SWESWEDEN 
SWZ SWAZILAND 
SYCSEYCHELLES 
SYRSYRIAN ARAB REPUBLIC 
TCATURKS AND CAICOS ISLANDS 
TCD CHAD 
TGO TOGO 
THA THAILAND 
TJK TAJIKISTAN 
TKL TOKELAU 
TKM TURKMENISTAN
TMP EAST TIMOR 
TON TONGA 
TTO TRINIDAD AND TOBAGO 
TUN TUNISIA 
TURTURKEY 
TUV TUVALU 
TWN TAIWAN, PROVINCE OF CHINA 
TZA TANZANIA, UNITED REPUBLIC OF 
UGA UGANDA 
UKR UKRAINE 
UMI UNITED STATES MINOR OUTLYING ISLANDS 
URY URUGUAY 
USA UNITED STATES 
UZB UZBEKISTAN 
VAT HOLY SEE (VATICAN CITY STATE) 
VCT SAINT VINCENT AND THE GRENADINES 
VEN VENEZUELA 
VGB VIRGIN ISLANDS, BRITISH 
VIR VIRGIN ISLANDS, U.S. 
VNM VIET NAM 
VUT VANUATU 
WLF WALLIS AND FUTUNA
WSM SAMOA
YEM YEMEN 
YUG YUGOSLAVIA 
ZAF SOUTH AFRICA 
ZMB ZAMBIA 
ZWE ZIMBABWE 

Anchor
MSH-18
MSH-18
2.1.9.18 MSH-18 Character set (ID) 00692

Definition: This field contains the character set for the entire message. Refer to HL7 Table 0211 - Alternate character sets for valid values.

In Australian usage only ASCII, which is the default if blank, or 8859/1 should be used. "UNICODE" or "ASCII" must be used (unvalued implies "ASCII").  "UNICODE UTF-8" and "8859/1" messages should only be used by specific agreement.

...

HL7 Table 0211 - Alternate character sets

ValueDescriptionComment
ASCIIThe printable 7-bit ASCII character set.(This is the default if this field is omitted)
8859/1The printable characters from the ISO 8859/1 Character set 
8859/2The printable characters from the ISO 8859/2 Character set 
8859/3The printable characters from the ISO 8859/3 Character set 
8859/4The printable characters from the ISO 8859/4 Character set 
8859/5The printable characters from the ISO 8859/5 Character set 
8859/6The printable characters from the ISO 8859/6 Character set 
8859/7The printable characters from the ISO 8859/7 Character set 
8859/8The printable characters from the ISO 8859/8 Character set 
8859/9 The printable characters from the ISO 8859/9 Character set  
ISO IR14  Code for Information Exchange (one byte)(JIS X 0201-1976). Note that the code contains a space,i.e. "ISO IR14".  
ISO IR87  Code for the Japanese Graphic Character set for information interchange (JIS X 0208-1990), Note that the code contains a space, i.e. "ISO IR87".  
ISO IR159  Code of the supplementary Japanese Graphic Character set for information interchange (JIS X 0212-1990). Note that the code contains a space, i.e. "ISO IR159".  
UNICODE The world wide character standard from ISO/IEC 10646-1-19933 Deprecated in HL7v2.6. Retained for backward compatibility
only as v 2.5. Replaced by specific Unicode
encoding codes.
UNIC
ODE
UNICODE UTF-8UCS Transformation Format, 8-bit form. UTF-8 is a variable-length encoding, each code
value is represented by 1,2 or 3 bytes, depending on
the code value. 7 bit ASCII is a proper subset of
UTF but not before and after the hyphen.

† "UNICODE UTF-8" was introduced in HL7v2.6 and has been back ported into this HL7v2.4 localisation to allow use of UTF-8 character encoding.

...

HL7 Table 0356 - Alternate character set handling scheme

Scroll Table Layout
widths20%,80%

ValueDescription
ISO 2022-1994This standard is titled "Information Technology - Character Code Structure and Extension Technique". This standard specifies an escape sequence from basic one byte character set to specified other character set, and vice versa. The escape sequence explicitly specifies what alternate character set to be evoked. Note that in this mode, the actual ASCII escape character is used as defined in the referenced ISO document. As noted in HL7 International Standard 1.6.1., escape sequences to/from alternate character set should occur within HL7 delimiters. In other words, HL7 delimiters are basic one byte characters only, and just before and just after delimiters, character encoding status should be the basic one byte set.
2.3The character set switching mode specified in HL7 2.3, HL7 International Standard sections 2.8.28.6.1, and 2.9.2. Note that the escape sequences used in this mode do not use the ASCII "esc" character. They are "HL7 escape sequences" as defined in HL7 2.3, sec. 2.9 as defined in ISO 2022-1994 (Also, note that HL7 International Standard sections 2.8.28.6.1and 2.9.2 in HL7 2.3 correspond to HL7 International Standard sections 2.8.31.6.1and 2.9.2 in HL7 2.4.)
<null>This is the default, indicating that there is no character set switching occurring in this message.

Anchor
MSH-21
MSH-21
2.1.9.21 MSH-21 Conformance statement ID (ID) 01598

...

HL7 Table 0449 - Conformance statements

ValueDescription
 Values here are by site negotiation.

Note: As HL7 technical committees ballot conformance statements, table 449 will be populated with their identifiers. No identifiers have been issued as of v 2.4. As with any HL7 table, this table may be extended with site-defined identifiers.

...

HL7 Attribute Table – PID – Patient identification

SEQLENDTOPTRP/#TBL#
ITEM#
ITEM #ELEMENT NAME

1

4

SI

O

R †††


 

00104

Set ID - PID

2

20

CX

B

 

 

00105

Patient ID

3

250

CX

R

Y

 

00106

Patient Identifier List

4

20

CX

B

Y

 

00107

Alternate Patient ID - PID

5

250

XPN

R

Y

 

00108

Patient Name

6

250

XPN

O

 

00109

Mother’s Maiden Name

7

26

TS

O

 

 

00110

Date/Time of Birth

8

1

IS

O

 

0001

00111

Administrative Sex

9

250

XPN

B

Y

 

00112

Patient Alias

10

250

CE

O

0005

00113

Race

11

250

XAD

O

Y

 

00114

Patient Address

12

4

IS

B

 

0289

00115

County Code

13

250

XTN

O

Y

 

00116

Phone Number - Home

14

250

XTN

O

Y

 

00117

Phone Number - Business

15

250

CE

O

 

0296

00118

Primary Language

16

250

CE

O

 

0002

00119

Marital Status

17

250

CE

O

 

0006

00120

Religion

18

250

CX

O

 

 

00121

Patient Account Number

19

16

ST

B

 

 

00122

SSN Number - Patient

20

25

DLN

O

 

 

00123

Driver's License Number - Patient

21

250

CX

O

Y

 

00124

Mother's Identifier

22

250

CE

O

Y

0189

00125

Ethnic Group

23

250

ST

O

 

 

00126

Birth Place

24

1

ID

O

 

0136

00127

Multiple Birth Indicator

25

2

NM

O

 

 

00128

Birth Order

26

250

CE

O

Y

0171

00129

Citizenship

27φ

250

CE

O

 

0172

00130

Veterans Military Status

28

250

CE

B

 

0212

00739

Nationality

29

26

TS

O

 

 

00740

Patient Death Date and Time

30

1

ID

O

 

0136

00741

Patient Death Indicator

31

1

ID

O

 

0136

01535

Identity Unknown Indicator

32

20

IS

O

Y

0445

01536

Identity Reliability Code

33

26

TS

O

 

 

01537

Last Update Date/Time

34

40

HD

O

 

 

01538

Last Update Facility

35

250

CE

C

 

0446

01539

Species Code

36

250

CE

C

 

0447

01540

Breed Code

37

80

ST

O

 

 

01541

Strain

38

250

CE

O

2

0429

01542

Production Class Code

† PID-6 and PID-10: component repeatability has been removed in the Australian context.  Variance to HL7 International.

...

‡ PID-24: HL7 table 0136 has options of 'Yes/No', whereas METeOR 482409668881 is the number of live births arising from a single pregnancy.  Variance to Use HL7 InternationalTable 0136.

φ PID-27: DVA file number is sent in PID-3.1. The DVA card colour is no longer sent in this field (refer to PID-3.5). Variance to HL7 International.

††† PID-1 is mandatory in the Australian context. Variance to HL7 International.


Anchor
PID-fd
PID-fd
2.2.1.0 PID field definition

...

Only the sender's identifier(s) and the receiver's identifier(s) should be transmitted to avoid inappropriate use and disclosure of patient information. Other organizations' identifiers should not be used by organisations or providers as their own identifiers. The Privacy Act 1998 (commonwealth) has the relevant state and territory legislation regarding person identifiers. 

Patient identifiers are not always be unique. 

Anchor
PID-4
PID-4
2.2.1.4 PID-4 Alternate patient ID - PID  (CX) 00107

...

Anchor
table0200
table0200
HL7 Table 0200 - Name type

ValueDescription
AAlias Name
BName at Birth
CAdopted Name
DDisplay Name
ILicensing Name
LLegal Name
MMaiden Name
NNickname /"Call me" Name/Street Name
PName of Partner/Spouse (retained for backward compatibility only)
RRegistered Name (animals only)
SCoded Pseudo-Name to ensure anonymity
TIndigenous/Tribal/Community Name
U

Unspecified

For animals, if a Name Type of "R" is used, use "Name Context" to identify the authority with which the animal’s name is registered.

...

This field allows for variable precision of the date/time of birth. Refer to 3.26 TS - time stamp for details how to encode date/time in this field.

Refer to METeOR 287007, ‘Date of birth’ and AS 4846-2014 Clause 5.2.3 'Date of Birth Accuracy Indicator', Clause 5.2.2 'Date of Birth'.

...

HL7 code values (User-defined Table 0001 - Administrative sex) need to be used for messages whereas METeOR values are required for data collection and statistics. The following mapping should be used:

Anchor
table0001
table0001

User-defined Table 0001 Administrative sex

METeOR (287316 Sex)
CodeDescriptionCodeDescription
MMale1Male
FFemale2Female
AAmbiguous3Indeterminate or Intersex
OOther9Not stated/Inadequately described
UUnknown9Not stated/Inadequately described
NNot Applicable9Not stated/Inadequately described

Also refer to AS to AS 4846-2014 Clause  Clause 5.5 'Sex'.

 

Anchor
PID-9
PID-9
2.2.1.9 PID-9 Patient alias (XPN) 00112

...

Definition:  This field has been retained for backward compatibility only. It is recommended to use PID-5 - patient name for all patient names. This field contained the name(s) by which the patient has been known at some time.  Refer to HL7 Table 0200 - Name type for valid values.

Anchor
PID-10
PID-10
2.2.1.10 PID-10 Race (CE) 00113

...

Definition:  This element is used for Indigenous status - refer to METeOR 602543 'Indigenous status'.  The second triplet of the CE data type for race (alternate identifier, alternate text, and name of alternate coding system) is reserved for governmentally assigned codes.

...

Example field: PID-11 Patient address

ValueDescription
CCurrent address
HHome address
MMailing address

Refer to AS 4846-2014 Clause  Clause 6.

Anchor
PID-12
PID-12
2.2.1.12 PID-12 County code (IS) 00115

...

Definition:  This field contains the patient’s personal phone numbers.  All personal phone numbers for the patient are sent in the following sequence.  The first sequence is considered the primary number (for backward compatibility).  If the primary number is not sent, then a repeat delimiter is sent in the first sequence.  Refer to HL7 Table 0201 - Telecommunication use code and HL7 Table 0202 - Telecommunication equipment type for valid values.

Refer to AS 4846-2014 Clause  Clause 7 Electronic Address Group.

Anchor
PID-14
PID-14
2.2.1.14 PID-14 Phone number

...

- business (XTN) 00117

Components: [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <e-mail address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ <phone number (NM)> ^ <extension (NM)> ^ <any text (ST)>

...

User-defined Table 0296 - Primary language

ValueDescription
 No suggested values defined

Refer to METeOR 460123659407, ‘Preferred language’.

Anchor
PID-16
PID-16
2.2.1.16 PID-16 Marital status (CE) 00119

...

If METeOR values are required for data collection or statistical purposes, the values should be mapped using the following mapping:

Anchor
table0002
table0002

HL7 Table 0002 METeOR (291045 'Martial Status')
SSingle1Never married
WWidowed2Widowed
DDivorced3Divorced
ASeparated4Separated
MMarried5Married (incl. defacto)
UUnknown6Not stated/Inadequately described


Anchor
PID-17
PID-17
2.2.1.17 PID-17 Religion (CE) 00120

...

Note: In the Australian context this field has been superseded; hence use PID-3 Patient Identifier List.

Anchor
PID-21
PID-21
2.2.1.
21 21 PID-21 Mother's identifier identifier (CX) 00124 

Components: <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> ^ <identifier type code (ID)> ^ < assigning facility (HD) ^ <effective date (DT)> ^ <expiration date (DT)>

Subcomponents of assigning authority: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Subcomponents of assigning facility: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition:

...

This field is used, for example, as a link field for newborns.

...

Typically a patient ID or account number may be used.

...

This field can contain multiple identifiers for the same mother.

...

Refer to HL7 Table 0061 - Check digit scheme for valid values.

Anchor
PID-22
PID-22
2.2.1.22   PID-22 Ethnic group (CE) 00125 00125

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

Definition:

...

This field further defines the patient’s ancestry.

...

Note: In the Australian context, this field is retained for backwards compatibility and hence is a variance to HL7 International. In the Australian context this field is not to be used for indigenous status or country of birth - refer to PID-10.

Anchor
PID-23
PID-23
2.2.1.23   PID-23 Birth place (ST) 00126 00126

Definition:

...

This field indicates the location of the patient’s birth, for example "St. Francis Community Hospital of Lower South Side". The actual address is reported in PID-11 with an identifier of "N".

Note: In the Australian context this field is used for the patient's country of birth.

...

Refer to METeOR

...

659454 'Country of birth' and AS 4846-2014 Clause 5.8.4 'Country of birth'.

Anchor
PID-24
PID-24
2.2.1.24   PID-24 Multiple birth indicator (ID) 00127 00127

Definition:

...

This field indicates whether the patient was part of a multiple birth.

...

Refer to HL7 Table 0136 - Yes/No Indicator for valid values.

In the Australian context

...

METeOR 482409 Birth plurality

...

indicates the total number of births from a single pregnancy

...

.

...

Note:

...

Note that HL7 table 0136 is a 'Yes/No' valued table, where as METeOR

...

668881 'Birth Plurality' is the number of live births resulting from a single pregnancy. Use HL7 table 0136.

Anchor
PID-25
PID-25
2.2.1.25
  PID-25 Birth order (NM) 00128 00128

Definition:

...

When a patient was part of a multiple birth, a value (number) indicating the patient’s birth order is entered in this field.

Refer to

...

METeOR 669962 'Birth order' and AS 4846-2014 Clause 5.3.2.


Anchor
PID-26
PID-26
2.2.1.26
  PID-26 Citizenship Citizenship (CE) 00129 

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

Definition:

 

This field contains the patient’s country of citizenship.

 

HL7 recommends using ISO table 3166 as the suggested values in User-defined Table 0171 - Citizenship.

In the Netherlands, this field is used for "Nationaliteit".

Anchor
table0171
table0171

User-defined Table 0171 - Citizenship Citizenship 

ValueDescription
 
No suggested values defined

Anchor
PID-27
PID-27
2.2.1.27 PID-27 Veterans military status (CE)

00130 

00130

 
Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (IS)>
Definition:  This field contains the military status assigned to a veteran.
 Note
 Note: In the Australian context DVA file number is sent in PID-3.1 and the DVA card colour is no longer sent in this field (PID-3.5). 

Anchor
PID-28
PID-28
2.2.1.28 PID-28 Nationality (CE) 00739 

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

Definition: From V2.4 onward, this field has been retained for backward compatibility only.  It is recommended to refer to PID-10 - Race, PID-22 - Ethnic group and PID-26 - Citizenship. This field contains a code that identifies the nation or national grouping to which the person belongs.  This information may be different from a person’s citizenship in countries in which multiple nationalities are recognized (for example, Spain: Basque, Catalan, etc.).

Anchor
PID-29
PID-29
2.2.1.29 PID-29 Patient death date and time (TS) 00740 

Definition:  This field contains the date and time at which the patient death occurred.

Refer to AS 4846-2014 Clause 5.4.2 'Date of Death' and Clause 5.4.3 'Date of Death Accuracy Indicator'.  Note: HL7 V2.4 does not accommodate AS 4846-2014 Clause 5.4.4 'Source of Death Notification'.

Anchor
PID-30
PID-30
2.2.1.30 
PID-30 Patient death indicator (ID) 00741 

Definition:  This field indicates whether the patient is deceased.  Suggested valid values:

Y             the patient is deceased

N             the patient is not deceased

Anchor
PID-31
PID-31
2.2.1.31  PID-31 Identity unknown indicator (ID) 01535 

Definition:

...

This field indicates whether or not the patient’s/person’s identity is known.

...

Suggested valid values:

...

Y the patient’s/person’s identity is unknown

...

N the

...

patient’s/person’s identity is known

Anchor
PID-32
PID-32
2.2.1.32
  PID-32 Identity reliability code (IS) 01536 01536

Definition:

...

This field contains a coded value used to communicate information regarding the reliability of patient/person identifying data transmitted via a transaction.

...

Values could indicate that certain fields on a PID segment for a given patient/person are known to be false (e.g., use of default or system-generated values for Date of Birth or Social Security Number.

...

Refer to User-defined Table 0445 - Identity reliability code for suggested values.

Anchor
table0445
table0445

User-defined Table 0445 - Identity Reliability Code 

ValueDescription
USUnknown/Default Social Security Number
UDUnknown/Default Date of Birth
UAUnknown/Default Address
ALPatient/Person Name is an Alias

Anchor
PID-33
PID-33
2.2.1.33 PID-33 Last update date/time (TS) 01537 01537

Definition:

...

This field contains the last update date and time for the patient’s/person’s identifying and demographic data, as defined in the PID segment.

...

Receiving systems will use this field to determine how to apply the transaction to their systems.

...

If the receiving system (such as an enterprise master patient index) already has a record for the person with a later last update date/time, then the EMPI could decide not to apply the patient’s/person’s demographic and identifying data from this transaction.

Anchor
PID-34
PID-34
2.2.1.34   PID-34 Last update facility (HD) 01538 01538

Definition: This field identifies the facility of the last update to a patient’s/person’s identifying and demographic data, as defined in the PID segment.

...

Receiving systems or users will use this field to determine how to apply the transaction to their systems.

...

If the receiving system (such as a hospital’s patient management system) already has a record for the patient/person, then it may decide to only update its data if the source is a "trusted" source.

...

A hospital might consider other hospitals trusted sources, but not "trust" updates from non-acute care facilities.

...

For example:


...|Metro Hospital|...

Anchor
PID-35
PID-35
2.2.1.35   PID-35 Species code (CE) 01539 01539

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

Definition:

...

The species of living organism.

...

This may include the common or scientific name, based on the coding system(s) used.

...

SNOMED is the recommended coding system.

...

If this field is not valued, a human is assumed.

...

Refer to

...

User-defined Table 0446 - Species Code for suggested values.

Anchor
table0446
table0446

User-defined Table 0446 - Species Code 

ValueDescription
 No suggested values defined


Conditionality Rule: This field must be valued if PID-36 - Breed Code or PID-38 - Production Class Code is valued.

For example:

...|L-80700^Canine, NOS^SNM3|...
...|L-80100^Bovine^SNM3|...
...|L-80A00^Feline^SNM3|...


Anchor
PID-36
PID-36
2.2.1.
36 36 PID-36 Breed code code (CE) 01540 

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


Definition:

...

The specific breed of animal.

...

This field, unlike Species and Strain is specific to animals and cannot be generally used for all living organisms. SNOMED is the recommended coding system. Refer to User-defined Table 0447 - Breed Code for suggested values.

Anchor
table0447
table0447

User-defined Table 0447 - Breed Code 

ValueDescription
 No suggested values defined


 

Conditionality Rule: This field must be valued if PID-37 - Strain is valued.


For example, (showing primary and alternative coding systems, using locally defined "American Kennel Club" nomenclature):

...|L-80733^ Staffordshire bull terrier^SNM3^^American Staffordshire Terrier^99AKC|...
...|L-80900^Weimaraner^SNM3|...
...|L-80439^Peruvian Paso Horse^SNM3|...

Anchor
PID-37
PID-37
2.2.1.37
  PID-37 Strain (ST) 01541 01541

Definition:

...

This field contains the specific strain of animal.

...

It can also be expanded to include strain of any living organism and is not restricted to animals.

Example:
...|DeKalb|...
...|Balb/c|...
...|DXL|...

Anchor
PID-38
PID-38
2.2.1.38
  PID-38 Production class code (CE) 01542 01542

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

Definition: This field contains the code and/or text indicating the primary use for which the living subject was bred or grown. Refer to User-defined Table 0429 - Production Class Code for suggested values. For example:

...|DA^Dairy^L|...
...|MT^Meat^L|...
...|RA^Racing^L|...

Anchor
table0429
table0429

User-defined Table 0429 - Production class Code  

ValueDescription
BRBreeding/genetic stock
DADairy
DR Draft
DUDual Purpose
LYLayer, Includes Multiplier flocks
MTMeat
OTOther
PLPleasure
RARacing
SHShow
NANot Applicable
UUnknown

 

Anchor
PV1
PV1

2.2.2 PV1 - patient visit segment

...

HL7 Attribute Table - PV1 – Patient visit

Scroll Table Layout
sortDirectionASC
repeatTableHeadersdefault
style
widths7%, 7%, 7%, 7%, 10%,10%, 10%, 42%
sortByColumn1
sortEnabledfalse
cellHighlightingtrue

SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
14SI
O
R ††††  00131Set ID - PV1
21ISR 000400132Patient Class
380PLO  00133Assigned Patient Location
IS  0007 00134 Admission Type 
250 CX   00135  Preadmit Number 
80 PL   00136Prior Patient Location 
250 XCN Y0010 00137 Attending Doctor 
250 XCN 0010 00138 Referring Doctor 
250 XCN 
C†††
Y††† 
0010 00139 Consulting Doctor  (only first repeat is used in routing
, required for Australia
)
10  10†IS C‡  0069 00140 Hospital Service 
11 80PL   00141 Temporary Location 
12 2IS  0087 00142  Preadmit Test Indicator 
13 IS  009200143 Re-admission Indicator 
14 IS  0023  00144 Admit Source 
15 IS Y0009 00145 Ambulatory Status
16 IS  0099 00146 VIP Indicator 
17 250 XCN 001000147 Admitting Doctor 
18  IS 001800148 Patient Type 
19 250 CX O  00149 Visit Number 
20 50  FCO Y0064 00150 Financial Class 
21 13 ††IS O 0032 00151  Charge Price Indicator 
22IS  0045 00152 Courtesy Code
23 IS  0046 00153 Credit Rating 
24 IS 004400154 Contract Code 
25 DT Y 00155 Contract Effective Date 
26 12 NM  00156 Contract Amount 
27 NM  00157 Contract Period 
28 IS  0073 00158 Interest Code 
29 IS  0110 00159  Transfer to Bad Debt Code 
30 DT   00160Transfer to Bad Debt Date 
31 10 IS  0021 00161 Bad Debt Agency Code 
32 12NM   00162  Bad Debt Transfer Amount 
33 12 NM   00163  Bad Debt Recovery Amount 
34 IS  0111 00164  Delete Account Indicator 
35 DT   00165  Delete Account Date 
36 IS  0112 00166 Discharge Disposition 
37 25 CM  0113 00167 Discharged to Location 
38 250 CE 0114 00168 Diet Type 
39 IS   0115 00169 Servicing Facility 
40 IS  0116 00170 Bed Status 
41 2  IS  0117 00171  Account Status
42 80 PL   00172 Pending Location 
43 80 PL   00173 Prior Temporary Location 
44 26 TS   00174 Admit Date/Time 
45 26 TS  Y 00175 Discharge Date/Time 
46 12 NM   00176 Current Patient Balance 
47 12 NM   00177 Total Charges 
48 12 NM   00178 Total Adjustments 
49 12 NM   00179 Total Payments 
50 250 CX  0203 00180 Alternate Visit ID 
51IS  032601226 Visit Indicator 
52 250 XCN  Y0010  01274Other Healthcare Provider 

†  Australian variation to HL7 V2.4 with the length changed from 3 to 10 characters.

...

††† Australian variation to HL7 2.4. Changed to required conditional as first repeat is used to identify target of the message for routing purposes. Field is required for addressing when messages are to be sent by a messaging service. Field is optional when message is used internally.

†††† PV1-1 is required in the Australian context. Variance to HL7 International.

Anchor
PV1-fd
PV1-fd
2.2.2.0 PV1 field definitions

...

User-defined Table 0004 - Patient class

ValueDescription
EEmergency
IInpatient
OOutpatient
PPreadmit
S†Same day patient
Y†Community client
RRecurring patient
BObstetrics
CCommercial Account
Not Applicable 
Unknown 

Note: Patients from private surgeries are outpatients.

...

Anchor
PV1-3
PV1-3
2.2.2.3 PV1-3 Assigned patient location (PL) 00133

...

Definition: This field contains the patient’s initial assigned location or the location to which the patient is being moved. The first component may be the nursing station for inpatient locations, or clinic or department, for locations other than inpatient. For cancelling a transaction or discharging a patient, the current location (after the cancellation event or before the discharge event) should be in this field. If a  value exists in the fifth component (location status), it supersedes the value in PV1-40 - Bed Status.

Anchor
PV1-4
PV1-4
2.2.2.4 PV1-4 Admission type (IS) 00134

 Definition Definition: This field indicates the circumstances under which the patient was or will be admitted. Refer  to User-defined Table 0007 - Admission type for suggested values. In the US, it is recommended to report the UB92 FL 19 "Type of Admission" in this field.

...

User-defined Table 0007 - Admission type

ValueDescription
AAccident
Elective  
EEmergency
GGeriatric respite admission
LLabor and Delivery
Newborn (Birth in healthcare facility) 
RRoutine
SStatistical admission
Urgent 

Note: G and S are Australian additions.

...

User-defined Table 0010 - Physician ID

ValueDescription
 No suggested values defined

Note: In the Australian context this field should not be used unless the system caters for registrars or residents.

...

User-defined Table 0069 - Hospital service

ValuesDescription
MEDMedical Service
SURSurgical Service
UROUrology Service
PULPulmonary Service 
CAR Cardiac Service

Note: 

  • Australian variation to HL7 V2.4 with the length changed from 3 to 10 characters.
  • The 'O' optionality code in HL7 V2.4 is a typographical error and the optionality should be 'C'.
  • In the Australian context this field is required for trigger events A01, A02, A05, A14 and A15.

...

User-defined Table 0087 - Pre-admit test indicator

ValueDescription
 No suggested values defined

Anchor
PV1-13
PV1-13
2.2.2.13 PV1-13 Re-admission indicator (IS) 00143

...

User-defined Table 0092 - Re-admission indicator

ValueDescription
RRe-admission

Anchor
PV1-14
PV1-14
2.2.2.14 PV1-14 Admit source (IS) 00144

...

User-defined Table 0023 - Admit source

ValueDescription
1Physician referral
2Clinic referral
3HMO referral
4Transfer from a hospital
5Transfer from a skilled nursing facility
6Transfer from another health care facility
7Emergency room
8Court/law enforcement
Information not available

 In the Australian context refer to METeOR 269976 "Episode of admitted patient care—admission mode", and METeOR 269947 "Episode of admitted patient care—referral source, public psychiatric hospital code".

...

User-defined Table 0009 - Ambulatory status

ValueDescription
A0No functional limitations
A1Ambulates with assistive device
A2Wheelchair/stretcher bound
A3 Comatose; non-responsive 
A4 Disoriented 
A5 Vision impaired 
A6Hearing impaired 
A7 Speech impaired 
A8 Non-English speaking 
A9 Functional level unknown 
B1Oxygen therapy 
B2 Special equipment (tubes, IVs, catheters) 
B3 Amputee 
B4  Mastectomy 
B5 Paraplegic 
B6 Pregnant 

Anchor
PV1-16
PV1-16
2.2.2.16 PV1-16 VIP indicator (IS) 00146

...

User-defined Table 0099 - VIP indicator

ValueDescription
V1No suggested values defined

In the Australian context the recommended values are:

Digit 1Digit 2
N

National leader (President, Prime Minister,
royalty)

0No special privacy or protection issues
RReligious leader1Special privacy requirement
BSenior business leader2Extreme privacy requirement
MCurrently focus of media attention.3

Armed protection/security, no special privacy
issues

HHospital staff or near relative4

Armed protection/security, special privacy
requirement

VVery important person, not otherwise defined5

Armed protection/security, extreme privacy
requirement

  6

Extreme protection/security, no special privacy
issues

  7

Extreme protection/security, special privacy
requirement

  8

Extreme protection/security, extreme privacy
requirement

  9

Privacy or protection requirement, not
otherwise defined

Codes H and V are the likely to be the most significant codes as hospital staff/near relative have been flagged in studies as the most likely to have inappropriate access to data and therefore H is import for auditing.  The code V is used for non-specific flagging.

...

User-defined Table 0018 - Patient type

ValueDescription
 No suggested values defined

In the Australian context refer to METeOR 584408 "Hospital service—care type".

...

User-defined Table 0064 - Financial class

METeOR

649391

679815 ‘Funding source for hospital patients’ codes

Code

Definition

01

Health service budget (not covered elsewhere)

02

Health service budget (due to eligibility for Reciprocal Health Care Agreement)

03

Health service budget (no charge raised due to hospital decision)

04

Department of Veterans' Affairs

05

Department of Defence

06

Correctional facility

07

Medicare Benefits Scheme

08

Other hospital or public authority (contracted care)

09

Private health insurance

10

Worker's compensation

11

Motor vehicle third party personal claim

12

Other compensation (e.g. public liability, common law, medical negligence)

13

Self-funded

88

Other funding source

Supplementary values:

http://meteor.aihw.gov.au/ui/helpWindow.phtml?itemId=tag.helpMeteorItemOtherPermissibleValues

98

Not known

Anchor
pv1-21
pv1-21
Anchor
PV1-21
PV1-21

...

User-defined Table 0032 - Charge/price indicator

ValueDescription
AUSM8585% of Medicare schedule fee        
AUSM7575% of Medicare schedule fee
AUSM100Medicare schedule fee
AUSAMA Australian Medical Association recommended fee

Note: Australian variation to HL7 V2.4 with the length changed from 2 to 13 characters to incorporate rules defined in HL7 Clause 5.4.1.

...

In the Australian context the recommended values are:

ValueDescription
CVPersonal cover (Muslim, etc.)
MEMuslim (face bed to east)
ROReligious orders

Anchor
PV1-23
PV1-23
2.2.2.23 PV1-23 Credit rating (IS) 00153

...

In the Australian context examples used in private hospitals includeusers may define their own table values:

ValueDescription
 Do not admit Persona non grata


Anchor
PV1-24
PV1-24
2.2.2.24 PV1-24 Contract code (IS) 00154

...

In the Australian context use a two character code from METeOR 270114 Contract role and METeOR 271475 270475 Contract type:

Scroll Table Layout
widths10%,15%,10%,15%,55%

Contract role (METeOR 270114)Contract type (METeOR 270475)
ValueDescriptionValueDescriptionDetailed description
AHospital A (Purchaser)1

Contract type B

A health authority / other external purchaser contracts hospital B for admitted service which is funded outside the standard funding arrangements.

BHospital B (Provider)2

Contract type ABA

Patient admitted by Hospital A. Hospital A contracts Hospital B for admitted or non-admitted patient service. Patient returns to Hospital A on completion of service by Hospital B.
For example, a patient has a hip replacement at Hospital A, then receives aftercare at Hospital B, under contract to Hospital A. Complications arise and the patient returns to Hospital A for the remainder of care.

  3

Contract type AB

Patient admitted by Hospital A. Hospital A contracts Hospital B for admitted or non-admitted patient service. Patient does not return to Hospital A on completion of service by Hospital B.

For example, a patient has a hip replacement at Hospital A and then receives aftercare at Hospital B, under contract to Hospital A. Patient is separated from Hospital B.

  4

Contract type (A)B

This contract type occurs where a Hospital A contracts Hospital B for the whole episode of care. The patient does not attend Hospital A. For example, a patient is admitted for endoscopy at Hospital B under contract to Hospital A.

  5

Contract type BA

Hospital A contracts Hospital B for an admitted patient service following which the patient moves to Hospital A for remainder of care. For example, a patient is admitted to Hospital B for a gastric resection procedure under contract to Hospital A and Hospital A provides after care.

Anchor
PV1-25
PV1-25
2.2.2.25 PV1-25 Contract effective date (DT) 00155

...

User-defined Table 0073 - Interest rate code

ValueDescription
 No suggested values defined

Anchor
PV1-29
PV1-29
2.2.2.29 PV1-29 Transfer to bad debt code (IS) 00159

...

In the Australian context reason for bad debt include:

ValueDescription
BBankrupt
DDeceased
LLeft address

Anchor
PV1-30
PV1-30
2.2.2.30 PV1-30 Transfer to bad debt date (DT) 00160

...

User-defined Table 0021 - Bad debt agency code

ValueDescription
 No suggested values defined

Anchor
PV1-32
PV1-32
2.2.2.32 PV1-32 Bad debt transfer amount (NM) 00162

...

User-defined Table 0111 - Delete account code

ValueDescription
 No suggested values defined

Anchor
PV1-35
PV1-35
2.2.2.35 PV1-35 Delete account date (DT) 00165

Definition: This field contains the date that the account was deleted from the file.

Anchor
PV1-36

...

PV1-36

...

2.2.2.36 PV1-36 Discharge disposition (IS) 00166

Definition: This field contains the disposition of the patient at time of discharge (i.e., discharged to home, expired, etc.). Refer to User-defined Table 0112 - Discharge disposition for suggested values. In the US, this field is used on UB92 FL22. The UB codes listed as examples are not an exhaustive or current list;refer to a UB specification for additional information.

...

User-defined Table 0112 - Discharge disposition

ValueDescription
01Discharged to home or self care (routine discharge)
02Discharged/transferred to another short term general hospital for inpatient care
03Discharged/transferred to skilled nursing facility (SNF)
04Discharged/transferred to an intermediate care facility (ICF)
05Discharged/transferred to another type of institution for inpatient care or referred for outpatient services to another institution
06Discharged/transferred to home under care of organized home health service organization
07Left against medical advice or discontinued care
08Discharged/transferred to home under care of Home IV provider
09Admitted as an inpatient to this hospital
10 …19  Discharge to be defined at state level, if necessary 
20 Expired (i.e. dead) 
21 ... 29  Expired to be defined at state level, if necessary 
30 Still patient or expected to return for outpatient services (i.e. still a patient) 
31 …39  Still patient to be defined at state level, if necessary (i.e. still a patient) 
40 Expired (i.e. died) at home 
41 Expired (i.e. died) in a medical facility; e.g., hospital, SNF, ICF, or free standing hospice 
42 Expired (i.e. died) - place unknown 

In the Australian context refer to METeOR 270094 "Mode of Separation" and METeOR 616654 Episode end status

Anchor
PV1-37
PV1-37
2.2.2.37 PV1-37 Discharged to location (CM) 00167

...

User-defined Table 0113 - Discharged to location

ValueDescription
 No suggested values defined

Anchor
PV1-38
PV1-38
2.2.2.38 PV1-38 Diet type (CE) 00168

...

User-defined Table 0114 - Diet type

ValueDescription
 No suggested values defined

Note: In the Australian context this data element is very limited in its application to dietary systems.  Diet orders are used to communicate diet type - refer to Section 4.7 of HL7 V2.4.

...

User-defined Table 0115 - Servicing facility

ValueDescription
 No suggested values defined

An optional sixth component, the facility ID, may be valued in each individual location field in PV1, instead of placing it here.

In the Australian context refer to METeOR 269973 "Establishment identifier". 

...

User-defined Table 0116 - Bed status

ValueDescription
CClosed
HHousekeeping
OOccupied
Unoccupied 
Contaminated 
 Isolated

Anchor
PV1-41
PV1-41
2.2.2.41 PV1-41 Account status (IS) 00171

...

User-defined Table 0117 - Account status

ValueDescription
 No suggested values defined

Anchor
PV1-42
PV1-42
2.2.2.42 PV1-42 Pending location (PL) 00172

...

In the Australian context refer to 269967 METeOR 269967 "Admission date" and METeOR 269972 682942 "Admission time".

Anchor
PV1-45
PV1-45
2.2.2.45 PV1-45 Discharge date/time (TS) 00175

...

In the Australian context refer to 270025 to METeOR 270025 "Separation date" and METeOR 270026 682919 "Separation time".

Anchor
PV1-46
PV1-46
2.2.2.46 PV1-46 Current patient balance (NM) 00176

...

User-defined Table 0326 - Visit indicator

ValueDescription
AAccount level (default)
VVisit level

Anchor
PV1-52
PV1-52
2.2.2.52 PV1-52 Other healthcare provider (XCN) 01274

...

HL7 Attribute Table - PV2 – Patient visit – additional information

SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
180PLC  00181Prior Pending Location
2250CEO 012900182Accommodation Code
3250CE  00183 Admit Reason
4250CEO  00184Transfer Reason
525STOY 00185Patient Valuables
625STO  00186Patient Valuables Location
72ISOY013000187Visit User Code
826TSO  00188Expected Admit Date/Time
926TSO  00189Expected Discharge Date/Time
103NMO  00711Estimated Length of Inpatient Stay
113NMO  00712Actual Length of Inpatient Stay
1250 ST   00713 Visit Description 
13250 XCN  † 00714 Referral Source Code 
14DT   00715 Previous Service Date 
15ID  0136 00716  Employment Illness Related Indicator 
16IS  0213 00717 Purge Status Code 
17DT   00718  Purge Status Date 
18IS  0214 00719 Special Program Code 
19ID  0136 00720  Retention Indicator 
20NM   00721  Expected Number of Insurance Plans 
21IS  0215  00722  Visit Publicity Code 
22
 1
1
XON 
ID 0136 00723  Visit Protection Indicator 
23250 
IS 
XON  Y 00724 Clinic Organization Name 
24IS  0216 00725 Patient Status Code 
25IS  0217 00726 Visit Priority Code 
26DT   00727 Previous Treatment Date 
27IS  0112 00728  Expected Discharge Disposition 
28DT   00729 Signature on File Date
29DT  00730 First Similar Illness Date 
30250 CE 021800731 Patient Charge Adjustment Code 
31IS  0219 00732  Recurring Service Code 
32ID   0136 00733  Billing Media Code 
3326 TS   00734 Expected Surgery Date and Time 
34ID  0136 00735  Military Partnership Code 
35ID  013600736 Military Non-Availability Code 
36ID  0136   00737 Newborn Baby Indicator 
37 1ID  0136 00738Baby Detained Indicator 
38250 CE 0430 01543Mode of Arrival Code 
39250CE


Y043101544Recreational Drug Use Code
40250CEO
043201545Admission Level of Care Code
41250CEOY043301546Precaution Code
42250CEO
043401547Patient Condition Code
432ISO
031500759Living Will Code
442ISO
031600760Organ Donor Code
45250CEOY043501548Advance Directive Code
468DTO

01549Patient Status Effective Date
4726TSC

01550Expected LOA Return Date/Time

† Australian variation to HL7 V2.4 where the component repeatability has been removed.

...

User-defined Table 0129 - Accommodation code

Value Description
 No suggested values defined

Anchor
PV2-3
PV2-3
2.2.3.3 PV2-3 Admit reason (CE) 00183

...

User-defined Table 0130 - Visit user code

ValueDescription
TETeaching
HOHome
MOMobile Unit
PH Phone 

Anchor
PV2-8
PV2-8
2.2.3.8 PV2-8 Expected admit date/time (TS) 00188

...

User-defined Table 0213 - Purge status code

ValueDescription
PMarked for purge. User is no longer able to update the visit.
DThe visit is marked for deletion and the user cannot enter new data against it.
IThe visit is marked inactive and the user cannot enter new data against it.

Anchor
PV2-17
PV2-17
2.2.3.17 PV2-17 Purge status date (DT) 00718

...

User-defined Table 0214 – Special program codes

ValueDescription
 No suggested values

Anchor
PV2-19
PV2-19
2.2.3.19 PV2-19 Retention indicator (ID) 00720

...

User-defined Table 0215 - Publicity code

ValueDescription
 No suggested values

Anchor
PV2-22
PV2-22
2.2.3.22 PV2-22 Visit protection indicator (ID) 00723

...

User-defined Table 0216 – Patient status

ValueDescription
 No suggested values defined

Anchor
PV2-25
PV2-25
2.2.3.25 PV2-25 Visit priority code (IS) 00726

...

User-defined Table 0217 - Visit priority code

ValueDescription
1Emergency
2Urgent
3Elective

Anchor
PV2-26
PV2-26
2.2.3.26 PV2-26 Previous treatment date (DT) 00727

...

User-defined Table 0112 - Discharge disposition 

ValueDescription
01Discharged to home or self care (routine discharge)
02 Discharged/transferred to another short term general hospital for inpatient care
03Discharged/transferred to skilled nursing facility (SNF)
04Discharged/transferred to an intermediate care facility (ICF)
05Discharged/transferred to another type of institution for inpatient care or referred for outpatient services to another institution
06 Discharged/transferred to home under care of organized home health service organization
07 Left against medical advice or discontinued care
08Discharged/transferred to home under care of Home IV provider
09Admitted as an inpatient to this hospital
10 …19Discharge to be defined at state level, if necessary
20Expired (i.e. dead)
21 ... 29Expired to be defined at state level, if necessary
30Still patient or expected to return for outpatient services (i.e. still a patient)
31 … 39Still patient to be defined at state level, if necessary (i.e. still a patient)
40 Expired (i.e. died) at home
41 Expired (i.e. died) in a medical facility; e.g., hospital, SNF, ICF, or free standing hospice
42Expired (i.e. died) - place unknown

Anchor
PV2-28
PV2-28
2.2.3.28 PV2-28 Signature on file date (DT) 00729

...

User-defined Table 0219 – Recurring service

ValueDescription
 No selected values

Anchor
PV2-32
PV2-32
2.2.3.32 PV2-32 Billing media code (ID) 00733

...

User-defined Table 0430 - Mode of arrival code

ValueDescription
AAmbulance
CCar
FOn foot
HHelicopter
PPublic Transport
O  Other 
Unknown 

Anchor
PV2-39
PV2-39
2.2.3.39 PV2-39 Recreational drug use code (CE) 01544

...

User-defined Table 0431 - Recreational drug use code

ValueDescription
AAlcohol
KKava
MMarijuana
TTobacco - smoked
CTobacco - chewed
OOther
UUnknown

Anchor
PV2-40
PV2-40
2.2.3.40 PV2-40 Admission level of care code (CE) 01545

...

User-defined Table 0432 - Admission level of care code

ValueDescription
ACAcute
CHChronic
COComatose
CRCritical
IMImproved 
MO Moribund 

Anchor
PV2-41
PV2-41
2.2.3.41 PV2-41 Precaution code (CE) 01546

...

User-defined Table 0433 - Precaution code

ValueDescription
AAggressive
BBlind
CConfused
DDeaf
IOn IV
N"No-code" (i.e. Do not resuscitate)
PParaplegic
OOther
U  Unknown 

Anchor
PV2-42
PV2-42
2.2.3.42 PV2-42 Patient condition code (CE) 01547

...

 User-defined Table 0434 - Patient condition code

ValueDescription
ASatisfactory
CCritical
PPoor
SStable
Other 
Unknown 

Anchor
PV2-43
PV2-43
2.2.3.43 PV2-43 Living will code (IS) 00759

...

User-defined Table 0315 - Living will code

ValueDescription
YYes, patient has a living will
FYes, patient has a living will but it is not on file
NNo, patient does not have a living will and no information was provided
No, patient does not have a living will but information was provided 
Unknown 

Anchor
PV2-44
PV2-44
2.2.3.44 PV2-44 Organ donor code (IS) 00760

...

User-defined Table 0316 - Organ donor code

ValueDescription
YYes, patient is a documented donor and documentation is on file
FYes, patient is a documented donor, but documentation is not on file
NNo, patient has not agreed to be a donor
INo, patient is not a documented donor, but information was provided
RPatient leaves organ donation decision to relatives
PPatient leaves organ donation decision to a specific person
UUnknown 

Anchor
PV2-45
PV2-45
2.2.3.45 PV2-45 Advance directive code (CE) 01548

...

User-defined Table 0435 - Advance directive code

ValueDescription
DNRDo not resuscitate

Anchor
PV2-46
PV2-46
2.2.3.46 PV2-46 Patient status effective date (DT) 01549

...

HL7 Attribute Table - AL1 – Patient allergy information

SEQLENDTOPTRP/#TBL#ITEM#ELEMENT NAME
14†SI †R  00203Set ID - AL1
2250CEO 012700204Allergen Type Code
3250CE  00205Allergen Code/Mnemonic/Description
4250CEO 012800206Allergy Severity Code
515STOY 00207Allergy Reaction Code
6 8DT   00208Identification Date 

†  Typographical error in HL7 V2.4 where the CE data type is incorrect and should be a SI data type of length 4.

...

User-defined Table 0127 - Allergen type

ValueDescription
DADrug allergy
FAFood allergy
MAMiscellaneous allergy
MCMiscellaneous contraindication
EAEnvironmental Allergy
AAAnimal Allergy
PAPlant Allergy
LA Pollen Allergy 
ADAdministrative Alert

Australian Variance to HL7 International.

...

User-defined Table 0128 - Allergy severity

ValueDescription
SVSevere
MOModerate
 MIMild 
 UUnknown 

Anchor
AL1-5
AL1-5
2.2.4.5 AL1-5 Allergy reaction code (ST) 00207

...

HL7 Attribute Table – QRD - Original-Style Query Definition

SEQLENDTOPTRP/# TBL#ITEM #ELEMENT NAME
126TSR  00025Query Date/Time
21IDR 010600026Query Format Code
31IDR 009100027 Query Priority
410STR  00028 Query ID
5IDO  00030 Deferred Response Type
626TSO 010700029Deferred Response Date/Time
710CQR 012600031Quantity Limited Request
8250XCNR 00032 Who Subject Filter
9250CER004800033What Subject Filter
10250CERY 00034What Department Data Code
1120CMOY 00035 What Data Code Value Qual.
121IDO 010800036 Query Results Level


See 5.3 OSQ/OSR- query response for order status (event Q06)  for usage of this segment.

...

Anchor
table0106
table0106

HL7 Table 0106 - Query/response format code

ValueDescription
DResponse is in display format
RResponse is in record-oriented format
TResponse is in tabular format

Anchor
QRD-3
QRD-3
2.2.5.3 QRD-3 Query priority (ID) 00027

...

HL7 Table 0091 - Query priority

ValueDescription
DDeferred
IImmediate

Anchor
QRD-4
QRD-4
2.2.5.
4 QRD-4 Query ID (ST) 00028

...

HL7 Table 0107 - Deferred response type

ValueDescription
BBefore the Date/Time specified
LLater than the Date/Time specified

Anchor
QRD-6
QRD-6
2.2.5.6 QRD-6 Deferred response date/time (TS) 00030

...

HL7 Table 0126 - Quantity limited request

ValueDescription
CH Characters
LILines
PGPages
RDRecords
ZOLocally defined

Anchor
QRD-8
QRD-8
2.2.5.8 QRD-8 Who subject filter (XCN) 00032

...

HL7 Table 0048 - What subject filter

ValueDescription
ADV Advice/diagnosis
ANUNursing unit lookup (returns patients in beds, excluding empty beds)
APN Patient name lookup
APPPhysician lookup
ARN Nursing unit lookup (returns patients in beds, including empty beds)
APMMedical record number query, returns visits for a medical record number
APAAccount number query, return matching visit
CAN Cancel. Used to cancel a query
DEMDemographics
FIN Financial
GIDGenerate new identifier
GOLGoals
MRIMost recent inpatient
MROMost recent outpatient
NCKNetwork clock
NSCNetwork status change
NSTNetwork statistic
ORDOrder
OTHOther
PRB Problems
PROProcedure
RES Result
RARPharmacy administration information
RERPharmacy encoded order information
RDRPharmacy dispense information
RGRPharmacy give information
RORPharmacy prescription information
SALAll schedule related information, including open slots, booked slots, blocked slots
SBKBooked slots on the identified schedule
SBL Blocked slots on the identified schedule
SOFFirst open slot on the identified schedule after the start date/time
SOPOpen slots on the identified schedule
SSATime slots available for a single appointment
SSRTime slots available for a recurring appointment
STAStatus
VXI Vaccine Information
XIDGet cross-referenced identifiers

See the HL7 Implementation Guide for detailed examples of use of various query filter fields.

...

HL7 Table 0108 - Query results level

ValueDescription
OOrder plus order status
RResults without bulk text
SStatus only
TFull results

Anchor
QRF
QRF

2.2.6 QRF - original style query filter segment

...

HL7 Attribute Table – QRF – Original style query filter

SEQLENDTOPTRP/#TBL#ITEM #ELEMENT NAME
120 STR Y  00037 Where Subject Filter
226 TSB  00038When Data Start Date/Time
326TSB  00039When Data End Date/Time
460STOY 00040What User Qualifier
560STOY 00041Other QRY Subject Filter
612IDOY015600042 Which Date/Time Qualifier
712IDOY0157 00043 Which Date/Time Status Qualifier
812ID OY015800044 Date/Time Selection Qualifier
960TQ O  00694 When Quantity/Timing Qualifier
1010NMO  01442Search Confidence Threshold

See 5.3 OSQ/OSR- query response for order status (event Q06)  for usage of this segment.

...

Anchor
table0156
table0156

HL7 Table 0156 - Which date/time qualifier

ValueDescription
ANYAny date/time within a range
COLCollection date/time, equivalent to film or sample collection date/time
ORDOrder date/time
RCTSpecimen receipt date/time, receipt of specimen in filling ancillary (Lab)
REPReport date/time, report date/time at filing ancillary (i.e., Lab)
SCHEDSchedule date/time

 

Anchor
QRF-7
QRF-7
2.2.6.7 QRF-7 Which date/time status qualifier (ID) 00043

...

Anchor
table0157
table0157

HL7 Table 0157 - Which date/time status qualifier

Value Description
ANYAny status
CFNCurrent final value, whether final or corrected
CORCorrected only (no final with corrections)
FINFinal only (no corrections)
PREPreliminary
REPReport completion date/time

Anchor
QRF-8
QRF-8
2.2.6.8 QRF-8 Date/time selection qualifier (ID) 00044

...

Anchor
table0158
table0158

HL7 Table 0158 - Date/time selection qualifier

Value Description
1STFirst value within range
ALLAll values within the range
LSTLast value within the range
REVAll values within the range returned in reverse chronological order (This is the default if not otherwise specified.)

Anchor
QRF-9
QRF-9
2.2.6.9 QRF-9 When quantity/timing qualifier (TQ) 00694

...

  1. The pricing scale that is to be applied to the order  - sent in  PV1-21 Charge Price Indicator.
  2. The person to be billed for the tests. In most cases the patient is responsible for the payment of the request; however if the patient is a child the invoice must be sent to a parent/guardian or other responsible party and this is indicated in the GT1 segment.
  3. For billing applicable to a health fund use the IN1 segment.
  4. For the funding source refer to  PV1-20 Financial Class.