Page tree

Versions Compared

Key

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

...

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
1260250††††VIDR 010400012Version ID
1315NMO  00013Sequence Number
14180STO  00014Continuation Pointer
152IDR††† 015500015Accept Acknowledgment Type
162IDR††† 015500016Application Acknowledgment Type
173IDR†† 039900017Country Code
1816IDOY021100692Character Set
19250CER††  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

...

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

...

Refer to AS 4846-2014 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)>

...

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

...

Note: In the Australian context this field is used for the patient's country of birth. Refer to METeOR 459973659454 'Country of birth' and AS 4846-2014 Clause 5.8.4 'Country of birth'.

...

In the Australian context refer to METeOR 482409 Birth plurality which indicates the total number of births from a single pregnancy and refer to AS 4846-2014 Clause 5.3.1 Birth Plurality.

Note: Variance to HL7 International where HL7 Note that HL7 table 0136 is a 'Yes/No' valued table, where as METeOR 482409668881 '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

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 269992669962 'Birth order' and AS 4846-2014 Clause 5.3.2.

...

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 

ValueDescription
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

...

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
14SIOR ††††  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 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

...

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

...

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

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

...

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

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

...

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

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

...

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 11XON 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.

...

  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.