Page Comparison

Table of Contents

Anchor

	2.1MessageControlSegments
	2.1MessageControlSegments

...

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

Anchor

	figure2-1
	figure2-1

Figure 2-1. HL7 message segments

Segment Name	HL7 Section Reference
BHS	2.1.2
BTS	2.1.3
DSC	2.1.4
ERR	2.1.5
FHS	2.1.6
FTS	2.1.7
MSA	2.1.8
MSH	2.1.9

...

The BHS segment defines the start of a batch.

HL7 Attribute Table - BHS – Batch Header

SEQ	LEN	DT	OPT	ITEM #	ELEMENT NAME
1	1	ST	R	00081	Batch Field Separator
2	3	ST	R	00082	Batch Encoding Characters
3	15	ST	O	00083	Batch Sending Application
4	20	ST	O	00084	Batch Sending Facility
5	15	ST	O	00085	Batch Receiving Application
6	20	ST	O	00086	Batch Receiving Facility
7	26	TS	O	00087	Batch Creation Date/Time
8	40	ST	O	00088	Batch Security
9	20	ST	O	00089	Batch Name/ID/Type
10	80	ST	O	00090	Batch Comment
11	20	ST	O	00091	Batch Control ID
12	20	ST	O	00092	Reference Batch Control ID

...

The BTS segment defines the end of a batch.

Anchor
BTS-fd
BTS-fd
2.1.3.0 BTS field definitions

HL7 Attribute Table - BTS – Batch Trailer

SEQ	LEN	DT	OPT	RP/#	ITEM #	ELEMENT NAME
1	10	ST	O		00093	Batch Message Count
2	80	ST	O		00090	Batch Comment
3	100	NM	O	Y	00095	Batch Totals

...

The DSC segment is used in the continuation protocol.

Anchor
DSC-fd
DSC-fd
2.1.4.0 DSC field definitions

...

SEQ	LEN	DT	OPT	RP/#	TBL#	ITEM #	ELEMENT NAME
1	180	ST	O			00014	Continuation Pointer
2	1	ID	O		0398	01354	Continuation Style

...

Definition: Indicates whether this is a fragmented message (see HL7 International Standard Section 2.15.2, "Continuation messages and segments"), or if it is part of an interactive continuation message (see HL7 International Standard Section 5.6.3, "Interactive continuation of response messages").

Refer to HL7 Table 0398 – Continuation style code for valid values.

Anchor

	table0398
	table0398

HL7 Table 0398 - Continuation style code

Value	Description
F	Fragmentation
I	Interactive Continuation

...

The ERR segment is used to add error comments to acknowledgment messages.

HL7 Attribute Table - ERR –Error

...

Definition: This field identifies an erroneous segment in another message. The second component is an index if there is more than one segment of type <segment ID>. For systems that do not use the HL7 Encoding Rules, the data item number may be used for the third component. The fourth component (which references HL7 Table 0357 - Message error condition codes, (as a CE data type) is restricted from having any subcomponents as the subcomponent separator is now the CE’s component separator.

...

The FHS segment is used to head a file as defined in Overview.

HL7 Attribute Table - FHS - File Header

...

The FTS segment defines the end of a file.

HL7 Attribute Table - FTS - File Trailer

...

Definition: This field contains an acknowledgment code, see message processing rules. Refer to HL7 Table 0008 - Acknowledgment code for valid values.

Anchor

	table0008
	table0008

HL7 Table 0008 - Acknowledgment code

Value	Description
AA	Original mode: Application Accept - Enhanced mode: Application acknowledgment: Accept
AE	Original mode: Application Error - Enhanced mode: Application acknowledgment: Error
AR	Original mode: Application Reject - Enhanced mode: Application acknowledgment: Reject
CA	Enhanced mode: Accept acknowledgment: Commit Accept
CE	Enhanced mode: Accept acknowledgment: Commit Error
CR	Enhanced mode: Accept acknowledgment: Commit Reject

...

Definition: This field has been retained for backward compatibility. This field is used only as described above, in the HL7 International Standard Section 2.13.2, “Application (level 7) processing rules, deferred processing two phase reply (original acknowledgment mode only).” Otherwise this field is not used.

Anchor

	table0102
	table0102

HL7 Table 0102 - Delayed acknowledgment type

Value	Description
D	Message received, stored for later processing
F	acknowledgment after processing

...

The Message Error Condition codes are defined by HL7 Table 0357 - Message error condition codes.

Anchor

	table0357
	table0357

HL7 Table 0357 - Message error condition codes

Error Condition Code	Error Condition Text	Description/Comment
Success
0	Message accepted	Success. Optional, as the AA conveys success. Used for systems that must always return a status code.
Errors
100	Segment sequence error	The message segments were not in the proper order, or required segments are missing.
101	Required field missing	A required field is missing from a segment
102	Data type error	The field contained data of the wrong data type, e.g. an NM field contained "FOO".
103	Table value not found	A field of data type ID or IS was compared against the corresponding table, and no match was found.
Rejection
200	Unsupported message type	The Message Type is not supported.
201	Unsupported event code	The Event Code is not supported.
202	Unsupported processing id	The Processing ID is not supported.
203	Unsupported version id	The Version ID is not supported.
204	Unknown key identifier	The ID of the patient, order, etc., was not found. Used for transactions other than additions, e.g. transfer of a non-existent patient.
205	Duplicate key identifier	The 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.

...

The MSH segment defines the intent, source, destination, and some specifics of the syntax of a message.

HL7 Attribute Table - MSH - Message Header

...

Definition: This field uniquely identifies the sending application among all other applications within the network enterprise. The network enterprise consists of all those applications that participate in the exchange of HL7 messages within the enterprise. Entirely site-defined.

User-defined Table 0361-Sending/receiving application is used as the user-defined table of values for the first component.

Anchor

	table0361
	table0361

User-defined Table 0361 – Sending/receiving application

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

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

Anchor
MSH-4
MSH-4
2.1.9.4 MSH-4 Sending facility (HD) 00004

...

Definition: This field further describes the sending application, MSH-3-sending application . With the promotion of this field to an HD data type, the usage has been broadened to include not just the sending facility but other organizational entities such as a) the organizational entity responsible for sending application; b) the responsible unit; c) a product or vendor’s identifier, etc. Entirely site-defined.

User-defined Table 0362 - Sending/receiving facility is used as the HL7 identifier for the user-defined table of values for the first component.

Anchor

	table0362
	table0362

User-defined Table 0362 – Sending/receiving facility

Value	Description
Buderim GE Centre^7C3E3681-91F6-11D2-8F2C-444553540000^GUID	Example sending facility identified with GUID
QML^2184^AUSNATA	Lab 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.

...

Definition: This field is used to decide whether to process the message as defined in HL7 Application (level 7) Processing rules. The first component defines whether the message is part of a production, training, or debugging system (refer to HL7 Table 0103 - Processing ID for valid values). The second component defines whether the message is part of an archival process or an initial load (refer to HL7 Table 0207 - Processing mode for valid values). This allows different priorities to be given to different processing modes. The value used in normal usage is highlighted in blue.

Anchor

	table0103
	table0103

HL7 Table 0103 - Processing ID

Value	Description
D	Debugging
P	Production
T	Training

Anchor

	table0207
	table0207

HL7 Table 0207 - Processing mode

Value	Description
A	Archive
R	Restore from archive
I	Initial load
T	Current processing, transmitted at intervals (scheduled or on demand)
Not present	Not present (the default, meaning current processing)

...

Definition: This field is matched by the receiving system to its own version to be sure the message will be interpreted correctly. Beginning with Version 2.3.1, it has two additional “internationalization” components, for use by HL7 international affiliates. The <internationalization code> is CE data type (using the ISO country codes where appropriate) which represents the HL7 affiliate. The <internal version ID> is used if the HL7 Affiliate has more than a single ‘local’ version associated with a single US version. The <internal version ID> has a CE data type, since the table values vary for each HL7 Affiliate.

Anchor

	table0104
	table0104

HL7 Table 0104 —Version ID

Value	Description
~~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

...

These are identifiers and they are not intended to be parsed.

HL7 Table 01043—Internal Version ID

Internal version ID value	Description of use	Profile URI for use in FHIR Provider Directory
HL7AU-OO-ORM-201701	ORM Order messages based on this specification	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-ORM-201701
HL7AU-OO-ORU-201701	ORU messages based on this specification	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-ORU-201701
HL7AU-OO-ACK-201701	ACK^R01, ACK^O01 acknowledgement messages ACK messages where the message type is ACK and structure is a generic ACK. The trigger event may vary.	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-ACK-201701
HL7AU-OO-ORR-201701	Order Response messages	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-ORR-201701
HL7AU-OO-ACK-READ-202001	Application read acknowledgements (See 8.4 User Read Acknowledgements)	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-ACK-READ-202001
HL7AU-OO-REF-SIMPLIFIED-201706-L1	Simplified Referral Level 1 REF messages (See A8.2.1.1 Referral Level 1)	http://ns.hl7.org.au/hl7v2/profiles/`HL7AU-OO-REF-SIMPLIFIED-201706-L1`
HL7AU-OO-REF-SIMPLIFIED-201706	*Simplified Referral Level 2 REF messages (See A8.2.1.2 Referral Level 2)	http://ns.hl7.org.au/hl7v2/profiles/`HL7AU-OO-REF-SIMPLIFIED-201706`
HL7AU-OO-REF-SIMPLIFIED-201706	*For RRI message application acknowledgements	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706/RRI
HL7AU-OO-OSQ-202001	Query for order status. See Section 5.3.	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-OSQ-202001
HL7AU-OO-OSR-202001	Query response for order status. See Section 5.3.	http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-OSR-202001

...

Definition: This field identifies the conditions under which accept acknowledgments are required to be returned in response to this message. Required for enhanced acknowledgment mode. Refer to HL7 Table 0155 - Accept/application acknowledgment conditions for valid values.

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

...

The following table contains the possible values for MSH-15-accept acknowledgment type and MSH-16- application acknowledgment type:

Anchor

	table0155
	table0155

HL7 Table 0155 - Accept/application acknowledgment conditions

Value	Description
AL	Always
NE	Never
ER	Error/reject conditions only
SU	Successful completion only

...

^{2 Available from ISO 1 Rue de Varembe, Case Postale 56, CH 1211, Geneve, Switzerland}

Refer to HL7 Table 0399 - Country code for the 3-character codes as defined by ISO 3166 table.

Anchor

	table0399
	table0399

HL7 Table 0399 – Country code

Value	Description
ABW	ARUBA
AFG	AFGHANISTAN
AFT	FRENCH SOUTHERN TERRITORIES
AGO	ANGOLA
AIA	ANGUILLA
ALB	ALBANIA
AND	ANDORRA
ANT	NETHERLANDS ANTILLES
ARE	UNITED ARAB EMIRATES
ARG	ARGENTINA
ARM	ARMENIA
ASM	AMERICAN SAMOA
ATA	ANTARCTICA
ATG	ANTIGUA AND BARBUDA
AUS	AUSTRALIA
AUT	AUSTRIA
AZE	AZERBAIJAN
BDI	BURUNDI
BEL	BELGIUM
BEN	BENIN
BFA	BURKINA FASO
BGD	BANGLADESH
BGR	BULGARIA
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
BVT	BOUVET ISLAND
BWA	BOTSWANA
CAF	CENTRAL 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
DJI	DJIBOUTI
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
FSM	MICRONESIA, 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
GRL	GREENLAND
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
KHM	CAMBODIA
KIR	KIRIBATI
KNA	SAINT KITTS AND NEVIS
KOR	KOREA, REPUBLIC OF
KWT	KUWAIT
LAO	LAO 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
NAM	NAMIBIA
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
PYF	FRENCH POLYNESIA
QAT	QATAR
REU	REUNION
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
SOM	SOMALIA
SPM	SAINT PIERRE AND MIQUELON
STP	SAO TOME AND PRINCIPE
SUR	SURINAME
SVK	SLOVAKIA
SVN	SLOVENIA
SWE	SWEDEN
SWZ	SWAZILAND
SYC	SEYCHELLES
SYR	SYRIAN ARAB REPUBLIC
TCA	TURKS 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
TUR	TURKEY
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

...

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" must be used (unvalued implies "ASCII"). "UNICODE UTF-8" and "8859/1" messages should only be used by specific agreement.

The International standard allows repeats of this field, but this standard has constrained it to a single character set for the entire message.

Anchor

	table0211
	table0211

HL7 Table 0211 - Alternate character sets

Value	Description	Comment
ASCII	The printable 7-bit ASCII character set.	(This is the default if this field is omitted)
8859/1	The printable characters from the ISO 8859/1 Character set
~~8859/2~~	~~The printable characters from the ISO 8859/2 Character set~~
~~8859/3~~	~~The printable characters from the ISO 8859/3 Character set~~
~~8859/4~~	~~The printable characters from the ISO 8859/4 Character set~~
~~8859/5~~	~~The printable characters from the ISO 8859/5 Character set~~
~~8859/6~~	~~The printable characters from the ISO 8859/6 Character set~~
~~8859/7~~	~~The printable characters from the ISO 8859/7 Character set~~
~~8859/8~~	~~The 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.
UNICODE UTF-8	^†UCS 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.}

Note: The field separator character must still be chosen from the printable 7-bit ASCII character set.

...

The field MSH-18-character set is an optional, repeating field of data type ID, using IDs outlined in HL7 Table 0211 - Alternate character sets (or equivalents from "ISO 2375").

...

Definition: When any alternative character sets are used (as specified in the second or later components of MSH-18 character sets), and if any special handling scheme is needed, this component is to specify the scheme used, according to HL7 Table 0356- Alternate character set handling scheme as defined below:

Anchor

	table0356
	table0356

HL7 Table 0356 - Alternate character set handling scheme

Value	Description
~~ISO 2022-1994~~	This 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.3~~	The 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.

...

Values for HL7-standard conformance statements appear in HL7 Table 0449 - Conformance statements as defined below.

Anchor

	table0449
	table0449

HL7 Table 0449 - Conformance statements

Value	Description
HL7AUSD-STD-OO-ADRM-2021.1	Australian Diagnostics and Referral Messaging Localisation of HL7 Version 2.4 (2021.1)
HL7AUSD-STD-OO-ADRM-2018.1	Australian Diagnostics and Referral Messaging Localisation of HL7 Version 2.4 (2018.1)
HL7AUSD-STD-OO-ADRM-2017.1	Australian Pathology Messaging Localisation of HL7 Version 2.4 Standard (2017.1)
	Values here are by site negotiation.

...

With HL7 V2.3, the nomenclature for the fourth component of the patient identifiers was changed from "assigning facility ID" to "assigning authority". While the identifier may be unique to a given healthcare facility (for example, a medical record assigned by facility A in Hospital XYZ), the identifier might also be assigned at a system level (for example a corporate person index or enterprise number spanning multiple facilities) or by a government entity, for example a nationally assigned unique individual identifier. While a facility is usually an assigning authority, not all assigning authorities are facilities. Therefore, the fourth component is referred to as an assigning authority, but retains backward compatibility using the construct of the HD data type (see the note in section 2.8.18). Additionally, CX data types support the use of assigning facility (HD) as the sixth component.

HL7 Attribute Table – PID – Patient identification

...

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 unique.

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

...

Definition: This field contains the names of the patient, the primary or legal name of the patient is reported first. Therefore, the name type code in this field should be "L - Legal". Refer to HL7 Table 0200 - Name type for valid values. Repetition of this field is allowed for representing the same name in different character sets. Note that "last name prefix" is synonymous to "own family name prefix" of previous versions of HL7, as is "second and further given names or initials thereof" to "middle initial or name". Multiple given names and/or initials are separated by spaces.

Anchor

	table0200
	table0200

HL7 Table 0200 - Name type

Value	Description
A	Alias Name
B	Name at Birth
C	Adopted Name
D	Display Name
I	Licensing Name
L	Legal Name
M	Maiden Name
N	Nickname /"Call me" Name/Street Name
P	Name of Partner/Spouse (retained for backward compatibility only)
R	Registered Name (animals only)
S	Coded Pseudo-Name to ensure anonymity
T	Indigenous/Tribal/Community Name
U	Unspecified

...

Definition: This field contains the mailing address of the patient. Address type codes are defined by HL7 Table 0190 - Address type. Multiple addresses for the same person may be sent in the following sequence: The primary mailing address must be sent first in the sequence (for backward compatibility); if the mailing address is not sent, then a repeat delimiter must be sent in the first sequence.

Anchor

	table0190
	table0190

HL7 Table 0190 - Address Type

Example field: PID-11 Patient address

...

Definition: This field contains the patient’s primary language. HL7 recommends using ISO table 639 as the suggested values in User-defined Table 0296 - Primary Language.

Anchor

	table0296
	table0296

User-defined Table 0296 - Primary language

Value	Description
	No suggested values defined

...

Definition: This field contains the patient’s marital (civil) status.

Refer to User-defined Table 0002 - Marital status for the HL7 values that are to be used in this data field.

...

Definition: This field contains the patient’s religion, for example, Baptist, Catholic, Methodist, etc. Refer to User-defined Table 0006 - Religion for suggested values.

Anchor
PID-18
PID-18
2.2.1.18 PID-18 Patient account number (CX) 00121

...

Definition: This field contains the patient account number assigned by accounting to which all charges, payments, etc., are recorded. It is used to identify the patient’s account. Refer to HL7 Table 0061 - Check digit scheme for valid values.

Note: If an account number is used for patient identification, report in PID-3 with a patient identifier type code of 'AN'.

...

Anchor
PID-26
PID-26
2.2.1.26 PID-26 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

Value	Description
No suggested values defined

Anchor
PID-27
PID-27
2.2.1.27 PID-27 Veterans military status (CE) 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: 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

...

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

Value	Description
US	Unknown/Default Social Security Number
UD	Unknown/Default Date of Birth
UA	Unknown/Default Address
AL	Patient/Person Name is an Alias

...

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

Value	Description
	No suggested values defined

...

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

Value	Description
	No suggested values defined

...

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

Anchor

	table0429
	table0429

User-defined Table 0429 - Production class Code

Value	Description
BR	Breeding/genetic stock
DA	Dairy
DR	Draft
DU	Dual Purpose
LY	Layer, Includes Multiplier flocks
MT	Meat
OT	Other
PL	Pleasure
RA	Racing
SH	Show
NA	Not Applicable
U	Unknown

...

The facility ID, the optional fourth component of each patient location field, is a HD data type that is uniquely associated with the healthcare facility containing the location. A given institution, or group of intercommunicating institutions, should establish a list of facilities that may be potential assignors of patient locations. The list will be one of the institution’s master dictionary lists. Since third parties other than the assignors of patient locations may send or receive HL7 messages containing patient locations, the facility ID in the patient location may not be the same as that implied by the sending and receiving systems identified in the MSH. The facility ID must be unique across facilities at a given site. This field is required for HL7 implementations that have more than a single healthcare facility with bed locations, since the same <point of care> ^ <room> ^ <bed> combination may exist at more than one facility.

HL7 Attribute Table - PV1 – Patient visit

...

Definition: This field is used by systems to categorize patients by site. It does not have a consistent industry-wide definition. It is subject to site-specific variations. Refer to User-defined Table 0004 - Patient class for suggested values.

Anchor

	table0004
	table0004

User-defined Table 0004 - Patient class

Value	Description
E	Emergency
I	Inpatient
O	Outpatient
P	Preadmit
S†	Same day patient
Y†	Community client
R	Recurring patient
B	Obstetrics
C	Commercial Account
N	Not Applicable
U	Unknown

...

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.

Anchor

	table0007
	table0007

User-defined Table 0007 - Admission type

Value	Description
A	Accident
C	Elective
E	Emergency
G	Geriatric respite admission
L	Labor and Delivery
N	Newborn (Birth in healthcare facility)
R	Routine
S	Statistical admission
U	Urgent

...

Definition: This field contains the attending physician information. Multiple names and identifiers for the same physician may be sent. The field sequences are not used to indicate multiple attending doctors. The legal name must be sent in the first sequence. If the legal name is not sent, then a repeat delimiter must be sent in the first sequence. Depending on local agreements, either ID or the name may be absent in this field. Refer to User-defined Table 0010 - Physician ID for suggested values.

In the Australian context, where possible, this XCN data must be populated using the method described in A10.1.2.1 XCN Datatype.

Anchor

	table0010
	table0010

User-defined Table 0010 - Physician ID

Value	Description
	No suggested values defined

...

Definition: This field contains the referring physician information. Multiple names and identifiers for the same physician may be sent. The field sequences are not used to indicate multiple referring doctors. The legal name must be sent in the first sequence. If the legal name is not sent, then a repeat delimiter must be sent in the first sequence. Depending on local agreements, either the ID or the name may be absent from this field. Refer to User-defined Table 0010 - Physician ID for suggested values.

In the Australian context, where possible, this XCN data must be populated using the method described in A10.1.2.1 XCN Datatype.

...

Definition: This field contains the treatment or type of surgery that the patient is scheduled to receive. It is a required field with trigger events A01 (admit/visit notification), A02 (transfer a patient), A14 (pending admit), A15 (pending transfer). Refer to User-defined Table 0069 - Hospital service for suggested values.

Anchor

	table0069
	table0069

User-defined Table 0069 - Hospital service

Values	Description
MED	Medical Service
SUR	Surgical Service
URO	Urology Service
PUL	Pulmonary Service
CAR	Cardiac Service

...

Definition: This field indicates whether the patient must have pre-admission testing done in order to be admitted. Refer to User-defined Table 0087 - Pre-admit test indicator for suggested values.

Anchor

	table0087
	table0087

User-defined Table 0087 - Pre-admit test indicator

Value	Description
	No suggested values defined

...

Definition: This field indicates that a patient is being re-admitted to the healthcare facility and gives the circumstances. We suggest using "R" for readmission or else null. Refer to User-defined Table 0092 - Re-admission indicator for suggested values.

Anchor

	table0092
	table0092

User-defined Table 0092 - Re-admission indicator

Value	Description
R	Re-admission

...

Definition: This field indicates where the patient was admitted. Refer to User-defined Table 0023 - Admit source for suggested values. In the US, this field is used on UB92 FL20 "Source of Admission".

...

Note: The official title of UB is "National Uniform Billing Data Element Specifications." Most of the codes added came from the UB-92 specification, but some came from the UB-82.

Anchor

	table0023
	table0023

User-defined Table 0023 - Admit source

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

...

Definition: This field indicates any permanent or transient handicapped conditions. Refer to User defined Table 0009 - Ambulatory status for suggested entries.

Anchor

	table0009
	table0009

User-defined Table 0009 - Ambulatory status

Value	Description
A0	No functional limitations
A1	Ambulates with assistive device
A2	Wheelchair/stretcher bound
A3	Comatose; non-responsive
A4	Disoriented
A5	Vision impaired
A6	Hearing impaired
A7	Speech impaired
A8	Non-English speaking
A9	Functional level unknown
B1	Oxygen therapy
B2	Special equipment (tubes, IVs, catheters)
B3	Amputee
B4	Mastectomy
B5	Paraplegic
B6	Pregnant

...

Definition: This field identifies the type of VIP. Refer to User-defined Table 0099 - VIP indicator for suggested values.

Anchor

	table0099
	table0099

User-defined Table 0099 - VIP indicator

Value	Description
V1	No suggested values defined

...

Definition: This field contains site-specific values that identify the patient type. Refer to User-defined Table 0018 - Patient type for suggested values.

Anchor

	table0018
	table0018

User-defined Table 0018 - Patient type

Value	Description
	No suggested values defined

...

Definition: This field contains the financial class(es) assigned to the patient for the purpose of identifying sources of reimbursement. Refer to User-defined Table 0064 - Financial class for suggested values.

Anchor

	table0064
	table0064

User-defined Table 0064 - Financial class

METeOR 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

...

Definition: This field contains the code used to determine which price schedule is to be used for room and bed charges. Refer to User-defined Table 0032 - Charge/price indicator.

Anchor

	table0032
	table0032

User-defined Table 0032 - Charge/price indicator

Value	Description
AUSM85	85% of Medicare schedule fee
AUSM75	75% of Medicare schedule fee
AUSM100	Medicare schedule fee
AUSAMA	Australian Medical Association recommended fee

...

Definition: This field indicates whether the patient will be extended certain special courtesies. Refer to User-defined Table 0045 - Courtesy code for suggested values.

Anchor

	table0045
	table0045

User-defined Table 0045 - Courtesy code

In the Australian context the recommended values are:

...

Definition: This field contains the user-defined code to determine past credit experience. Refer to User defined Table 0046 - Credit rating for suggested values.

Anchor

	table0046
	table0046

User-defined Table 0046 - Credit rating

In the Australian context users may define their own table values:

...

Definition: This field identifies the type of contract entered into by the healthcare facility and the guarantor for the purpose of settling outstanding account balances. Refer to User-defined Table 0044 - Contract code for suggested values.

Anchor

	table0044
	table0044

User-defined Table 0044 - Contract code

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

...

Definition: This field indicates the amount of interest that will be charged the guarantor on any outstanding amounts. Refer to User-defined Table 0073 - Interest rate code for suggested values.

Anchor

	table0073
	table0073

User-defined Table 0073 - Interest rate code

Value	Description
	No suggested values defined

...

Definition: This field indicates that the account was transferred to bad debts and gives the reason. Refer to User-defined Table 0110 - Transfer to bad debt code for suggested values.

Anchor

	table0110
	table0110

User-defined Table 0110 - Transfer to bad debt code

In the Australian context reason for bad debt include:

...

Definition: This field can be used as a ST type for backward compatibility . This field uniquely identifies the bad debt agency to which the account was transferred. This code is site defined. One possible implementation would be to edit against a table such as User-defined Table 0021 - Bad debt agency code; however, this is not required.

Anchor

	table0021
	table0021

User-defined Table 0021 - Bad debt agency code

Value	Description
	No suggested values defined

...

Definition: This field indicates that the account was deleted from the file and gives the reason. Refer to User-defined Table 0111 - Delete account code for suggested values.

Anchor

	table0111
	table0111

User-defined Table 0111 - Delete account code

Value	Description
	No suggested values defined

...

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.

Anchor

	table0112
	table0112

User-defined Table 0112 - Discharge disposition

Value	Description
01	Discharged to home or self care (routine discharge)
02	Discharged/transferred to another short term general hospital for inpatient care
03	Discharged/transferred to skilled nursing facility (SNF)
04	Discharged/transferred to an intermediate care facility (ICF)
05	Discharged/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
08	Discharged/transferred to home under care of Home IV provider
09	Admitted 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

...

Definition: This field indicates the healthcare facility to which the patient was discharged. Refer to User defined Table 0113 - Discharged to location for suggested values.

Anchor

	table0113
	table0113

User-defined Table 0113 - Discharged to location

Value	Description
	No suggested values defined

...

Definition: This field indicates a special diet type for a patient. Refer to User-defined Table 0114 - Diet type for suggested values.

Anchor

	table0114
	table0114

User-defined Table 0114 - Diet type

Value	Description
	No suggested values defined

...

Definition: This field is used in a multiple facility environment to indicate the healthcare facility with which this visit is associated. Refer to User-defined Table 0115 - Servicing facility for suggested values.

Anchor

	table0115
	table0115

User-defined Table 0115 - Servicing facility

Value	Description
	No suggested values defined

...

Definition: This field has been retained for backward compatibility only. The information is now held in the fifth component of the PL datatype in PV1-3. This field contains the status of the bed. Refer to User-defined Table 0116 - Bed status for suggested values.

Anchor

	table0116
	table0116

User-defined Table 0116 - Bed status

Value	Description
C	Closed
H	Housekeeping
O	Occupied
U	Unoccupied
K	Contaminated
I	Isolated

...

Definition: This field contains the account status. Refer to User-defined Table 0117 - Account status for suggested values.

Anchor

	table0117
	table0117

User-defined Table 0117 - Account status

Value	Description
	No suggested values defined

...

Definition: This field specifies the level on which data are being sent. It is the indicator used to send data at two levels, visit and account. HL7 recommends sending an ‘A’ or no value when the data in the message are at the account level, or ‘V’ to indicate that the data sent in the message are at the visit level. Refer to User-defined Table 0326 - Visit indicator for suggested values.

The value of this element affects the context of data sent in PV1, PV2 and any associated hierarchical segments (e.g. DB1, AL1, DG1, etc.).

Anchor

	table0326
	table0326

User-defined Table 0326 - Visit indicator

Value	Description
A	Account level (default)
V	Visit level

...

The PV2 segment is a continuation of information contained on the PV1 segment.

HL7 Attribute Table - PV2 – Patient visit – additional information

SEQ	LEN	DT	OPT	RP/#	TBL#	ITEM#	ELEMENT NAME
1	80	PL	C			00181	Prior Pending Location
2	250	CE	O		0129	00182	Accommodation Code
3	250	CE	O			00183	Admit Reason
4	250	CE	O			00184	Transfer Reason
5	25	ST	O	Y		00185	Patient Valuables
6	25	ST	O			00186	Patient Valuables Location
7	2	IS	O	Y	0130	00187	Visit User Code
8	26	TS	O			00188	Expected Admit Date/Time
9	26	TS	O			00189	Expected Discharge Date/Time
10	3	NM	O			00711	Estimated Length of Inpatient Stay
11	3	NM	O			00712	Actual Length of Inpatient Stay
12	50	ST	O			00713	Visit Description
13	250	XCN	O	†		00714	Referral Source Code
14	8	DT	O			00715	Previous Service Date
15	1	ID	O		0136	00716	Employment Illness Related Indicator
16	1	IS	O		0213	00717	Purge Status Code
17	8	DT	O			00718	Purge Status Date
18	2	IS	O		0214	00719	Special Program Code
19	1	ID	O		0136	00720	Retention Indicator
20	1	NM	O			00721	Expected Number of Insurance Plans
21	1	IS	O		0215	00722	Visit Publicity Code
22	1	ID	O		0136	00723	Visit Protection Indicator
23	250	XON	O	Y		00724	Clinic Organization Name
24	2	IS	O		0216	00725	Patient Status Code
25	1	IS	O		0217	00726	Visit Priority Code
26	8	DT	O			00727	Previous Treatment Date
27	2	IS	O		0112	00728	Expected Discharge Disposition
28	8	DT	O			00729	Signature on File Date
29	8	DT	O			00730	First Similar Illness Date
30	250	CE	O		0218	00731	Patient Charge Adjustment Code
31	2	IS	O		0219	00732	Recurring Service Code
32	1	ID	O		0136	00733	Billing Media Code
33	26	TS	O			00734	Expected Surgery Date and Time
34	1	ID	O		0136	00735	Military Partnership Code
35	1	ID	O		0136	00736	Military Non-Availability Code
36	1	ID	O		0136	00737	Newborn Baby Indicator
37	1	ID	O		0136	00738	Baby Detained Indicator
38	250	CE	O		0430	01543	Mode of Arrival Code
39	250	CE		Y	0431	01544	Recreational Drug Use Code
40	250	CE	O		0432	01545	Admission Level of Care Code
41	250	CE	O	Y	0433	01546	Precaution Code
42	250	CE	O		0434	01547	Patient Condition Code
43	2	IS	O		0315	00759	Living Will Code
44	2	IS	O		0316	00760	Organ Donor Code
45	250	CE	O	Y	0435	01548	Advance Directive Code
46	8	DT	O			01549	Patient Status Effective Date
47	26	TS	C			01550	Expected LOA Return Date/Time

...

Definition: This field indicates the specific patient accommodations for this visit. Refer to User-defined Table 0129 - Accommodation code for suggested values.

Anchor

	table0129
	table0129

User-defined Table 0129 - Accommodation code

Value	Description
	No suggested values defined

...

Definition: This field further categorizes a patient’s visit with respect to an individual institution’s needs, and is expected to be site-specific. Refer to User-defined Table 0130 - Visit user code for suggested values.

Anchor

	table0130
	table0130

User-defined Table 0130 - Visit user code

Value	Description
TE	Teaching
HO	Home
MO	Mobile Unit
PH	Phone

...

Definition: This field contains the purge status code for the account. It is used by the application program to determine purge processing. Refer to User-defined Table 0213 - Purge status code for suggested values.

Anchor

	table0213
	table0213

User-defined Table 0213 - Purge status code

Value	Description
P	Marked for purge. User is no longer able to update the visit.
D	The visit is marked for deletion and the user cannot enter new data against it.
I	The visit is marked inactive and the user cannot enter new data against it.

...

Definition: This field designates the specific health insurance program for a visit required for healthcare reimbursement. Examples include Child Health Assistance, Elective Surgery Program, Family Planning, etc. Refer to User-defined Table 0214 - Special program codes for suggested values.

Anchor

	table0214
	table0214

User-defined Table 0214 – Special program codes

Value	Description
	No suggested values

...

Definition: This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for a specific visit. Refer to User-defined Table 0215 - Publicity code for suggested values. Refer to PD1-11 - publicity code for the patient level publicity code.

Anchor

	table0215
	table0215

User-defined Table 0215 - Publicity code

Value	Description
	No suggested values

...

Definition: This field indicates the status of the episode of care: for instance, Active Inpatient, Discharged Inpatient. Refer to User-defined Table 0216 - Patient status for suggested values.

Anchor

	table0216
	table0216

User-defined Table 0216 – Patient status

Value	Description
	No suggested values defined

...

Definition: This field contains the priority of the visit. Refer to User-defined Table 0217 - Visit priority code for suggested values.

Anchor

	table0217
	table0217

User-defined Table 0217 - Visit priority code

Value	Description
1	Emergency
2	Urgent
3	Elective

...

Definition: This field describes what the patient’s disposition is expected to be at the end of the visit. Refer to User-defined Table 0112 - Discharge disposition for suggested values.

Anchor

	table0112
	table0112

User-defined Table 0112 - Discharge disposition

Value	Description
01	Discharged to home or self care (routine discharge)
02	Discharged/transferred to another short term general hospital for inpatient care
03	Discharged/transferred to skilled nursing facility (SNF)
04	Discharged/transferred to an intermediate care facility (ICF)
05	Discharged/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
08	Discharged/transferred to home under care of Home IV provider
09	Admitted 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

...

Definition: This field contains a user-defined code that indicates which adjustments should be made to this patient’s charges. Refer to User-defined Table 0218 - Charge adjustment for suggested values. This field is the same as GT1-26 - guarantor charge adjustment code .

...

Definition: This field indicates whether the treatment is continuous. Refer to User-defined Table 0219 - Recurring service for suggested values.

Anchor

	table0219
	table0219

User-defined Table 0219 – Recurring service

Value	Description
	No selected values

...

Definition: Identifies how the patient was brought to the healthcare facility. Refer to User-defined Table 0430 - Mode of arrival code for suggested values.

Anchor

	table0430
	table0430

User-defined Table 0430 - Mode of arrival code

Value	Description
A	Ambulance
C	Car
F	On foot
H	Helicopter
P	Public Transport
O	Other
U	Unknown

...

Definition: This field indicates what recreational drugs the patient uses. It is used for the purpose of room assignment. Refer to User-defined Table 0431 - Recreational drug use codefor suggested values.

Anchor

	table0431
	table0431

User-defined Table 0431 - Recreational drug use code

Value	Description
A	Alcohol
K	Kava
M	Marijuana
T	Tobacco - smoked
C	Tobacco - chewed
O	Other
U	Unknown

...

Definition: This field indicates the acuity level assigned to the patient at the time of admission. Refer to User-defined Table 0432 - Admission level of care code for suggested values.

Anchor

	table0432
	table0432

User-defined Table 0432 - Admission level of care code

Value	Description
AC	Acute
CH	Chronic
CO	Comatose
CR	Critical
IM	Improved
MO	Moribund

...

Definition: This field indicates non-clinical precautions that need to be taken with the patient. Refer to User-defined Table 0433 - Precaution code for suggested values.

Anchor

	table0433
	table0433

User-defined Table 0433 - Precaution code

Value	Description
A	Aggressive
B	Blind
C	Confused
D	Deaf
I	On IV
N	"No-code" (i.e. Do not resuscitate)
P	Paraplegic
O	Other
U	Unknown

...

Definition: This field indicates the patient’s current medical condition for the purpose of communicating to non-medical outside parties, e.g. family, employer, religious minister, media, etc,. Refer to User-defined Table 0434 - Patient condition code for suggested values.

Anchor

	table0434
	table0434

User-defined Table 0434 - Patient condition code

Value	Description
A	Satisfactory
C	Critical
P	Poor
S	Stable
O	Other
U	Unknown

...

Definition: This field indicates whether or not the patient has a living will and, if so, whether a copy of the living will is on file at the healthcare facility. If the patient does not have a living will, the value of this field indicates whether the patient was provided information on living wills. Refer to User-defined Table 0315 - Living will code for suggested values. See also PD1-7 - Living will code.

Anchor

	table0315
	table0315

User-defined Table 0315 - Living will code

Value	Description
Y	Yes, patient has a living will
F	Yes, patient has a living will but it is not on file
N	No, patient does not have a living will and no information was provided
I	No, patient does not have a living will but information was provided
U	Unknown

...

Definition: This field indicate whether the patient wants to donate his/her organs and whether an organ donor card or similar documentation is on file with the healthcare organization. Refer to User-defined Table 0316 - Organ donor code for suggested values. See also PD1-8 - Organ donor.

Anchor

	table0316
	table0316

User-defined Table 0316 - Organ donor code

Value	Description
Y	Yes, patient is a documented donor and documentation is on file
F	Yes, patient is a documented donor, but documentation is not on file
N	No, patient has not agreed to be a donor
I	No, patient is not a documented donor, but information was provided
R	Patient leaves organ donation decision to relatives
P	Patient leaves organ donation decision to a specific person
U	Unknown

...

Definition: This field indicates the patient’s instructions to the healthcare facility. Refer to User-defined Table 0435 - Advance directive code for suggested values. See also PD1-15 - Advance directive code.

Anchor

	table0435
	table0435

User-defined Table 0435 - Advance directive code

Value	Description
DNR	Do not resuscitate

...

The AL1 segment contains patient allergy information of various types. Most of this information will be derived from user-defined tables. Each AL1 segment describes a single patient allergy.

HL7 Attribute Table - AL1 – Patient allergy information

SEQ	LEN	DT	OPT	RP/#	TBL#	ITEM#	ELEMENT NAME
1	4†	SI †	R			00203	Set ID - AL1
2	250	CE	O		0127	00204	Allergen Type Code
3	250	CE	R			00205	Allergen Code/Mnemonic/Description
4	250	CE	O		0128	00206	Allergy Severity Code
5	250	ST	O	Y		00207	Allergy Reaction Code
6	8	DT	B			00208	Identification Date

...

Definition: This field indicates a general allergy category (drug, food, pollen, etc.). Refer to User-defined Table 0127 - Allergen type for suggested values.

Anchor

	table0127
	table0127

User-defined Table 0127 - Allergen type

Value	Description
DA	Drug allergy
FA	Food allergy
MA	Miscellaneous allergy
MC	Miscellaneous contraindication
EA	Environmental Allergy
AA	Animal Allergy
PA	Plant Allergy
LA	Pollen Allergy
AD	Administrative Alert^†

...

Definition: This field indicates the general severity of the allergy. Refer to User-defined Table 0128 - Allergy severity for suggested values.

Anchor

	table0128
	table0128

User-defined Table 0128 - Allergy severity

Value	Description
SV	Severe
MO	Moderate
MI	Mild
U	Unknown

...

The QRD segment is used to define a query.

HL7 Attribute Table – QRD - Original-Style Query Definition

SEQ	LEN	DT	OPT	RP/#	TBL#	ITEM #	ELEMENT NAME
1	26	TS	R			00025	Query Date/Time
2	1	ID	R		0106	00026	Query Format Code
3	1	ID	R		0091	00027	Query Priority
4	10	ST	R			00028	Query ID
5	1	ID	O			00030	Deferred Response Type
6	26	TS	O		0107	00029	Deferred Response Date/Time
7	10	CQ	R		0126	00031	Quantity Limited Request
8	250	XCN	R	Y		00032	Who Subject Filter
9	250	CE	R	Y	0048	00033	What Subject Filter
10	250	CE	R	Y		00034	What Department Data Code
11	20	CM	O	Y		00035	What Data Code Value Qual.
12	1	ID	O		0108	00036	Query Results Level

...

Definition: This field refers to HL7 Table 0106 - Query/response format code for valid values.

Anchor

	table0106
	table0106

HL7 Table 0106 - Query/response format code
Value Description
D Response is in display format
R Response is in record-oriented format
T Response is in tabular format
...
Definition: This field contains the time frame in which the response is expected. Refer HL7 Table 0091 - Query priority for valid values. Table values and subsequent fields specify time frames for response.
Anchor
table0091
table0091
HL7 Table 0091 - Query priority
Value Description
D Deferred
I Immediate
...
Definition: This field refers to HL7 Table 0107 - Deferred response type for valid entries.

Anchor
table0107
table0107
HL7 Table 0107 - Deferred response type
Value Description
B Before the Date/Time specified
L Later than the Date/Time specified
...
Components: <quantity (NM)> ^ <units (CE)>
Definition: This field contains the maximum length of the response that can be accepted by the requesting system. Valid responses are numerical values (in the first component) given in the units specified in the second component. Refer to HL7 Table 0126 - Quantity limited request for valid entries for the second component. Default is LI (lines).
Anchor
table0126
table0126

HL7 Table 0126 - Quantity limited request
Value Description
CH Characters
LI Lines
PG Pages
RD Records
ZO Locally defined
...
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 describes the kind of information that is required to satisfy the request. Valid values define the type of transaction inquiry and may be extended locally during implementation.
Anchor
table0048
table0048
HL7 Table 0048 - What subject filter
Value Description
ADV Advice/diagnosis
ANU Nursing unit lookup (returns patients in beds, excluding empty beds)
APN Patient name lookup
APP Physician lookup
ARN Nursing unit lookup (returns patients in beds, including empty beds)
APM Medical record number query, returns visits for a medical record number
APA Account number query, return matching visit
CAN Cancel. Used to cancel a query
DEM Demographics
FIN Financial
GID Generate new identifier
GOL Goals
MRI Most recent inpatient
MRO Most recent outpatient
NCK Network clock
NSC Network status change
NST Network statistic
ORD Order
OTH Other
PRB Problems
PRO Procedure
RES Result
RAR Pharmacy administration information
RER Pharmacy encoded order information
RDR Pharmacy dispense information
RGR Pharmacy give information
ROR Pharmacy prescription information
SAL All schedule related information, including open slots, booked slots, blocked slots
SBK Booked slots on the identified schedule
SBL Blocked slots on the identified schedule
SOF First open slot on the identified schedule after the start date/time
SOP Open slots on the identified schedule
SSA Time slots available for a single appointment
SSR Time slots available for a recurring appointment
STA Status
VXI Vaccine Information
XID Get cross-referenced identifiers
...
Definition: This field is used to control level of detail in results. Refer to HL7 Table 0108 - Query results level for valid values. See section 4 and 5.
Anchor
table0108
table0108

HL7 Table 0108 - Query results level
Value Description
O Order plus order status
R Results without bulk text
S Status only
T Full results
...
The QRF segment is used with the QRD segment to further refine the content of an original style query.
HL7 Attribute Table – QRF – Original style query filter
SEQ LEN DT OPT RP/# TBL# ITEM # ELEMENT NAME
1 20 ST R Y 00037 Where Subject Filter
2 26 TS B 00038 When Data Start Date/Time
3 26 TS B 00039 When Data End Date/Time
4 60 ST O Y 00040 What User Qualifier
5 60 ST O Y 00041 Other QRY Subject Filter
6 12 ID O Y 0156 00042 Which Date/Time Qualifier
7 12 ID O Y 0157 00043 Which Date/Time Status Qualifier
8 12 ID O Y 0158 00044 Date/Time Selection Qualifier
9 60 TQ O 00694 When Quantity/Timing Qualifier
10 10 NM O 01442 Search Confidence Threshold
...
Definition: This field specifies the type of date referred to in QRF-2-When data start date/time and QRF-3-When data end date/time.
Anchor
table0156
table0156

HL7 Table 0156 - Which date/time qualifier
Value Description
ANY Any date/time within a range
COL Collection date/time, equivalent to film or sample collection date/time
ORD Order date/time
RCT Specimen receipt date/time, receipt of specimen in filling ancillary (Lab)
REP Report date/time, report date/time at filing ancillary (i.e., Lab)
SCHED Schedule date/time
...
Definition: This field specifies the status type of objects selected in date range defined by QRF-2-When data start date/time and QRF-3-When data end date/time.
Anchor
table0157
table0157

HL7 Table 0157 - Which date/time status qualifier
Value Description
ANY Any status
CFN Current final value, whether final or corrected
COR Corrected only (no final with corrections)
FIN Final only (no corrections)
PRE Preliminary
REP Report completion date/time
...
Definition: This field allows the specification of certain types of values within the date/time range.
Anchor
table0158
table0158

HL7 Table 0158 - Date/time selection qualifier
Value Description
1ST First value within range
ALL All values within the range
LST Last value within the range
REV All values within the range returned in reverse chronological order (This is the default if not otherwise specified.)
...

Version	Old Version 1	New Version Current
Changes made by	Brett Esler	Former user
Saved on	Jul 07, 2021	Jul 07, 2021

Versions Compared

Key

Anchor
BTS-fd
BTS-fd
2.1.3.0 BTS field definitions

Anchor
DSC-fd
DSC-fd
2.1.4.0 DSC field definitions

HL7 Attribute Table - ERR –Error

HL7 Attribute Table - FHS - File Header

HL7 Attribute Table - FTS - File Trailer

HL7 Attribute Table - MSH - Message Header

Anchor
MSH-4
MSH-4
2.1.9.4 MSH-4 Sending facility (HD) 00004

HL7 Attribute Table – PID – Patient identification

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

Anchor
PID-18
PID-18
2.2.1.18 PID-18 Patient account number (CX) 00121

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

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

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

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

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

HL7 Attribute Table - PV1 – Patient visit

Value	Description
D	Response is in display format
R	Response is in record-oriented format
T	Response is in tabular format

Value	Description
B	Before the Date/Time specified
L	Later than the Date/Time specified

Value	Description
ADV	Advice/diagnosis
ANU	Nursing unit lookup (returns patients in beds, excluding empty beds)
APN	Patient name lookup
APP	Physician lookup
ARN	Nursing unit lookup (returns patients in beds, including empty beds)
APM	Medical record number query, returns visits for a medical record number
APA	Account number query, return matching visit
CAN	Cancel. Used to cancel a query
DEM	Demographics
FIN	Financial
GID	Generate new identifier
GOL	Goals
MRI	Most recent inpatient
MRO	Most recent outpatient
NCK	Network clock
NSC	Network status change
NST	Network statistic
ORD	Order
OTH	Other
PRB	Problems
PRO	Procedure
RES	Result
RAR	Pharmacy administration information
RER	Pharmacy encoded order information
RDR	Pharmacy dispense information
RGR	Pharmacy give information
ROR	Pharmacy prescription information
SAL	All schedule related information, including open slots, booked slots, blocked slots
SBK	Booked slots on the identified schedule
SBL	Blocked slots on the identified schedule
SOF	First open slot on the identified schedule after the start date/time
SOP	Open slots on the identified schedule
SSA	Time slots available for a single appointment
SSR	Time slots available for a recurring appointment
STA	Status
VXI	Vaccine Information
XID	Get cross-referenced identifiers

Value	Description
O	Order plus order status
R	Results without bulk text
S	Status only
T	Full results

SEQ	LEN	DT	OPT	RP/#	TBL#	ITEM #	ELEMENT NAME
1	20	ST	R	Y		00037	Where Subject Filter
2	26	TS	B			00038	When Data Start Date/Time
3	26	TS	B			00039	When Data End Date/Time
4	60	ST	O	Y		00040	What User Qualifier
5	60	ST	O	Y		00041	Other QRY Subject Filter
6	12	ID	O	Y	0156	00042	Which Date/Time Qualifier
7	12	ID	O	Y	0157	00043	Which Date/Time Status Qualifier
8	12	ID	O	Y	0158	00044	Date/Time Selection Qualifier
9	60	TQ	O			00694	When Quantity/Timing Qualifier
10	10	NM	O			01442	Search Confidence Threshold

Value	Description
ANY	Any date/time within a range
COL	Collection date/time, equivalent to film or sample collection date/time
ORD	Order date/time
RCT	Specimen receipt date/time, receipt of specimen in filling ancillary (Lab)
REP	Report date/time, report date/time at filing ancillary (i.e., Lab)
SCHED	Schedule date/time

Value	Description
ANY	Any status
CFN	Current final value, whether final or corrected
COR	Corrected only (no final with corrections)
FIN	Final only (no corrections)
PRE	Preliminary
REP	Report completion date/time

Value	Description
1ST	First value within range
ALL	All values within the range
LST	Last value within the range
REV	All values within the range returned in reverse chronological order (This is the default if not otherwise specified.)

Page Comparison

Versions Compared

Key

AnchorBTS-fdBTS-fd2.1.3.0 BTS field definitions

AnchorDSC-fdDSC-fd2.1.4.0 DSC field definitions

HL7 Attribute Table - ERR –Error

HL7 Attribute Table - FHS - File Header

HL7 Attribute Table - FTS - File Trailer

HL7 Attribute Table - MSH - Message Header

AnchorMSH-4MSH-42.1.9.4 MSH-4 Sending facility (HD) 00004

HL7 Attribute Table – PID – Patient identification

AnchorPID-4PID-42.2.1.4 PID-4 Alternate patient ID - PID (CX) 00107

AnchorPID-18PID-182.2.1.18 PID-18 Patient account number (CX) 00121

AnchorPID-26PID-262.2.1.26 PID-26 Citizenship (CE) 00129

AnchorPID-27PID-272.2.1.27 PID-27 Veterans military status (CE) 00130

AnchorPID-28PID-282.2.1.28 PID-28 Nationality (CE) 00739

AnchorPID-29PID-292.2.1.29 PID-29 Patient death date and time (TS) 00740

AnchorPID-30PID-302.2.1.30 PID-30 Patient death indicator (ID) 00741

HL7 Attribute Table - PV1 – Patient visit

Anchor
BTS-fd
BTS-fd
2.1.3.0 BTS field definitions

Anchor
DSC-fd
DSC-fd
2.1.4.0 DSC field definitions

Anchor
MSH-4
MSH-4
2.1.9.4 MSH-4 Sending facility (HD) 00004

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

Anchor
PID-18
PID-18
2.2.1.18 PID-18 Patient account number (CX) 00121

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

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

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

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

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