v2.3.1 Segments¶
ACC: ACC - accident segment¶
Section 6.4.9
- class hl7types.hl7.v2_3_1.segments.ACC.ACC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
O |
00527 |
Accident Date/Time |
|||
2 |
|
O |
0050 |
00528 |
Accident Code |
||
3 |
|
25 |
str |
O |
00529 |
Accident Location |
|
4 |
|
O |
0347 |
00812 |
Auto Accident State |
||
5 |
|
1 |
str |
O |
0136 |
00813 |
Accident Job Related Indicator |
6 |
|
12 |
str |
O |
0136 |
00814 |
Accident Death Indicator |
ADD: ADD - addendum segment¶
Section 2.24.10
- class hl7types.hl7.v2_3_1.segments.ADD.ADD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
65536 |
str |
O |
00066 |
Addendum Continuation Pointer |
AIG: AIG - appointment information - general resource segment¶
Section 10.5.5
- class hl7types.hl7.v2_3_1.segments.AIG.AIG
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00896 |
Set ID - AIG |
|
2 |
|
3 |
str |
C |
0206 |
00763 |
Segment Action Code |
3 |
|
C |
00897 |
Resource ID |
|||
4 |
|
R |
00898 |
Resource Type |
|||
5 |
|
list[CE] |
O |
00899 |
Resource Group |
||
6 |
|
5 |
str |
O |
00900 |
Resource Quantity |
|
7 |
|
O |
00901 |
Resource Quantity Units |
|||
8 |
|
C |
01202 |
Start Date/Time |
|||
9 |
|
20 |
str |
C |
00891 |
Start Date/Time Offset |
|
10 |
|
C |
00892 |
Start Date/Time Offset Units |
|||
11 |
|
20 |
str |
O |
00893 |
Duration |
|
12 |
|
O |
00894 |
Duration Units |
|||
13 |
|
10 |
str |
C |
0279 |
00895 |
Allow Substitution Code |
14 |
|
C |
0278 |
00889 |
Filler Status Code |
AIL: AIL - appointment information - location resource segment¶
Section 10.5.6
- class hl7types.hl7.v2_3_1.segments.AIL.AIL
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00902 |
Set ID - AIL |
|
2 |
|
3 |
str |
C |
0206 |
00763 |
Segment Action Code |
3 |
|
C |
00903 |
Location Resource ID |
|||
4 |
|
R |
00904 |
Location Type-AIL |
|||
5 |
|
O |
00905 |
Location Group |
|||
6 |
|
C |
01202 |
Start Date/Time |
|||
7 |
|
20 |
str |
C |
00891 |
Start Date/Time Offset |
|
8 |
|
C |
00892 |
Start Date/Time Offset Units |
|||
9 |
|
20 |
str |
O |
00893 |
Duration |
|
10 |
|
O |
00894 |
Duration Units |
|||
11 |
|
10 |
str |
C |
0279 |
00895 |
Allow Substitution Code |
12 |
|
C |
0278 |
00889 |
Filler Status Code |
AIP: AIP - appointment information - personnel resource segment¶
Section 10.5.7
- class hl7types.hl7.v2_3_1.segments.AIP.AIP
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00906 |
Set ID - AIP |
|
2 |
|
3 |
str |
C |
0206 |
00763 |
Segment Action Code |
3 |
|
list[XCN] |
C |
00913 |
Personnel Resource ID |
||
4 |
|
R |
00907 |
Resource Role |
|||
5 |
|
O |
00899 |
Resource Group |
|||
6 |
|
C |
01202 |
Start Date/Time |
|||
7 |
|
20 |
str |
C |
00891 |
Start Date/Time Offset |
|
8 |
|
C |
00892 |
Start Date/Time Offset Units |
|||
9 |
|
20 |
str |
O |
00893 |
Duration |
|
10 |
|
O |
00894 |
Duration Units |
|||
11 |
|
10 |
str |
C |
0279 |
00895 |
Allow Substitution Code |
12 |
|
C |
0278 |
00889 |
Filler Status Code |
AIS: AIS - appointment information - service segment¶
Section 10.5.4
- class hl7types.hl7.v2_3_1.segments.AIS.AIS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00890 |
Set ID - AIS |
|
2 |
|
3 |
str |
C |
0206 |
00763 |
Segment Action Code |
3 |
|
R |
00238 |
Universal Service ID |
|||
4 |
|
C |
01202 |
Start Date/Time |
|||
5 |
|
20 |
str |
C |
00891 |
Start Date/Time Offset |
|
6 |
|
C |
00892 |
Start Date/Time Offset Units |
|||
7 |
|
20 |
str |
O |
00893 |
Duration |
|
8 |
|
O |
00894 |
Duration Units |
|||
9 |
|
10 |
str |
C |
0279 |
00895 |
Allow Substitution Code |
10 |
|
C |
0278 |
00889 |
Filler Status Code |
AL1: AL1 - patient allergy information segment¶
Section 3.3.6
- class hl7types.hl7.v2_3_1.segments.AL1.AL1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00203 |
Set ID - AL1 |
|
2 |
|
2 |
str |
O |
0127 |
00204 |
Allergy Type |
3 |
|
R |
00205 |
Allergy Code/Mnemonic/Description |
|||
4 |
|
2 |
str |
O |
0128 |
00206 |
Allergy Severity |
5 |
|
15 |
list[str] |
O |
00207 |
Allergy Reaction |
|
6 |
|
8 |
str |
O |
00208 |
Identification Date |
APR: APR - appointment preferences segment¶
Section 10.5.8
- class hl7types.hl7.v2_3_1.segments.APR.APR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[SCV] |
O |
0294 |
00908 |
Time Selection Criteria |
|
2 |
|
list[SCV] |
O |
0294 |
00909 |
Resource Selection Criteria |
|
3 |
|
list[SCV] |
O |
0294 |
00910 |
Location Selection Criteria |
|
4 |
|
5 |
str |
O |
00911 |
Slot Spacing Criteria |
|
5 |
|
list[SCV] |
O |
00912 |
Filler Override Criteria |
ARQ: ARQ - appointment request segment¶
Section 10.5.1
- class hl7types.hl7.v2_3_1.segments.ARQ.ARQ
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00860 |
Placer Appointment ID |
|||
2 |
|
C |
00861 |
Filler Appointment ID |
|||
3 |
|
5 |
str |
C |
00862 |
Occurrence Number |
|
4 |
|
O |
00218 |
Placer Group Number |
|||
5 |
|
O |
00864 |
Schedule ID |
|||
6 |
|
O |
00865 |
Request Event Reason |
|||
7 |
|
O |
0276 |
00866 |
Appointment Reason |
||
8 |
|
O |
0277 |
00867 |
Appointment Type |
||
9 |
|
20 |
str |
O |
00868 |
Appointment Duration |
|
10 |
|
O |
00869 |
Appointment Duration Units |
|||
11 |
|
list[DR] |
O |
00870 |
Requested Start Date/Time Range |
||
12 |
|
5 |
str |
O |
00871 |
Priority-ARQ |
|
13 |
|
O |
00872 |
Repeating Interval |
|||
14 |
|
5 |
str |
O |
00873 |
Repeating Interval Duration |
|
15 |
|
list[XCN] |
R |
00874 |
Placer Contact Person |
||
16 |
|
list[XTN] |
O |
00875 |
Placer Contact Phone Number |
||
17 |
|
list[XAD] |
O |
00876 |
Placer Contact Address |
||
18 |
|
O |
00877 |
Placer Contact Location |
|||
19 |
|
list[XCN] |
R |
00878 |
Entered by Person |
||
20 |
|
list[XTN] |
O |
00879 |
Entered by Phone Number |
||
21 |
|
O |
00880 |
Entered by Location |
|||
22 |
|
O |
00881 |
Parent Placer Appointment ID |
|||
23 |
|
O |
00882 |
Parent Filler Appointment ID |
BHS: BHS - batch header segment¶
Section 2.24.13
- class hl7types.hl7.v2_3_1.segments.BHS.BHS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
1 |
str |
R |
00081 |
Batch Field Separator |
|
2 |
|
3 |
str |
R |
00082 |
Batch Encoding Characters |
|
3 |
|
15 |
str |
O |
00083 |
Batch Sending Application |
|
4 |
|
20 |
str |
O |
00084 |
Batch Sending Facility |
|
5 |
|
15 |
str |
O |
00085 |
Batch Receiving Application |
|
6 |
|
20 |
str |
O |
00086 |
Batch Receiving Facility |
|
7 |
|
O |
00087 |
Batch Creation Date/Time |
|||
8 |
|
40 |
str |
O |
00088 |
Batch Security |
|
9 |
|
20 |
str |
O |
00089 |
Batch Name/ID/Type |
|
10 |
|
80 |
str |
O |
00090 |
Batch Comment |
|
11 |
|
20 |
str |
O |
00091 |
Batch Control ID |
|
12 |
|
20 |
str |
O |
00092 |
Reference Batch Control ID |
BLG: BLG - billing segment¶
Section 4.3.2
- class hl7types.hl7.v2_3_1.segments.BLG.BLG
BTS: BTS - batch trailer segment¶
Section 2.24.14
- class hl7types.hl7.v2_3_1.segments.BTS.BTS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
10 |
str |
O |
00093 |
Batch Message Count |
|
2 |
|
80 |
str |
O |
00090 |
Batch Comment |
|
3 |
|
100 |
list[str] |
O |
00095 |
Batch Totals |
CDM: CDM - charge description master segment¶
Section 8.9.2
- class hl7types.hl7.v2_3_1.segments.CDM.CDM
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
0132 |
01306 |
Primary Key Value - CDM |
||
2 |
|
list[CE] |
O |
00983 |
Charge Code Alias |
||
3 |
|
20 |
str |
R |
00984 |
Charge Description Short |
|
4 |
|
250 |
str |
O |
00985 |
Charge Description Long |
|
5 |
|
1 |
str |
O |
0268 |
00986 |
Description Override Indicator |
6 |
|
list[CE] |
O |
00987 |
Exploding Charges |
||
7 |
|
list[CE] |
O |
0088 |
00393 |
Procedure Code |
|
8 |
|
1 |
str |
O |
0183 |
00675 |
Active/Inactive Flag |
9 |
|
list[CE] |
O |
00990 |
Inventory Number |
||
10 |
|
12 |
str |
O |
00991 |
Resource Load |
|
11 |
|
list[CK] |
O |
00992 |
Contract Number |
||
12 |
|
list[XON] |
O |
00993 |
Contract Organization |
||
13 |
|
1 |
str |
O |
0136 |
00994 |
Room Fee Indicator |
CM0: CM0 - clinical study master segment¶
Section 8.10.2
- class hl7types.hl7.v2_3_1.segments.CM0.CM0
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
01010 |
Set ID - CM0 |
|
2 |
|
R |
01011 |
Sponsor Study ID |
|||
3 |
|
list[EI] |
O |
01036 |
Alternate Study ID |
||
4 |
|
300 |
str |
R |
01013 |
Title of Study |
|
5 |
|
list[XCN] |
O |
01014 |
Chairman of Study |
||
6 |
|
8 |
str |
O |
01015 |
Last IRB Approval Date |
|
7 |
|
8 |
str |
O |
01016 |
Total Accrual to Date |
|
8 |
|
8 |
str |
O |
01017 |
Last Accrual Date |
|
9 |
|
list[XCN] |
O |
01018 |
Contact for Study |
||
10 |
|
O |
01019 |
Contact’s Tel. Number |
|||
11 |
|
list[XAD] |
O |
01020 |
Contact’s Address |
CM1: CM1 - clinical study phase master segment¶
Section 8.10.3
- class hl7types.hl7.v2_3_1.segments.CM1.CM1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
01021 |
Set ID - CM1 |
|
2 |
|
R |
01022 |
Study Phase Identifier |
|||
3 |
|
300 |
str |
R |
01023 |
Description of Study Phase |
CM2: CM2 - clinical study schedule master segment¶
Section 8.10.4
- class hl7types.hl7.v2_3_1.segments.CM2.CM2
CSP: CSP - clinical study phase segment¶
Section 7.7.2
- class hl7types.hl7.v2_3_1.segments.CSP.CSP
CSR: CSR - clinical study registration segment¶
Section 7.7.1
- class hl7types.hl7.v2_3_1.segments.CSR.CSR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01011 |
Sponsor Study ID |
|||
2 |
|
O |
01036 |
Alternate Study ID |
|||
3 |
|
O |
01037 |
Institution Registering the Patient |
|||
4 |
|
R |
01038 |
Sponsor Patient ID |
|||
5 |
|
O |
01039 |
Alternate Patient ID - CSR |
|||
6 |
|
R |
01040 |
Date/Time Of Patient Study Registration |
|||
7 |
|
list[XCN] |
O |
01041 |
Person Performing Study Registration |
||
8 |
|
list[XCN] |
R |
01042 |
Study Authorizing Provider |
||
9 |
|
C |
01043 |
Date/time Patient Study Consent Signed |
|||
10 |
|
C |
01044 |
Patient Study Eligibility Status |
|||
11 |
|
list[TS] |
O |
01045 |
Study Randomization Date/time |
||
12 |
|
list[CE] |
O |
01046 |
Randomized Study Arm |
||
13 |
|
list[CE] |
O |
01047 |
Stratum for Study Randomization |
||
14 |
|
C |
01048 |
Patient Evaluability Status |
|||
15 |
|
C |
01049 |
Date/time Ended Study |
|||
16 |
|
C |
01050 |
Reason Ended Study |
CSS: CSS - clinical study data schedule segment¶
Section 7.7.3
- class hl7types.hl7.v2_3_1.segments.CSS.CSS
CTD: Contact Data¶
Section 11.5.4
- class hl7types.hl7.v2_3_1.segments.CTD.CTD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[CE] |
O |
0131 |
00196 |
Contact Role |
|
2 |
|
list[XPN] |
O |
01165 |
Contact Name |
||
3 |
|
list[XAD] |
O |
01166 |
Contact Address |
||
4 |
|
O |
01167 |
Contact Location |
|||
5 |
|
list[XTN] |
O |
01168 |
Contact Communication Information |
||
6 |
|
O |
0185 |
00684 |
Preferred Method Of Contact |
||
7 |
|
list[PI] |
O |
01171 |
Contact Identifiers |
CTI: CTI - clinical trial identification segment¶
Section 7.7.4
- class hl7types.hl7.v2_3_1.segments.CTI.CTI
DB1: DB1 - Disability segment¶
Section 3.3.10
- class hl7types.hl7.v2_3_1.segments.DB1.DB1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
01283 |
Set ID - DB1 |
|
2 |
|
2 |
str |
O |
0334 |
01284 |
Disabled Person Code |
3 |
|
list[CX] |
O |
01285 |
Disabled Person Identifier |
||
4 |
|
1 |
str |
O |
0136 |
01286 |
Disabled Indicator |
5 |
|
8 |
str |
O |
01287 |
Disability Start Date |
|
6 |
|
8 |
str |
O |
01288 |
Disability End Date |
|
7 |
|
8 |
str |
O |
01289 |
Disability Return to Work Date |
|
8 |
|
8 |
str |
O |
01290 |
Disability Unable to Work Date |
DG1: DG1 - diagnosis segment¶
Section 6.4.2
- class hl7types.hl7.v2_3_1.segments.DG1.DG1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00375 |
Set ID - DG1 |
|
2 |
|
2 |
str |
R |
0053 |
00376 |
Diagnosis Coding Method |
3 |
|
O |
0051 |
00377 |
Diagnosis Code - DG1 |
||
4 |
|
40 |
str |
O |
00378 |
Diagnosis Description |
|
5 |
|
O |
00379 |
Diagnosis Date/Time |
|||
6 |
|
2 |
str |
R |
0052 |
00380 |
Diagnosis Type |
7 |
|
O |
0118 |
00381 |
Major Diagnostic Category |
||
8 |
|
O |
0055 |
00382 |
Diagnostic Related Group |
||
9 |
|
1 |
str |
O |
0136 |
00383 |
DRG Approval Indicator |
10 |
|
2 |
str |
O |
0056 |
00384 |
DRG Grouper Review Code |
11 |
|
O |
0083 |
00385 |
Outlier Type |
||
12 |
|
3 |
str |
O |
00386 |
Outlier Days |
|
13 |
|
O |
00387 |
Outlier Cost |
|||
14 |
|
4 |
str |
O |
00388 |
Grouper Version And Type |
|
15 |
|
2 |
str |
O |
0359 |
00389 |
Diagnosis Priority |
16 |
|
list[XCN] |
O |
00390 |
Diagnosing Clinician |
||
17 |
|
3 |
str |
O |
0228 |
00766 |
Diagnosis Classification |
18 |
|
1 |
str |
O |
0136 |
00767 |
Confidential Indicator |
19 |
|
O |
00768 |
Attestation Date/Time |
DSC: DSC - Continuation pointer segment¶
Section 2.24.8
- class hl7types.hl7.v2_3_1.segments.DSC.DSC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
180 |
str |
O |
00014 |
Continuation Pointer |
DSP: DSP - display data segment¶
Section 2.24.9
- class hl7types.hl7.v2_3_1.segments.DSP.DSP
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00061 |
Set ID - DSP |
|
2 |
|
4 |
str |
O |
00062 |
Display Level |
|
3 |
|
str |
R |
00063 |
Data Line |
||
4 |
|
2 |
str |
O |
00064 |
Logical Break Point |
|
5 |
|
str |
O |
00065 |
Result ID |
EQL: EQL - embedded query language segment¶
Section 2.24.16.4
- class hl7types.hl7.v2_3_1.segments.EQL.EQL
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
32 |
str |
O |
00696 |
Query Tag |
|
2 |
|
1 |
str |
R |
0106 |
00697 |
Query/ Response Format Code |
3 |
|
R |
00709 |
EQL Query Name |
|||
4 |
|
4096 |
str |
R |
00710 |
EQL Query Statement |
ERQ: ERQ - event replay query segment¶
Section 2.24.21
- class hl7types.hl7.v2_3_1.segments.ERQ.ERQ
ERR: ERR - error segment¶
Section 2.24.3
- class hl7types.hl7.v2_3_1.segments.ERR.ERR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[ELD] |
R |
00024 |
Error Code and Location |
EVN: EVN - event type segment¶
Section 3.3.1
- class hl7types.hl7.v2_3_1.segments.EVN.EVN
FAC: FAC - facility segment¶
Section 7.11.6
- class hl7types.hl7.v2_3_1.segments.FAC.FAC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01262 |
Facility ID-FAC |
|||
2 |
|
1 |
str |
O |
0331 |
01263 |
Facility Type |
3 |
|
list[XAD] |
R |
01264 |
Facility Address |
||
4 |
|
R |
01265 |
Facility Telecommunication |
|||
5 |
|
list[XCN] |
O |
01266 |
Contact Person |
||
6 |
|
60 |
list[str] |
O |
01267 |
Contact Title |
|
7 |
|
list[XAD] |
O |
01166 |
Contact Address |
||
8 |
|
list[XTN] |
O |
01269 |
Contact Telecommunication |
||
9 |
|
list[XCN] |
R |
01270 |
Signature Authority |
||
10 |
|
60 |
str |
O |
01271 |
Signature Authority Title |
|
11 |
|
list[XAD] |
O |
01272 |
Signature Authority Address |
||
12 |
|
O |
01273 |
Signature Authority Telecommunication |
FHS: FHS - file header segment¶
Section 2.24.11
- class hl7types.hl7.v2_3_1.segments.FHS.FHS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
1 |
str |
R |
00067 |
File Field Separator |
|
2 |
|
4 |
str |
R |
00068 |
File Encoding Characters |
|
3 |
|
15 |
str |
O |
00069 |
File Sending Application |
|
4 |
|
20 |
str |
O |
00070 |
File Sending Facility |
|
5 |
|
15 |
str |
O |
00071 |
File Receiving Application |
|
6 |
|
20 |
str |
O |
00072 |
File Receiving Facility |
|
7 |
|
O |
00073 |
File Creation Date/Time |
|||
8 |
|
40 |
str |
O |
00074 |
File Security |
|
9 |
|
20 |
str |
O |
00075 |
File Name/ID |
|
10 |
|
80 |
str |
O |
00076 |
File Header Comment |
|
11 |
|
20 |
str |
O |
00077 |
File Control ID |
|
12 |
|
20 |
str |
O |
00078 |
Reference File Control ID |
FT1: FT1 - financial transaction segment¶
Section 6.4.1
- class hl7types.hl7.v2_3_1.segments.FT1.FT1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00355 |
Set ID - FT1 |
|
2 |
|
12 |
str |
O |
00356 |
Transaction ID |
|
3 |
|
10 |
str |
O |
00357 |
Transaction Batch ID |
|
4 |
|
R |
00358 |
Transaction Date |
|||
5 |
|
O |
00359 |
Transaction Posting Date |
|||
6 |
|
8 |
str |
R |
0017 |
00360 |
Transaction Type |
7 |
|
R |
0132 |
00361 |
Transaction Code |
||
8 |
|
40 |
str |
O |
00362 |
Transaction Description |
|
9 |
|
40 |
str |
O |
00363 |
Transaction Description - Alt |
|
10 |
|
6 |
str |
O |
00364 |
Transaction Quantity |
|
11 |
|
O |
00365 |
Transaction Amount - Extended |
|||
12 |
|
O |
00366 |
Transaction Amount - Unit |
|||
13 |
|
O |
0049 |
00367 |
Department Code |
||
14 |
|
O |
0072 |
00368 |
Insurance Plan ID |
||
15 |
|
O |
00369 |
Insurance Amount |
|||
16 |
|
O |
00133 |
Assigned Patient Location |
|||
17 |
|
1 |
str |
O |
0024 |
00370 |
Fee Schedule |
18 |
|
2 |
str |
O |
0018 |
00148 |
Patient Type |
19 |
|
list[CE] |
O |
0051 |
00371 |
Diagnosis Code - FT1 |
|
20 |
|
list[XCN] |
O |
0084 |
00372 |
Performed By Code |
|
21 |
|
list[XCN] |
O |
00373 |
Ordered By Code |
||
22 |
|
O |
00374 |
Unit Cost |
|||
23 |
|
O |
00217 |
Filler Order Number |
|||
24 |
|
list[XCN] |
O |
00765 |
Entered By Code |
||
25 |
|
O |
0088 |
00393 |
Procedure Code |
||
26 |
|
list[CE] |
O |
0340 |
01316 |
Procedure Code Modifier |
FTS: FTS - file trailer segment¶
Section 2.24.12
- class hl7types.hl7.v2_3_1.segments.FTS.FTS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
10 |
str |
O |
00079 |
File Batch Count |
|
2 |
|
80 |
str |
O |
00080 |
File Trailer Comment |
GOL: Goal Detail¶
Section 12.3.1
- class hl7types.hl7.v2_3_1.segments.GOL.GOL
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
str |
R |
0287 |
00816 |
Action Code |
2 |
|
R |
00817 |
Action Date/Time |
|||
3 |
|
R |
00818 |
Goal ID |
|||
4 |
|
R |
00819 |
Goal Instance ID |
|||
5 |
|
O |
00820 |
Episode of Care ID |
|||
6 |
|
60 |
str |
O |
00821 |
Goal List Priority |
|
7 |
|
O |
00822 |
Goal Established Date/Time |
|||
8 |
|
O |
00824 |
Expected Goal Achieve Date/Time |
|||
9 |
|
O |
00825 |
Goal Classification |
|||
10 |
|
O |
00826 |
Goal Management Discipline |
|||
11 |
|
O |
00827 |
Current Goal Review Status |
|||
12 |
|
O |
00828 |
Current Goal Review Date/Time |
|||
13 |
|
O |
00829 |
Next Goal Review Date/Time |
|||
14 |
|
O |
00830 |
Previous Goal Review Date/Time |
|||
15 |
|
O |
00831 |
Goal Review Interval |
|||
16 |
|
O |
00832 |
Goal Evaluation |
|||
17 |
|
300 |
list[str] |
O |
00833 |
Goal Evaluation Comment |
|
18 |
|
O |
00834 |
Goal Life Cycle Status |
|||
19 |
|
O |
00835 |
Goal Life Cycle Status Date/Time |
|||
20 |
|
list[CE] |
O |
00836 |
Goal Target Type |
||
21 |
|
list[XPN] |
O |
00837 |
Goal Target Name |
GT1: GT1 - guarantor segment¶
Section 6.4.5
- class hl7types.hl7.v2_3_1.segments.GT1.GT1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00405 |
Set ID - GT1 |
|
2 |
|
list[CX] |
O |
00406 |
Guarantor Number |
||
3 |
|
list[XPN] |
R |
00407 |
Guarantor Name |
||
4 |
|
list[XPN] |
O |
00408 |
Guarantor Spouse Name |
||
5 |
|
list[XAD] |
O |
00409 |
Guarantor Address |
||
6 |
|
list[XTN] |
O |
00410 |
Guarantor Ph Num-Home |
||
7 |
|
list[XTN] |
O |
00411 |
Guarantor Ph Num-Business |
||
8 |
|
O |
00412 |
Guarantor Date/Time Of Birth |
|||
9 |
|
1 |
str |
O |
0001 |
00413 |
Guarantor Sex |
10 |
|
2 |
str |
O |
0068 |
00414 |
Guarantor Type |
11 |
|
O |
0063 |
00415 |
Guarantor Relationship |
||
12 |
|
11 |
str |
O |
00416 |
Guarantor SSN |
|
13 |
|
8 |
str |
O |
00417 |
Guarantor Date - Begin |
|
14 |
|
8 |
str |
O |
00418 |
Guarantor Date - End |
|
15 |
|
2 |
str |
O |
00419 |
Guarantor Priority |
|
16 |
|
list[XPN] |
O |
00420 |
Guarantor Employer Name |
||
17 |
|
list[XAD] |
O |
00421 |
Guarantor Employer Address |
||
18 |
|
list[XTN] |
O |
00422 |
Guarantor Employer Phone Number |
||
19 |
|
list[CX] |
O |
00423 |
Guarantor Employee ID Number |
||
20 |
|
2 |
str |
O |
0066 |
00424 |
Guarantor Employment Status |
21 |
|
list[XON] |
O |
00425 |
Guarantor Organization Name |
||
22 |
|
1 |
str |
O |
0136 |
00773 |
Guarantor Billing Hold Flag |
23 |
|
O |
0341 |
00774 |
Guarantor Credit Rating Code |
||
24 |
|
O |
00775 |
Guarantor Death Date And Time |
|||
25 |
|
1 |
str |
O |
0136 |
00776 |
Guarantor Death Flag |
26 |
|
O |
0218 |
00777 |
Guarantor Charge Adjustment Code |
||
27 |
|
O |
00778 |
Guarantor Household Annual Income |
|||
28 |
|
3 |
str |
O |
00779 |
Guarantor Household Size |
|
29 |
|
list[CX] |
O |
00780 |
Guarantor Employer ID Number |
||
30 |
|
O |
0002 |
00781 |
Guarantor Marital Status Code |
||
31 |
|
8 |
str |
O |
00782 |
Guarantor Hire Effective Date |
|
32 |
|
8 |
str |
O |
00783 |
Employment Stop Date |
|
33 |
|
2 |
str |
O |
0223 |
00755 |
Living Dependency |
34 |
|
2 |
list[str] |
O |
0009 |
00145 |
Ambulatory Status |
35 |
|
list[CE] |
O |
0171 |
00129 |
Citizenship |
|
36 |
|
O |
0296 |
00118 |
Primary Language |
||
37 |
|
2 |
str |
O |
0220 |
00742 |
Living Arrangement |
38 |
|
O |
0215 |
00743 |
Publicity Code |
||
39 |
|
1 |
str |
O |
0136 |
00744 |
Protection Indicator |
40 |
|
2 |
str |
O |
0231 |
00745 |
Student Indicator |
41 |
|
O |
0006 |
00120 |
Religion |
||
42 |
|
list[XPN] |
O |
00109 |
Mother’s Maiden Name |
||
43 |
|
O |
0212 |
00739 |
Nationality |
||
44 |
|
list[CE] |
O |
0189 |
00125 |
Ethnic Group |
|
45 |
|
list[XPN] |
O |
00748 |
Contact Person’s Name |
||
46 |
|
list[XTN] |
O |
00749 |
Contact Person’s Telephone Number |
||
47 |
|
O |
0222 |
00747 |
Contact Reason |
||
48 |
|
2 |
str |
O |
0063 |
00784 |
Contact Relationship |
49 |
|
20 |
str |
O |
00785 |
Job Title |
|
50 |
|
O |
0327 |
00786 |
Job Code/Class |
||
51 |
|
list[XON] |
O |
01299 |
Guarantor Employer’s Organization Name |
||
52 |
|
2 |
str |
O |
0295 |
00753 |
Handicap |
53 |
|
2 |
str |
O |
0311 |
00752 |
Job Status |
54 |
|
O |
0064 |
01231 |
Guarantor Financial Class |
||
55 |
|
list[CE] |
O |
0005 |
01291 |
Guarantor Race |
IN1: IN1 - insurance segment¶
Section 6.4.6
- class hl7types.hl7.v2_3_1.segments.IN1.IN1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00426 |
Set ID - IN1 |
|
2 |
|
R |
0072 |
00368 |
Insurance Plan ID |
||
3 |
|
list[CX] |
R |
00428 |
Insurance Company ID |
||
4 |
|
list[XON] |
O |
00429 |
Insurance Company Name |
||
5 |
|
list[XAD] |
O |
00430 |
Insurance Company Address |
||
6 |
|
list[XPN] |
O |
00431 |
Insurance Co Contact Person |
||
7 |
|
list[XTN] |
O |
00432 |
Insurance Co Phone Number |
||
8 |
|
12 |
str |
O |
00433 |
Group Number |
|
9 |
|
list[XON] |
O |
00434 |
Group Name |
||
10 |
|
list[CX] |
O |
00435 |
Insured’s Group Emp ID |
||
11 |
|
list[XON] |
O |
00436 |
Insured’s Group Emp Name |
||
12 |
|
8 |
str |
O |
00437 |
Plan Effective Date |
|
13 |
|
8 |
str |
O |
00438 |
Plan Expiration Date |
|
14 |
|
O |
00439 |
Authorization Information |
|||
15 |
|
3 |
str |
O |
0086 |
00440 |
Plan Type |
16 |
|
list[XPN] |
O |
00441 |
Name Of Insured |
||
17 |
|
O |
0063 |
00442 |
Insured’s Relationship To Patient |
||
18 |
|
O |
00443 |
Insured’s Date Of Birth |
|||
19 |
|
list[XAD] |
O |
00444 |
Insured’s Address |
||
20 |
|
2 |
str |
O |
0135 |
00445 |
Assignment Of Benefits |
21 |
|
2 |
str |
O |
0173 |
00446 |
Coordination Of Benefits |
22 |
|
2 |
str |
O |
00447 |
Coord Of Ben. Priority |
|
23 |
|
1 |
str |
O |
0136 |
00448 |
Notice Of Admission Flag |
24 |
|
8 |
str |
O |
00449 |
Notice Of Admission Date |
|
25 |
|
1 |
str |
O |
0136 |
00450 |
Report Of Eligibility Flag |
26 |
|
8 |
str |
O |
00451 |
Report Of Eligibility Date |
|
27 |
|
2 |
str |
O |
0093 |
00452 |
Release Information Code |
28 |
|
15 |
str |
O |
00453 |
Pre-Admit Cert (PAC) |
|
29 |
|
O |
00454 |
Verification Date/Time |
|||
30 |
|
list[XCN] |
O |
00455 |
Verification By |
||
31 |
|
2 |
str |
O |
0098 |
00456 |
Type Of Agreement Code |
32 |
|
2 |
str |
O |
0022 |
00457 |
Billing Status |
33 |
|
4 |
str |
O |
00458 |
Lifetime Reserve Days |
|
34 |
|
4 |
str |
O |
00459 |
Delay Before L.R. Day |
|
35 |
|
8 |
str |
O |
0042 |
00460 |
Company Plan Code |
36 |
|
15 |
str |
O |
00461 |
Policy Number |
|
37 |
|
O |
00462 |
Policy Deductible |
|||
38 |
|
O |
00463 |
Policy Limit - Amount |
|||
39 |
|
4 |
str |
O |
00464 |
Policy Limit - Days |
|
40 |
|
O |
00465 |
Room Rate - Semi-Private |
|||
41 |
|
O |
00466 |
Room Rate - Private |
|||
42 |
|
O |
0066 |
00467 |
Insured’s Employment Status |
||
43 |
|
1 |
str |
O |
0001 |
00468 |
Insured’s Sex |
44 |
|
list[XAD] |
O |
00469 |
Insured’s Employer’s Address |
||
45 |
|
2 |
str |
O |
00470 |
Verification Status |
|
46 |
|
8 |
str |
O |
0072 |
00471 |
Prior Insurance Plan ID |
47 |
|
3 |
str |
O |
0309 |
01227 |
Coverage Type |
48 |
|
2 |
str |
O |
0295 |
00753 |
Handicap |
49 |
|
list[CX] |
O |
01230 |
Insured’s ID Number |
IN2: IN2 - insurance additional information segment¶
Section 6.4.7
- class hl7types.hl7.v2_3_1.segments.IN2.IN2
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[CX] |
O |
00472 |
Insured’s Employee ID |
||
2 |
|
11 |
str |
O |
00473 |
Insured’s Social Security Number |
|
3 |
|
list[XCN] |
O |
00474 |
Insured’s Employer’s Name and ID |
||
4 |
|
1 |
str |
O |
0139 |
00475 |
Employer Information Data |
5 |
|
1 |
list[str] |
O |
0137 |
00476 |
Mail Claim Party |
6 |
|
15 |
str |
O |
00477 |
Medicare Health Ins Card Number |
|
7 |
|
list[XPN] |
O |
00478 |
Medicaid Case Name |
||
8 |
|
15 |
str |
O |
00479 |
Medicaid Case Number |
|
9 |
|
list[XPN] |
O |
00480 |
Military Sponsor Name |
||
10 |
|
20 |
str |
O |
00481 |
Military ID Number |
|
11 |
|
O |
0342 |
00482 |
Dependent Of Military Recipient |
||
12 |
|
25 |
str |
O |
00483 |
Military Organization |
|
13 |
|
25 |
str |
O |
00484 |
Military Station |
|
14 |
|
14 |
str |
O |
0140 |
00485 |
Military Service |
15 |
|
2 |
str |
O |
0141 |
00486 |
Military Rank/Grade |
16 |
|
3 |
str |
O |
0142 |
00487 |
Military Status |
17 |
|
8 |
str |
O |
00488 |
Military Retire Date |
|
18 |
|
1 |
str |
O |
0136 |
00489 |
Military Non-Avail Cert On File |
19 |
|
1 |
str |
O |
0136 |
00490 |
Baby Coverage |
20 |
|
1 |
str |
O |
0136 |
00491 |
Combine Baby Bill |
21 |
|
1 |
str |
O |
00492 |
Blood Deductible |
|
22 |
|
list[XPN] |
O |
00493 |
Special Coverage Approval Name |
||
23 |
|
30 |
str |
O |
00494 |
Special Coverage Approval Title |
|
24 |
|
8 |
list[str] |
O |
0143 |
00495 |
Non-Covered Insurance Code |
25 |
|
list[CX] |
O |
00496 |
Payor ID |
||
26 |
|
list[CX] |
O |
00497 |
Payor Subscriber ID |
||
27 |
|
1 |
str |
O |
0144 |
00498 |
Eligibility Source |
28 |
|
list[RMC] |
O |
0145 |
00499 |
Room Coverage Type/Amount |
|
29 |
|
list[PTA] |
O |
0147 |
00500 |
Policy Type/Amount |
|
30 |
|
O |
00501 |
Daily Deductible |
|||
31 |
|
2 |
str |
O |
0223 |
00755 |
Living Dependency |
32 |
|
2 |
list[str] |
O |
0009 |
00145 |
Ambulatory Status |
33 |
|
list[CE] |
O |
0171 |
00129 |
Citizenship |
|
34 |
|
O |
0296 |
00118 |
Primary Language |
||
35 |
|
2 |
str |
O |
0220 |
00742 |
Living Arrangement |
36 |
|
O |
0215 |
00743 |
Publicity Code |
||
37 |
|
1 |
str |
O |
0136 |
00744 |
Protection Indicator |
38 |
|
2 |
str |
O |
0231 |
00745 |
Student Indicator |
39 |
|
O |
0006 |
00120 |
Religion |
||
40 |
|
list[XPN] |
O |
00109 |
Mother’s Maiden Name |
||
41 |
|
O |
0212 |
00739 |
Nationality |
||
42 |
|
list[CE] |
O |
0189 |
00125 |
Ethnic Group |
|
43 |
|
list[CE] |
O |
0002 |
00119 |
Marital Status |
|
44 |
|
8 |
str |
O |
00787 |
Insured’s Employment Start Date |
|
45 |
|
8 |
str |
O |
00783 |
Employment Stop Date |
|
46 |
|
20 |
str |
O |
00785 |
Job Title |
|
47 |
|
O |
0327 |
00786 |
Job Code/Class |
||
48 |
|
2 |
str |
O |
0311 |
00752 |
Job Status |
49 |
|
list[XPN] |
O |
00789 |
Employer Contact Person Name |
||
50 |
|
list[XTN] |
O |
00790 |
Employer Contact Person Phone Number |
||
51 |
|
2 |
str |
O |
0222 |
00791 |
Employer Contact Reason |
52 |
|
list[XPN] |
O |
00792 |
Insured’s Contact Person’s Name |
||
53 |
|
list[XTN] |
O |
00793 |
Insured’s Contact Person Phone Number |
||
54 |
|
2 |
list[str] |
O |
0222 |
00794 |
Insured’s Contact Person Reason |
55 |
|
8 |
str |
O |
00795 |
Relationship To The Patient Start Date |
|
56 |
|
8 |
list[str] |
O |
00796 |
Relationship To The Patient Stop Date |
|
57 |
|
2 |
str |
O |
0232 |
00797 |
Insurance Co. Contact Reason |
58 |
|
O |
00798 |
Insurance Co Contact Phone Number |
|||
59 |
|
2 |
str |
O |
0312 |
00799 |
Policy Scope |
60 |
|
2 |
str |
O |
0313 |
00800 |
Policy Source |
61 |
|
O |
00801 |
Patient Member Number |
|||
62 |
|
O |
0063 |
00802 |
Guarantor’s Relationship To Insured |
||
63 |
|
list[XTN] |
O |
00803 |
Insured’s Phone Number - Home |
||
64 |
|
list[XTN] |
O |
00804 |
Insured’s Employer Phone Number |
||
65 |
|
O |
0343 |
00805 |
Military Handicapped Program |
||
66 |
|
1 |
str |
O |
0136 |
00806 |
Suspend Flag |
67 |
|
1 |
str |
O |
0136 |
00807 |
Copay Limit Flag |
68 |
|
1 |
str |
O |
0136 |
00808 |
Stoploss Limit Flag |
69 |
|
list[XON] |
O |
00809 |
Insured Organization Name And ID |
||
70 |
|
list[XON] |
O |
00810 |
Insured Employer Organization Name And ID |
||
71 |
|
list[CE] |
O |
0005 |
00113 |
Race |
|
72 |
|
O |
0344 |
00811 |
HCFA Patient’s Relationship to Insured |
IN3: IN3 - insurance additional information, certification segment¶
Section 6.4.8
- class hl7types.hl7.v2_3_1.segments.IN3.IN3
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00502 |
Set ID - IN3 |
|
2 |
|
O |
00503 |
Certification Number |
|||
3 |
|
list[XCN] |
O |
00504 |
Certified By |
||
4 |
|
1 |
str |
O |
0136 |
00505 |
Certification Required |
5 |
|
O |
0148 |
00506 |
Penalty |
||
6 |
|
O |
00507 |
Certification Date/Time |
|||
7 |
|
O |
00508 |
Certification Modify Date/Time |
|||
8 |
|
list[XCN] |
O |
00509 |
Operator |
||
9 |
|
8 |
str |
O |
00510 |
Certification Begin Date |
|
10 |
|
8 |
str |
O |
00511 |
Certification End Date |
|
11 |
|
O |
0149 |
00512 |
Days |
||
12 |
|
O |
0233 |
00513 |
Non-Concur Code/Description |
||
13 |
|
O |
00514 |
Non-Concur Effective Date/Time |
|||
14 |
|
list[XCN] |
O |
0010 |
00515 |
Physician Reviewer |
|
15 |
|
48 |
str |
O |
00516 |
Certification Contact |
|
16 |
|
list[XTN] |
O |
00517 |
Certification Contact Phone Number |
||
17 |
|
O |
0345 |
00518 |
Appeal Reason |
||
18 |
|
O |
0346 |
00519 |
Certification Agency |
||
19 |
|
list[XTN] |
O |
00520 |
Certification Agency Phone Number |
||
20 |
|
list[PCF] |
O |
0150 |
00521 |
Pre-Certification Req/Window |
|
21 |
|
48 |
str |
O |
00522 |
Case Manager |
|
22 |
|
8 |
str |
O |
00523 |
Second Opinion Date |
|
23 |
|
1 |
str |
O |
0151 |
00524 |
Second Opinion Status |
24 |
|
1 |
list[str] |
O |
0152 |
00525 |
Second Opinion Documentation Received |
25 |
|
list[XCN] |
O |
0010 |
00526 |
Second Opinion Physician |
LCC: LCC - location charge code segment¶
Section 8.8.6
- class hl7types.hl7.v2_3_1.segments.LCC.LCC
LCH: LCH - location characteristic segment¶
Section 8.8.3
- class hl7types.hl7.v2_3_1.segments.LCH.LCH
LDP: LDP - location department segment¶
Section 8.8.5
- class hl7types.hl7.v2_3_1.segments.LDP.LDP
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00963 |
Primary Key Value - LDP |
|||
2 |
|
10 |
str |
R |
0264 |
00964 |
Location Department |
3 |
|
3 |
list[str] |
O |
0069 |
00965 |
Location Service |
4 |
|
list[CE] |
O |
0265 |
00966 |
Specialty Type |
|
5 |
|
1 |
list[str] |
O |
0004 |
00967 |
Valid Patient Classes |
6 |
|
1 |
str |
O |
0183 |
00675 |
Active/Inactive Flag |
7 |
|
O |
00969 |
Activation Date LDP |
|||
8 |
|
O |
00970 |
Inactivation Date - LDP |
|||
9 |
|
80 |
str |
O |
00971 |
Inactivated Reason |
|
10 |
|
list[VH] |
O |
0267 |
00976 |
Visiting Hours |
|
11 |
|
O |
00978 |
Contact Phone |
LOC: LOC - location identification segment¶
Section 8.8.2
- class hl7types.hl7.v2_3_1.segments.LOC.LOC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01307 |
Primary Key Value - LOC |
|||
2 |
|
48 |
str |
O |
00944 |
Location Description |
|
3 |
|
2 |
list[str] |
R |
0260 |
00945 |
Location Type - LOC |
4 |
|
list[XON] |
O |
00947 |
Organization Name - LOC |
||
5 |
|
list[XAD] |
O |
00948 |
Location Address |
||
6 |
|
list[XTN] |
O |
00949 |
Location Phone |
||
7 |
|
list[CE] |
O |
00951 |
License Number |
||
8 |
|
3 |
list[str] |
O |
0261 |
00953 |
Location Equipment |
LRL: LRL - location relationship segment¶
Section 8.8.4
- class hl7types.hl7.v2_3_1.segments.LRL.LRL
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00943 |
Primary Key Value - LRL |
|||
2 |
|
3 |
str |
O |
0206 |
00763 |
Segment Action Code |
3 |
|
O |
00764 |
Segment Unique Key |
|||
4 |
|
O |
0325 |
01277 |
Location Relationship ID |
||
5 |
|
list[XON] |
C |
01301 |
Organizational Location Relationship Value |
||
6 |
|
C |
01292 |
Patient Location Relationship Value |
MFA: MFA - master file acknowledgment segment¶
Section 8.4.3
- class hl7types.hl7.v2_3_1.segments.MFA.MFA
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
3 |
str |
R |
0180 |
00664 |
Record-Level Event Code |
2 |
|
20 |
str |
C |
00665 |
MFN Control ID |
|
3 |
|
O |
00668 |
Event Completion Date/Time |
|||
4 |
|
R |
0181 |
00669 |
MFN Record Level Error Return |
||
5 |
|
list[CE] |
R |
01308 |
Primary Key Value – MFA |
||
6 |
|
3 |
list[str] |
R |
0355 |
01320 |
Primary Key Value Type - MFA |
MFE: MFE - master file entry segment¶
Section 8.4.2
- class hl7types.hl7.v2_3_1.segments.MFE.MFE
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
3 |
str |
R |
0180 |
00664 |
Record-Level Event Code |
2 |
|
20 |
str |
C |
00665 |
MFN Control ID |
|
3 |
|
O |
00662 |
Effective Date/Time |
|||
4 |
|
list[str] |
R |
00667 |
Primary Key Value - MFE |
||
5 |
|
3 |
list[str] |
R |
0355 |
01319 |
Primary Key Value Type |
MFI: MFI - master file identification segment¶
Section 8.4.1
- class hl7types.hl7.v2_3_1.segments.MFI.MFI
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
0175 |
00658 |
Master File Identifier |
||
2 |
|
O |
00659 |
Master File Application Identifier |
|||
3 |
|
3 |
str |
R |
0178 |
00660 |
File-Level Event Code |
4 |
|
O |
00661 |
Entered Date/Time |
|||
5 |
|
O |
00662 |
Effective Date/Time |
|||
6 |
|
2 |
str |
R |
0179 |
00663 |
Response Level Code |
MRG: MRG - merge patient information segment-¶
Section 3.3.8
- class hl7types.hl7.v2_3_1.segments.MRG.MRG
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[CX] |
R |
00211 |
Prior Patient Identifier List |
||
2 |
|
list[CX] |
O |
00212 |
Prior Alternate Patient ID |
||
3 |
|
O |
00213 |
Prior Patient Account Number |
|||
4 |
|
O |
00214 |
Prior Patient ID |
|||
5 |
|
O |
01279 |
Prior Visit Number |
|||
6 |
|
O |
01280 |
Prior Alternate Visit ID |
|||
7 |
|
list[XPN] |
O |
01281 |
Prior Patient Name |
MSA: MSA - message acknowledgment segment¶
Section 2.24.2
- class hl7types.hl7.v2_3_1.segments.MSA.MSA
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
str |
R |
0008 |
00018 |
Acknowledgement Code |
2 |
|
20 |
str |
R |
00010 |
Message Control ID |
|
3 |
|
80 |
str |
O |
00020 |
Text Message |
|
4 |
|
15 |
str |
O |
00021 |
Expected Sequence Number |
|
5 |
|
1 |
str |
O |
0102 |
00022 |
Delayed Acknowledgment Type |
6 |
|
O |
00023 |
Error Condition |
MSH: MSH - message header segment¶
Section 2.24.1
- class hl7types.hl7.v2_3_1.segments.MSH.MSH
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
1 |
str |
R |
00001 |
Field Separator |
|
2 |
|
4 |
str |
R |
00002 |
Encoding Characters |
|
3 |
|
O |
0361 |
00003 |
Sending Application |
||
4 |
|
O |
0362 |
00004 |
Sending Facility |
||
5 |
|
O |
0361 |
00005 |
Receiving Application |
||
6 |
|
O |
0362 |
00006 |
Receiving Facility |
||
7 |
|
O |
00007 |
Date/Time Of Message |
|||
8 |
|
40 |
str |
O |
00008 |
Security |
|
9 |
|
R |
0076 |
00009 |
Message Type |
||
10 |
|
20 |
str |
R |
00010 |
Message Control ID |
|
11 |
|
R |
00011 |
Processing ID |
|||
12 |
|
R |
0104 |
00012 |
Version ID |
||
13 |
|
15 |
str |
O |
00013 |
Sequence Number |
|
14 |
|
180 |
str |
O |
00014 |
Continuation Pointer |
|
15 |
|
2 |
str |
O |
0155 |
00015 |
Accept Acknowledgment Type |
16 |
|
2 |
str |
O |
0155 |
00016 |
Application Acknowledgment Type |
17 |
|
2 |
str |
O |
00017 |
Country Code |
|
18 |
|
16 |
list[str] |
O |
0211 |
00692 |
Character Set |
19 |
|
O |
00693 |
Principal Language Of Message |
|||
20 |
|
20 |
str |
O |
0356 |
01317 |
Alternate Character Set Handling Scheme |
NCK: System Clock¶
Section C.2.1.2
- class hl7types.hl7.v2_3_1.segments.NCK.NCK
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
O |
01172 |
System Date/Time |
NK1: NK1 - next of kin / associated parties segment-¶
Section 3.3.5
- class hl7types.hl7.v2_3_1.segments.NK1.NK1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00190 |
Set ID - NK1 |
|
2 |
|
list[XPN] |
O |
00191 |
Name |
||
3 |
|
O |
0063 |
00192 |
Relationship |
||
4 |
|
list[XAD] |
O |
00193 |
Address |
||
5 |
|
list[XTN] |
O |
00194 |
Phone Number |
||
6 |
|
list[XTN] |
O |
00195 |
Business Phone Number |
||
7 |
|
O |
0131 |
00196 |
Contact Role |
||
8 |
|
8 |
str |
O |
00197 |
Start Date |
|
9 |
|
8 |
str |
O |
00198 |
End Date |
|
10 |
|
60 |
str |
O |
00199 |
Next of Kin / Associated Parties Job Title |
|
11 |
|
O |
0327 |
00200 |
Next of Kin / Associated Parties Job Code/Class |
||
12 |
|
O |
00201 |
Next of Kin / Associated Parties Employee Number |
|||
13 |
|
list[XON] |
O |
00202 |
Organization Name - NK1 |
||
14 |
|
O |
0002 |
00119 |
Marital Status |
||
15 |
|
1 |
str |
O |
0001 |
00111 |
Sex |
16 |
|
O |
00110 |
Date/Time Of Birth |
|||
17 |
|
2 |
list[str] |
O |
0223 |
00755 |
Living Dependency |
18 |
|
2 |
list[str] |
O |
0009 |
00145 |
Ambulatory Status |
19 |
|
list[CE] |
O |
0171 |
00129 |
Citizenship |
|
20 |
|
O |
0296 |
00118 |
Primary Language |
||
21 |
|
2 |
str |
O |
0220 |
00742 |
Living Arrangement |
22 |
|
O |
0215 |
00743 |
Publicity Code |
||
23 |
|
1 |
str |
O |
0136 |
00744 |
Protection Indicator |
24 |
|
2 |
str |
O |
0231 |
00745 |
Student Indicator |
25 |
|
O |
0006 |
00120 |
Religion |
||
26 |
|
list[XPN] |
O |
00109 |
Mother’s Maiden Name |
||
27 |
|
O |
0212 |
00739 |
Nationality |
||
28 |
|
list[CE] |
O |
0189 |
00125 |
Ethnic Group |
|
29 |
|
list[CE] |
O |
0222 |
00747 |
Contact Reason |
|
30 |
|
list[XPN] |
O |
00748 |
Contact Person’s Name |
||
31 |
|
list[XTN] |
O |
00749 |
Contact Person’s Telephone Number |
||
32 |
|
list[XAD] |
O |
00750 |
Contact Person’s Address |
||
33 |
|
list[CX] |
O |
00751 |
Next of Kin/Associated Party’s Identifiers |
||
34 |
|
2 |
str |
O |
0311 |
00752 |
Job Status |
35 |
|
list[CE] |
O |
0005 |
00113 |
Race |
|
36 |
|
2 |
str |
O |
0295 |
00753 |
Handicap |
37 |
|
16 |
str |
O |
00754 |
Contact Person Social Security Number |
NPU: NPU - bed status update segment¶
Section 3.3.7
- class hl7types.hl7.v2_3_1.segments.NPU.NPU
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00209 |
Bed Location |
|||
2 |
|
1 |
str |
O |
0116 |
00170 |
Bed Status |
NSC: Application status change¶
Section C.2.3.10
- class hl7types.hl7.v2_3_1.segments.NSC.NSC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
str |
O |
0333 |
01188 |
Network Change Type |
|
2 |
|
str |
O |
01189 |
Current CPU |
||
3 |
|
str |
O |
01190 |
Current Fileserver |
||
4 |
|
str |
O |
01191 |
Current Application |
||
5 |
|
str |
O |
01192 |
Current Facility |
||
6 |
|
str |
O |
01193 |
New CPU |
||
7 |
|
str |
O |
01194 |
New Fileserver |
||
8 |
|
str |
O |
01195 |
New Application |
||
9 |
|
str |
O |
01196 |
New Facility |
NST: Application control level statistics¶
Section C.2.2.16
- class hl7types.hl7.v2_3_1.segments.NST.NST
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
str |
O |
0136 |
01173 |
Statistics Available |
|
2 |
|
str |
O |
01174 |
Source Identifier |
||
3 |
|
str |
O |
01175 |
Source Type |
||
4 |
|
O |
01176 |
Statistics Start |
|||
5 |
|
O |
01177 |
Statistics End |
|||
6 |
|
str |
O |
01178 |
Receive Character Count |
||
7 |
|
str |
O |
01179 |
Send Character Count |
||
8 |
|
str |
O |
01180 |
Messages Received |
||
9 |
|
str |
O |
01181 |
Messages Sent |
||
10 |
|
str |
O |
01182 |
Checksum Errors Received |
||
11 |
|
str |
O |
01183 |
Length Errors Received |
||
12 |
|
str |
O |
01184 |
Other Errors Received |
||
13 |
|
str |
O |
01185 |
Connect Timeouts |
||
14 |
|
str |
O |
01186 |
Receive Timeouts |
||
15 |
|
str |
O |
01187 |
Network Errors |
NTE: NTE - notes and comments segment¶
Section 2.24.15
- class hl7types.hl7.v2_3_1.segments.NTE.NTE
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00096 |
Set ID - NTE |
|
2 |
|
8 |
str |
O |
0105 |
00097 |
Source of Comment |
3 |
|
list[str] |
O |
00098 |
Comment |
||
4 |
|
O |
0364 |
01318 |
Comment Type |
OBR: OBR - observation request segment¶
Section 7.3.1
- class hl7types.hl7.v2_3_1.segments.OBR.OBR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00237 |
Set ID - OBR |
|
2 |
|
C |
00216 |
Placer Order Number |
|||
3 |
|
C |
00217 |
Filler Order Number |
|||
4 |
|
R |
00238 |
Universal Service ID |
|||
5 |
|
2 |
str |
X |
00239 |
Priority-OBR |
|
6 |
|
X |
00240 |
Requested Date/time |
|||
7 |
|
C |
00241 |
Observation Date/Time # |
|||
8 |
|
O |
00242 |
Observation End Date/Time # |
|||
9 |
|
O |
00243 |
Collection Volume * |
|||
10 |
|
list[XCN] |
O |
00244 |
Collector Identifier * |
||
11 |
|
1 |
str |
O |
0065 |
00245 |
Specimen Action Code * |
12 |
|
O |
00246 |
Danger Code |
|||
13 |
|
300 |
str |
O |
00247 |
Relevant Clinical Info. |
|
14 |
|
C |
00248 |
Specimen Received Date/Time * |
|||
15 |
|
O |
0070 |
00249 |
Specimen Source |
||
16 |
|
list[XCN] |
O |
00226 |
Ordering Provider |
||
17 |
|
list[XTN] |
O |
00250 |
Order Callback Phone Number |
||
18 |
|
60 |
str |
O |
00251 |
Placer Field 1 |
|
19 |
|
60 |
str |
O |
00252 |
Placer Field 2 |
|
20 |
|
60 |
str |
O |
00253 |
Filler Field 1 + |
|
21 |
|
60 |
str |
O |
00254 |
Filler Field 2 + |
|
22 |
|
C |
00255 |
Results Rpt/Status Chng - Date/Time + |
|||
23 |
|
O |
00256 |
Charge to Practice + |
|||
24 |
|
10 |
str |
O |
0074 |
00257 |
Diagnostic Serv Sect ID |
25 |
|
1 |
str |
C |
0123 |
00258 |
Result Status + |
26 |
|
O |
00259 |
Parent Result + |
|||
27 |
|
list[TQ] |
O |
00221 |
Quantity/Timing |
||
28 |
|
list[XCN] |
O |
00260 |
Result Copies To |
||
29 |
|
O |
00261 |
Parent |
|||
30 |
|
20 |
str |
O |
0124 |
00262 |
Transportation Mode |
31 |
|
list[CE] |
O |
00263 |
Reason for Study |
||
32 |
|
O |
00264 |
Principal Result Interpreter + |
|||
33 |
|
list[NDL] |
O |
00265 |
Assistant Result Interpreter + |
||
34 |
|
list[NDL] |
O |
00266 |
Technician + |
||
35 |
|
list[NDL] |
O |
00267 |
Transcriptionist + |
||
36 |
|
O |
00268 |
Scheduled Date/Time + |
|||
37 |
|
4 |
str |
O |
01028 |
Number of Sample Containers * |
|
38 |
|
list[CE] |
O |
01029 |
Transport Logistics of Collected Sample * |
||
39 |
|
list[CE] |
O |
01030 |
Collector’s Comment * |
||
40 |
|
O |
01031 |
Transport Arrangement Responsibility |
|||
41 |
|
30 |
str |
O |
0224 |
01032 |
Transport Arranged |
42 |
|
1 |
str |
O |
0225 |
01033 |
Escort Required |
43 |
|
list[CE] |
O |
01034 |
Planned Patient Transport Comment |
||
44 |
|
O |
0088 |
00393 |
Procedure Code |
||
45 |
|
list[CE] |
O |
0340 |
01316 |
Procedure Code Modifier |
OBX: OBX - observation/result segment¶
Section 9.5.2
- class hl7types.hl7.v2_3_1.segments.OBX.OBX
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00569 |
Set ID - OBX |
|
2 |
|
3 |
str |
C |
0125 |
00570 |
Value Type |
3 |
|
R |
00571 |
Observation Identifier |
|||
4 |
|
20 |
str |
C |
00572 |
Observation Sub-ID |
|
5 |
|
list[str] |
C |
00573 |
Observation Value |
||
6 |
|
O |
00574 |
Units |
|||
7 |
|
60 |
str |
O |
00575 |
References Range |
|
8 |
|
5 |
list[str] |
O |
0078 |
00576 |
Abnormal Flags |
9 |
|
5 |
list[str] |
O |
00577 |
Probability |
|
10 |
|
2 |
str |
O |
0080 |
00578 |
Nature of Abnormal Test |
11 |
|
1 |
str |
R |
0085 |
00579 |
Observation Result Status |
12 |
|
O |
00580 |
Date Last Obs Normal Values |
|||
13 |
|
20 |
str |
O |
00581 |
User Defined Access Checks |
|
14 |
|
O |
00582 |
Date/Time of the Observation |
|||
15 |
|
O |
00583 |
Producer’s ID |
|||
16 |
|
list[XCN] |
O |
00584 |
Responsible Observer |
||
17 |
|
list[CE] |
O |
00936 |
Observation Method |
ODS: ODS - dietary orders, supplements, and preferences segment¶
Section 4.6.1
- class hl7types.hl7.v2_3_1.segments.ODS.ODS
ODT: ODT - diet tray instructions segment¶
Section 4.6.2
- class hl7types.hl7.v2_3_1.segments.ODT.ODT
OM1: OM1 - general segment (fields that apply to most observations)¶
Section 8.7.3
- class hl7types.hl7.v2_3_1.segments.OM1.OM1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
O |
00587 |
Producer’s Test/Observation ID |
|||
3 |
|
12 |
list[str] |
O |
0125 |
00588 |
Permitted Data Types |
4 |
|
1 |
str |
O |
0136 |
00589 |
Specimen Required |
5 |
|
O |
00590 |
Producer ID |
|||
6 |
|
str |
O |
00591 |
Observation Description |
||
7 |
|
O |
00592 |
Other Test/Observation IDs for the Observation |
|||
8 |
|
200 |
list[str] |
O |
00593 |
Other Names |
|
9 |
|
30 |
str |
O |
00594 |
Preferred Report Name for the Observation |
|
10 |
|
8 |
str |
O |
00595 |
Preferred Short Name or Mnemonic for Observation |
|
11 |
|
200 |
str |
O |
00596 |
Preferred Long Name for the Observation |
|
12 |
|
1 |
str |
O |
0136 |
00597 |
Orderability |
13 |
|
list[CE] |
O |
00598 |
Identity of Instrument Used to Perform this Study |
||
14 |
|
list[CE] |
O |
00599 |
Coded Representation of Method |
||
15 |
|
1 |
str |
O |
0136 |
00600 |
Portable |
16 |
|
list[CE] |
O |
00601 |
Observation Producing Department/Section |
||
17 |
|
O |
00602 |
Telephone Number of Section |
|||
18 |
|
1 |
str |
R |
0174 |
00603 |
Nature of Test/Observation |
19 |
|
O |
00604 |
Report Subheader |
|||
20 |
|
20 |
str |
O |
00605 |
Report Display Order |
|
21 |
|
O |
00606 |
Date/Time Stamp for any change in Definition for the Observation |
|||
22 |
|
O |
00607 |
Effective Date/Time of Change |
|||
23 |
|
20 |
str |
O |
00608 |
Typical Turn-Around Time |
|
24 |
|
20 |
str |
O |
00609 |
Processing Time |
|
25 |
|
40 |
list[str] |
O |
0168 |
00610 |
Processing Priority |
26 |
|
5 |
str |
O |
0169 |
00611 |
Reporting Priority |
27 |
|
list[CE] |
O |
00612 |
Outside Site(s) Where Observation may be Performed |
||
28 |
|
list[XAD] |
O |
00613 |
Address of Outside Site(s) |
||
29 |
|
O |
00614 |
Phone Number of Outside Site |
|||
30 |
|
1 |
str |
O |
0177 |
00615 |
Confidentiality Code |
31 |
|
O |
00616 |
Observations Required to Interpret the Obs |
|||
32 |
|
str |
O |
00617 |
Interpretation of Observations |
||
33 |
|
O |
00618 |
Contraindications to Observations |
|||
34 |
|
list[CE] |
O |
00619 |
Reflex Tests/Observations |
||
35 |
|
str |
O |
00620 |
Rules that Trigger Reflex Testing |
||
36 |
|
O |
00621 |
Fixed Canned Message |
|||
37 |
|
str |
O |
00622 |
Patient Preparation |
||
38 |
|
O |
00623 |
Procedure Medication |
|||
39 |
|
str |
O |
00624 |
Factors that may Effect the Observation |
||
40 |
|
60 |
list[str] |
O |
00625 |
Test/Observation Performance Schedule |
|
41 |
|
str |
O |
00626 |
Description of Test Methods |
||
42 |
|
O |
0254 |
00937 |
Kind of Quantity Observed |
||
43 |
|
O |
0255 |
00938 |
Point Versus Interval |
||
44 |
|
str |
O |
0256 |
00939 |
Challenge Information |
|
45 |
|
O |
0258 |
00940 |
Relationship Modifier |
||
46 |
|
O |
00941 |
Target Anatomic Site Of Test |
|||
47 |
|
O |
0259 |
00942 |
Modality Of Imaging Measurement |
OM2: OM2 - numeric observation segment¶
Section 8.7.4
- class hl7types.hl7.v2_3_1.segments.OM2.OM2
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
O |
00627 |
Units of Measure |
|||
3 |
|
10 |
list[str] |
O |
00628 |
Range of Decimal Precision |
|
4 |
|
O |
00629 |
Corresponding SI Units of Measure |
|||
5 |
|
str |
O |
00630 |
SI Conversion Factor |
||
6 |
|
O |
00631 |
Reference (Normal) Range - Ordinal & Continuous Obs |
|||
7 |
|
O |
00632 |
Critical Range for Ordinal & Continuous Obs |
|||
8 |
|
O |
00633 |
Absolute Range for Ordinal & Continuous Obs |
|||
9 |
|
list[DLT] |
O |
00634 |
Delta Check Criteria |
||
10 |
|
20 |
str |
O |
00635 |
Minimum Meaningful Increments |
OM3: OM3 - categorical test/observation segment¶
Section 8.7.5
- class hl7types.hl7.v2_3_1.segments.OM3.OM3
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
O |
00636 |
Preferred Coding System |
|||
3 |
|
O |
00637 |
Valid Coded “Answers” |
|||
4 |
|
list[CE] |
O |
00638 |
Normal Text/Codes for Categorical Observations |
||
5 |
|
O |
00639 |
Abnormal Text/Codes for Categorical Observations |
|||
6 |
|
O |
00640 |
Critical Text Codes for Categorical Observations |
|||
7 |
|
3 |
str |
O |
0125 |
00570 |
Value Type |
OM4: OM4 - observations that require specimens segment¶
Section 8.7.6
- class hl7types.hl7.v2_3_1.segments.OM4.OM4
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
1 |
str |
O |
0170 |
00642 |
Derived Specimen |
3 |
|
str |
O |
00643 |
Container Description |
||
4 |
|
20 |
str |
O |
00644 |
Container Volume |
|
5 |
|
O |
00645 |
Container Units |
|||
6 |
|
O |
00646 |
Specimen |
|||
7 |
|
O |
00647 |
Additive |
|||
8 |
|
str |
O |
00648 |
Preparation |
||
9 |
|
str |
O |
00649 |
Special Handling Requirements |
||
10 |
|
O |
00650 |
Normal Collection Volume |
|||
11 |
|
O |
00651 |
Minimum Collection Volume |
|||
12 |
|
str |
O |
00652 |
Specimen Requirements |
||
13 |
|
1 |
list[str] |
O |
0027 |
00653 |
Specimen Priorities |
14 |
|
O |
00654 |
Specimen Retention Time |
OM5: OM5 - observation batteries (sets) segment¶
Section 8.7.7
- class hl7types.hl7.v2_3_1.segments.OM5.OM5
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
list[CE] |
O |
00655 |
Test/Observations Included within an Ordered Test Battery |
||
3 |
|
200 |
str |
O |
00656 |
Observation ID Suffixes |
OM6: OM6 - Observations that are calculated from other observations segment¶
Section 8.7.8
- class hl7types.hl7.v2_3_1.segments.OM6.OM6
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00586 |
Sequence Number - Test/Observation Master File |
|
2 |
|
str |
O |
00657 |
Derivation Rule |
ORC: ORC - common order segment¶
Section 4.3.1
- class hl7types.hl7.v2_3_1.segments.ORC.ORC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
str |
O |
0119 |
00215 |
Order Control |
2 |
|
O |
00216 |
Placer Order Number |
|||
3 |
|
O |
00217 |
Filler Order Number |
|||
4 |
|
O |
00218 |
Placer Group Number |
|||
5 |
|
2 |
str |
O |
0038 |
00219 |
Order Status |
6 |
|
1 |
str |
O |
0121 |
00220 |
Response Flag |
7 |
|
O |
00221 |
Quantity/Timing |
|||
8 |
|
O |
00222 |
Parent |
|||
9 |
|
O |
00223 |
Date/Time of Transaction |
|||
10 |
|
list[XCN] |
O |
00224 |
Entered By |
||
11 |
|
list[XCN] |
O |
00225 |
Verified By |
||
12 |
|
list[XCN] |
O |
00226 |
Ordering Provider |
||
13 |
|
O |
00227 |
Enterer’s Location |
|||
14 |
|
list[XTN] |
O |
00228 |
Call Back Phone Number |
||
15 |
|
O |
00229 |
Order Effective Date/Time |
|||
16 |
|
O |
00230 |
Order Control Code Reason |
|||
17 |
|
O |
00231 |
Entering Organization |
|||
18 |
|
O |
00232 |
Entering Device |
|||
19 |
|
list[XCN] |
O |
00233 |
Action By |
||
20 |
|
O |
0339 |
01310 |
Advanced Beneficiary Notice Code |
||
21 |
|
list[XON] |
O |
01311 |
Ordering Facility Name |
||
22 |
|
list[XAD] |
O |
01312 |
Ordering Facility Address |
||
23 |
|
list[XTN] |
O |
01313 |
Ordering Facility Phone Number |
||
24 |
|
list[XAD] |
O |
01314 |
Ordering Provider Address |
PCR: PCR - possible causal relationship segment¶
Section 7.11.3
- class hl7types.hl7.v2_3_1.segments.PCR.PCR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01098 |
Implicated Product |
|||
2 |
|
1 |
str |
O |
0249 |
01099 |
Generic Product |
3 |
|
O |
01100 |
Product Class |
|||
4 |
|
O |
01101 |
Total Duration Of Therapy |
|||
5 |
|
O |
01102 |
Product Manufacture Date |
|||
6 |
|
O |
01103 |
Product Expiration Date |
|||
7 |
|
O |
01104 |
Product Implantation Date |
|||
8 |
|
O |
01105 |
Product Explantation Date |
|||
9 |
|
8 |
str |
O |
0244 |
01106 |
Single Use Device |
10 |
|
O |
01107 |
Indication For Product Use |
|||
11 |
|
8 |
str |
O |
0245 |
01108 |
Product Problem |
12 |
|
30 |
list[str] |
O |
01109 |
Product Serial/Lot Number |
|
13 |
|
1 |
str |
O |
0246 |
01110 |
Product Available For Inspection |
14 |
|
O |
01111 |
Product Evaluation Performed |
|||
15 |
|
O |
0247 |
01112 |
Product Evaluation Status |
||
16 |
|
O |
01113 |
Product Evaluation Results |
|||
17 |
|
8 |
str |
O |
0248 |
01114 |
Evaluated Product Source |
18 |
|
O |
01115 |
Date Product Returned To Manufacturer |
|||
19 |
|
1 |
str |
O |
0242 |
01116 |
Device Operator Qualifications |
20 |
|
1 |
str |
O |
0250 |
01117 |
Relatedness Assessment |
21 |
|
2 |
list[str] |
O |
0251 |
01118 |
Action Taken In Response To The Event |
22 |
|
2 |
list[str] |
O |
0252 |
01119 |
Event Causality Observations |
23 |
|
1 |
list[str] |
O |
0253 |
01120 |
Indirect Exposure Mechanism |
PD1: PD1 - patient additional demographic segment¶
Section 3.3.9
- class hl7types.hl7.v2_3_1.segments.PD1.PD1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
list[str] |
O |
0223 |
00755 |
Living Dependency |
2 |
|
2 |
str |
O |
0220 |
00742 |
Living Arrangement |
3 |
|
list[XON] |
O |
00756 |
Patient Primary Facility |
||
4 |
|
list[XCN] |
O |
00757 |
Patient Primary Care Provider Name & ID No. |
||
5 |
|
2 |
str |
O |
0231 |
00745 |
Student Indicator |
6 |
|
2 |
str |
O |
0295 |
00753 |
Handicap |
7 |
|
2 |
str |
O |
0315 |
00759 |
Living Will |
8 |
|
2 |
str |
O |
0316 |
00760 |
Organ Donor |
9 |
|
1 |
str |
O |
0136 |
00761 |
Separate Bill |
10 |
|
list[CX] |
O |
00762 |
Duplicate Patient |
||
11 |
|
O |
0215 |
00743 |
Publicity Code |
||
12 |
|
1 |
str |
O |
0136 |
00744 |
Protection Indicator |
PDC: PDC - product detail country segment¶
Section 7.11.5
- class hl7types.hl7.v2_3_1.segments.PDC.PDC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[XON] |
R |
01247 |
Manufacturer/Distributor |
||
2 |
|
R |
01248 |
Country |
|||
3 |
|
60 |
str |
R |
01249 |
Brand Name |
|
4 |
|
60 |
str |
O |
01250 |
Device Family Name |
|
5 |
|
O |
01251 |
Generic Name |
|||
6 |
|
60 |
list[str] |
O |
01252 |
Model Identifier |
|
7 |
|
60 |
str |
O |
01253 |
Catalogue Identifier |
|
8 |
|
60 |
list[str] |
O |
01254 |
Other Identifier |
|
9 |
|
O |
01255 |
Product Code |
|||
10 |
|
4 |
str |
O |
0330 |
01256 |
Marketing Basis |
11 |
|
60 |
str |
O |
01257 |
Marketing Approval ID |
|
12 |
|
O |
01258 |
Labeled Shelf Life |
|||
13 |
|
O |
01259 |
Expected Shelf Life |
|||
14 |
|
O |
01260 |
Date First Marketed |
|||
15 |
|
O |
01261 |
Date Last Marketed |
PEO: PEO - product experience observation segment¶
Section 7.11.2
- class hl7types.hl7.v2_3_1.segments.PEO.PEO
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[CE] |
O |
01073 |
Event Identifiers Used |
||
2 |
|
list[CE] |
O |
01074 |
Event Symptom/Diagnosis Code |
||
3 |
|
R |
01075 |
Event Onset Date/Time |
|||
4 |
|
O |
01076 |
Event Exacerbation Date/Time |
|||
5 |
|
O |
01077 |
Event Improved Date/Time |
|||
6 |
|
O |
01078 |
Event Ended Data/Time |
|||
7 |
|
list[XAD] |
O |
01079 |
Event Location Occurred Address |
||
8 |
|
1 |
list[str] |
O |
0237 |
01080 |
Event Qualification |
9 |
|
1 |
str |
O |
0238 |
01081 |
Event Serious |
10 |
|
1 |
str |
O |
0239 |
01082 |
Event Expected |
11 |
|
1 |
list[str] |
O |
0240 |
01083 |
Event Outcome |
12 |
|
1 |
str |
O |
0241 |
01084 |
Patient Outcome |
13 |
|
list[str] |
O |
01085 |
Event Description From Others |
||
14 |
|
list[str] |
O |
01086 |
Event From Original Reporter |
||
15 |
|
list[str] |
O |
01087 |
Event Description From Patient |
||
16 |
|
list[str] |
O |
01088 |
Event Description From Practitioner |
||
17 |
|
list[str] |
O |
01089 |
Event Description From Autopsy |
||
18 |
|
list[CE] |
O |
01090 |
Cause Of Death |
||
19 |
|
list[XPN] |
O |
01091 |
Primary Observer Name |
||
20 |
|
list[XAD] |
O |
01092 |
Primary Observer Address |
||
21 |
|
list[XTN] |
O |
01093 |
Primary Observer Telephone |
||
22 |
|
1 |
str |
O |
0242 |
01094 |
Primary Observer’s Qualification |
23 |
|
1 |
str |
O |
0242 |
01095 |
Confirmation Provided By |
24 |
|
O |
01096 |
Primary Observer Aware Date/Time |
|||
25 |
|
1 |
str |
O |
0243 |
01097 |
Primary Observer’s identity May Be Divulged |
PES: PES - product experience sender segment¶
Section 7.11.1
- class hl7types.hl7.v2_3_1.segments.PES.PES
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[XON] |
O |
01059 |
Sender Organization Name |
||
2 |
|
list[XCN] |
O |
01060 |
Sender Individual Name |
||
3 |
|
list[XAD] |
O |
01062 |
Sender Address |
||
4 |
|
list[XTN] |
O |
01063 |
Sender Telephone |
||
5 |
|
O |
01064 |
Sender Event Identifier |
|||
6 |
|
2 |
str |
O |
01065 |
Sender Sequence Number |
|
7 |
|
list[str] |
O |
01066 |
Sender Event Description |
||
8 |
|
str |
O |
01067 |
Sender Comment |
||
9 |
|
O |
01068 |
Sender Aware Date/Time |
|||
10 |
|
R |
01069 |
Event Report Date |
|||
11 |
|
3 |
list[str] |
O |
0234 |
01070 |
Event Report Timing/Type |
12 |
|
1 |
str |
O |
0235 |
01071 |
Event Report Source |
13 |
|
1 |
list[str] |
O |
0236 |
01072 |
Event Reported To |
PID: PID - patient identification segment¶
Section 3.3.2
- class hl7types.hl7.v2_3_1.segments.PID.PID
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00104 |
Set ID - PID |
|
2 |
|
O |
00105 |
Patient ID |
|||
3 |
|
list[CX] |
R |
00106 |
Patient Identifier List |
||
4 |
|
list[CX] |
O |
00107 |
Alternate Patient ID - PID |
||
5 |
|
list[XPN] |
R |
00108 |
Patient Name |
||
6 |
|
list[XPN] |
O |
00109 |
Mother’s Maiden Name |
||
7 |
|
O |
00110 |
Date/Time Of Birth |
|||
8 |
|
1 |
str |
O |
0001 |
00111 |
Sex |
9 |
|
list[XPN] |
O |
00112 |
Patient Alias |
||
10 |
|
list[CE] |
O |
0005 |
00113 |
Race |
|
11 |
|
list[XAD] |
O |
00114 |
Patient Address |
||
12 |
|
4 |
str |
O |
0289 |
00115 |
County Code |
13 |
|
list[XTN] |
O |
00116 |
Phone Number - Home |
||
14 |
|
list[XTN] |
O |
00117 |
Phone Number - Business |
||
15 |
|
O |
0296 |
00118 |
Primary Language |
||
16 |
|
O |
0002 |
00119 |
Marital Status |
||
17 |
|
O |
0006 |
00120 |
Religion |
||
18 |
|
O |
00121 |
Patient Account Number |
|||
19 |
|
16 |
str |
O |
00122 |
SSN Number - Patient |
|
20 |
|
O |
00123 |
Driver’s License Number - Patient |
|||
21 |
|
list[CX] |
O |
00124 |
Mother’s Identifier |
||
22 |
|
list[CE] |
O |
0189 |
00125 |
Ethnic Group |
|
23 |
|
60 |
str |
O |
00126 |
Birth Place |
|
24 |
|
1 |
str |
O |
0136 |
00127 |
Multiple Birth Indicator |
25 |
|
2 |
str |
O |
00128 |
Birth Order |
|
26 |
|
list[CE] |
O |
0171 |
00129 |
Citizenship |
|
27 |
|
O |
0172 |
00130 |
Veterans Military Status |
||
28 |
|
O |
0212 |
00739 |
Nationality |
||
29 |
|
O |
00740 |
Patient Death Date and Time |
|||
30 |
|
1 |
str |
O |
0136 |
00741 |
Patient Death Indicator |
PR1: PR1 - procedures segment¶
Section 6.4.4
- class hl7types.hl7.v2_3_1.segments.PR1.PR1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00391 |
Set ID - PR1 |
|
2 |
|
2 |
str |
R |
0089 |
00392 |
Procedure Coding Method |
3 |
|
R |
0088 |
00393 |
Procedure Code |
||
4 |
|
40 |
str |
O |
00394 |
Procedure Description |
|
5 |
|
R |
00395 |
Procedure Date/Time |
|||
6 |
|
2 |
str |
R |
0230 |
00396 |
Procedure Functional Type |
7 |
|
4 |
str |
O |
00397 |
Procedure Minutes |
|
8 |
|
list[XCN] |
O |
0010 |
00398 |
Anesthesiologist |
|
9 |
|
2 |
str |
O |
0019 |
00399 |
Anesthesia Code |
10 |
|
4 |
str |
O |
00400 |
Anesthesia Minutes |
|
11 |
|
list[XCN] |
O |
0010 |
00401 |
Surgeon |
|
12 |
|
list[XCN] |
O |
0010 |
00402 |
Procedure Practitioner |
|
13 |
|
O |
0059 |
00403 |
Consent Code |
||
14 |
|
2 |
str |
O |
00404 |
Procedure Priority |
|
15 |
|
O |
0051 |
00772 |
Associated Diagnosis Code |
||
16 |
|
list[CE] |
O |
0340 |
01316 |
Procedure Code Modifier |
PRA: PRA - practitioner detail segment¶
Section 8.6.3
- class hl7types.hl7.v2_3_1.segments.PRA.PRA
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00685 |
Primary Key Value - PRA |
|||
2 |
|
list[CE] |
O |
0358 |
00686 |
Practitioner Group |
|
3 |
|
3 |
list[str] |
O |
0186 |
00687 |
Practitioner Category |
4 |
|
1 |
str |
O |
0187 |
00688 |
Provider Billing |
5 |
|
list[SPD] |
O |
0337 |
00689 |
Specialty |
|
6 |
|
list[PLN] |
O |
0338 |
00690 |
Practitioner ID Numbers |
|
7 |
|
list[PIP] |
O |
00691 |
Privileges |
||
8 |
|
8 |
str |
O |
01296 |
Date Entered Practice |
PRB: Problem Detail¶
Section 12.3.2
- class hl7types.hl7.v2_3_1.segments.PRB.PRB
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
str |
R |
0287 |
00816 |
Action Code |
2 |
|
R |
00817 |
Action Date/Time |
|||
3 |
|
R |
00838 |
Problem ID |
|||
4 |
|
R |
00839 |
Problem Instance ID |
|||
5 |
|
O |
00820 |
Episode of Care ID |
|||
6 |
|
60 |
str |
O |
00841 |
Problem List Priority |
|
7 |
|
O |
00842 |
Problem Established Date/Time |
|||
8 |
|
O |
00843 |
Anticipated Problem Resolution Date/Time |
|||
9 |
|
O |
00844 |
Actual Problem Resolution Date/Time |
|||
10 |
|
O |
00845 |
Problem Classification |
|||
11 |
|
list[CE] |
O |
00846 |
Problem Management Discipline |
||
12 |
|
O |
00847 |
Problem Persistence |
|||
13 |
|
O |
00848 |
Problem Confirmation Status |
|||
14 |
|
O |
00849 |
Problem Life Cycle Status |
|||
15 |
|
O |
00850 |
Problem Life Cycle Status Date/Time |
|||
16 |
|
O |
00851 |
Problem Date of Onset |
|||
17 |
|
80 |
str |
O |
00852 |
Problem Onset Text |
|
18 |
|
O |
00853 |
Problem Ranking |
|||
19 |
|
O |
00854 |
Certainty of Problem |
|||
20 |
|
5 |
str |
O |
00855 |
Probability of Problem (0-1) |
|
21 |
|
O |
00856 |
Individual Awareness of Problem |
|||
22 |
|
O |
00857 |
Problem Prognosis |
|||
23 |
|
O |
00858 |
Individual Awareness of Prognosis |
|||
24 |
|
200 |
str |
O |
00859 |
Family/Significant Other Awareness of Problem/Prognosis |
|
25 |
|
O |
00823 |
Security/Sensitivity |
PRC: PRC - pricing segment¶
Section 8.9.3
- class hl7types.hl7.v2_3_1.segments.PRC.PRC
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
0132 |
00982 |
Primary Key Value - PRC |
||
2 |
|
list[CE] |
O |
00995 |
Facility ID - PRC |
||
3 |
|
list[CE] |
O |
0184 |
00676 |
Department |
|
4 |
|
1 |
list[str] |
O |
0004 |
00967 |
Valid Patient Classes |
5 |
|
list[CP] |
C |
00998 |
Price |
||
6 |
|
200 |
list[str] |
O |
00999 |
Formula |
|
7 |
|
4 |
str |
O |
01000 |
Minimum Quantity |
|
8 |
|
4 |
str |
O |
01001 |
Maximum Quantity |
|
9 |
|
O |
01002 |
Minimum Price |
|||
10 |
|
O |
01003 |
Maximum Price |
|||
11 |
|
O |
01004 |
Effective Start Date |
|||
12 |
|
O |
01005 |
Effective End Date |
|||
13 |
|
1 |
str |
O |
0268 |
01006 |
Price Override Flag |
14 |
|
list[CE] |
O |
0293 |
01007 |
Billing Category |
|
15 |
|
1 |
str |
O |
0136 |
01008 |
Chargeable Flag |
16 |
|
1 |
str |
O |
0183 |
00675 |
Active/Inactive Flag |
17 |
|
O |
00989 |
Cost |
|||
18 |
|
1 |
str |
O |
0269 |
01009 |
Charge On Indicator |
PRD: Provider Data¶
Section 11.5.3
- class hl7types.hl7.v2_3_1.segments.PRD.PRD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
list[CE] |
R |
0286 |
01155 |
Provider Role |
|
2 |
|
list[XPN] |
O |
01156 |
Provider Name |
||
3 |
|
list[XAD] |
O |
01157 |
Provider Address |
||
4 |
|
O |
01158 |
Provider Location |
|||
5 |
|
list[XTN] |
O |
01159 |
Provider Communication Information |
||
6 |
|
O |
0185 |
00684 |
Preferred Method Of Contact |
||
7 |
|
list[PI] |
O |
01162 |
Provider Identifiers |
||
8 |
|
O |
01163 |
Effective Start Date of Provider Role |
|||
9 |
|
O |
01164 |
Effective End Date of Provider Role |
PSH: PSH - product summary header segment¶
Section 7.11.4
- class hl7types.hl7.v2_3_1.segments.PSH.PSH
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
60 |
str |
R |
01233 |
Report Type |
|
2 |
|
60 |
str |
O |
01297 |
Report Form Identifier |
|
3 |
|
R |
01235 |
Report Date |
|||
4 |
|
O |
01236 |
Report Interval Start Date |
|||
5 |
|
O |
01237 |
Report Interval End Date |
|||
6 |
|
O |
01238 |
Quantity Manufactured |
|||
7 |
|
O |
01239 |
Quantity Distributed |
|||
8 |
|
1 |
str |
O |
0329 |
01240 |
Quantity Distributed Method |
9 |
|
str |
O |
01241 |
Quantity Distributed Comment |
||
10 |
|
O |
01242 |
Quantity in Use |
|||
11 |
|
1 |
str |
O |
0329 |
01243 |
Quantity in Use Method |
12 |
|
str |
O |
01244 |
Quantity in Use Comment |
||
13 |
|
2 |
list[str] |
O |
01245 |
Number of Product Experience Reports Filed by Facility |
|
14 |
|
2 |
list[str] |
O |
01246 |
Number of Product Experience Reports Filed by Distributor |
PTH: Pathway¶
Section 12.3.4
- class hl7types.hl7.v2_3_1.segments.PTH.PTH
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
2 |
str |
R |
0287 |
00816 |
Action Code |
2 |
|
R |
01207 |
Pathway ID |
|||
3 |
|
R |
01208 |
Pathway Instance ID |
|||
4 |
|
R |
01209 |
Pathway Established Date/Time |
|||
5 |
|
O |
01210 |
Pathway Life Cycle Status |
|||
6 |
|
C |
01211 |
Change Pathway Life Cycle Status Date/Time |
PV1: PV1 - patient visit segment-¶
Section 3.3.3.53
- class hl7types.hl7.v2_3_1.segments.PV1.PV1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00131 |
Set ID - PV1 |
|
2 |
|
1 |
str |
R |
0004 |
00132 |
Patient Class |
3 |
|
O |
00133 |
Assigned Patient Location |
|||
4 |
|
2 |
str |
O |
0007 |
00134 |
Admission Type |
5 |
|
O |
00135 |
Preadmit Number |
|||
6 |
|
O |
00136 |
Prior Patient Location |
|||
7 |
|
list[XCN] |
O |
0010 |
00137 |
Attending Doctor |
|
8 |
|
list[XCN] |
O |
0010 |
00138 |
Referring Doctor |
|
9 |
|
list[XCN] |
O |
0010 |
00139 |
Consulting Doctor |
|
10 |
|
3 |
str |
O |
0069 |
00140 |
Hospital Service |
11 |
|
O |
00141 |
Temporary Location |
|||
12 |
|
2 |
str |
O |
0087 |
00142 |
Preadmit Test Indicator |
13 |
|
2 |
str |
O |
0092 |
00143 |
Re-admission Indicator |
14 |
|
3 |
str |
O |
0023 |
00144 |
Admit Source |
15 |
|
2 |
list[str] |
O |
0009 |
00145 |
Ambulatory Status |
16 |
|
2 |
str |
O |
0099 |
00146 |
VIP Indicator |
17 |
|
list[XCN] |
O |
0010 |
00147 |
Admitting Doctor |
|
18 |
|
2 |
str |
O |
0018 |
00148 |
Patient Type |
19 |
|
O |
00149 |
Visit Number |
|||
20 |
|
list[FC] |
O |
0064 |
00150 |
Financial Class |
|
21 |
|
2 |
str |
O |
0032 |
00151 |
Charge Price Indicator |
22 |
|
2 |
str |
O |
0045 |
00152 |
Courtesy Code |
23 |
|
2 |
str |
O |
0046 |
00153 |
Credit Rating |
24 |
|
2 |
list[str] |
O |
0044 |
00154 |
Contract Code |
25 |
|
8 |
list[str] |
O |
00155 |
Contract Effective Date |
|
26 |
|
12 |
list[str] |
O |
00156 |
Contract Amount |
|
27 |
|
3 |
list[str] |
O |
00157 |
Contract Period |
|
28 |
|
2 |
str |
O |
0073 |
00158 |
Interest Code |
29 |
|
1 |
str |
O |
0110 |
00159 |
Transfer to Bad Debt Code |
30 |
|
8 |
str |
O |
00160 |
Transfer to Bad Debt Date |
|
31 |
|
10 |
str |
O |
0021 |
00161 |
Bad Debt Agency Code |
32 |
|
12 |
str |
O |
00162 |
Bad Debt Transfer Amount |
|
33 |
|
12 |
str |
O |
00163 |
Bad Debt Recovery Amount |
|
34 |
|
1 |
str |
O |
0111 |
00164 |
Delete Account Indicator |
35 |
|
8 |
str |
O |
00165 |
Delete Account Date |
|
36 |
|
3 |
str |
O |
0112 |
00166 |
Discharge Disposition |
37 |
|
O |
0113 |
00167 |
Discharged to Location |
||
38 |
|
O |
0114 |
00168 |
Diet Type |
||
39 |
|
2 |
str |
O |
0115 |
00169 |
Servicing Facility |
40 |
|
1 |
str |
O |
0116 |
00170 |
Bed Status |
41 |
|
2 |
str |
O |
0117 |
00171 |
Account Status |
42 |
|
O |
00172 |
Pending Location |
|||
43 |
|
O |
00173 |
Prior Temporary Location |
|||
44 |
|
O |
00174 |
Admit Date/Time |
|||
45 |
|
O |
00175 |
Discharge Date/Time |
|||
46 |
|
12 |
str |
O |
00176 |
Current Patient Balance |
|
47 |
|
12 |
str |
O |
00177 |
Total Charges |
|
48 |
|
12 |
str |
O |
00178 |
Total Adjustments |
|
49 |
|
12 |
str |
O |
00179 |
Total Payments |
|
50 |
|
O |
0203 |
00180 |
Alternate Visit ID |
||
51 |
|
1 |
str |
O |
0326 |
01226 |
Visit Indicator |
52 |
|
list[XCN] |
O |
0010 |
01274 |
Other Healthcare Provider |
PV2: PV2 - patient visit - additional information segment¶
Section 3.3.4
- class hl7types.hl7.v2_3_1.segments.PV2.PV2
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
C |
00181 |
Prior Pending Location |
|||
2 |
|
O |
0129 |
00182 |
Accommodation Code |
||
3 |
|
O |
00183 |
Admit Reason |
|||
4 |
|
O |
00184 |
Transfer Reason |
|||
5 |
|
25 |
list[str] |
O |
00185 |
Patient Valuables |
|
6 |
|
25 |
str |
O |
00186 |
Patient Valuables Location |
|
7 |
|
2 |
str |
O |
0130 |
00187 |
Visit User Code |
8 |
|
O |
00188 |
Expected Admit Date/Time |
|||
9 |
|
O |
00189 |
Expected Discharge Date/Time |
|||
10 |
|
3 |
str |
O |
00711 |
Estimated Length of Inpatient Stay |
|
11 |
|
3 |
str |
O |
00712 |
Actual Length of Inpatient Stay |
|
12 |
|
50 |
str |
O |
00713 |
Visit Description |
|
13 |
|
list[XCN] |
O |
00714 |
Referral Source Code |
||
14 |
|
8 |
str |
O |
00715 |
Previous Service Date |
|
15 |
|
1 |
str |
O |
0136 |
00716 |
Employment Illness Related Indicator |
16 |
|
1 |
str |
O |
0213 |
00717 |
Purge Status Code |
17 |
|
8 |
str |
O |
00718 |
Purge Status Date |
|
18 |
|
2 |
str |
O |
0214 |
00719 |
Special Program Code |
19 |
|
1 |
str |
O |
0136 |
00720 |
Retention Indicator |
20 |
|
1 |
str |
O |
00721 |
Expected Number of Insurance Plans |
|
21 |
|
1 |
str |
O |
0215 |
00722 |
Visit Publicity Code |
22 |
|
1 |
str |
O |
0136 |
00723 |
Visit Protection Indicator |
23 |
|
list[XON] |
O |
00724 |
Clinic Organization Name |
||
24 |
|
2 |
str |
O |
0216 |
00725 |
Patient Status Code |
25 |
|
1 |
str |
O |
0217 |
00726 |
Visit Priority Code |
26 |
|
8 |
str |
O |
00727 |
Previous Treatment Date |
|
27 |
|
2 |
str |
O |
0112 |
00728 |
Expected Discharge Disposition |
28 |
|
8 |
str |
O |
00729 |
Signature on File Date |
|
29 |
|
8 |
str |
O |
00730 |
First Similar Illness Date |
|
30 |
|
O |
0218 |
00731 |
Patient Charge Adjustment Code |
||
31 |
|
2 |
str |
O |
0219 |
00732 |
Recurring Service Code |
32 |
|
1 |
str |
O |
0136 |
00733 |
Billing Media Code |
33 |
|
O |
00734 |
Expected Surgery Date & Time |
|||
34 |
|
1 |
str |
O |
0136 |
00735 |
Military Partnership Code |
35 |
|
1 |
str |
O |
0136 |
00736 |
Military Non-Availability Code |
36 |
|
1 |
str |
O |
0136 |
00737 |
Newborn Baby Indicator |
37 |
|
1 |
str |
O |
0136 |
00738 |
Baby Detained Indicator |
QAK: Query Acknowledgement¶
Section 2.24.22
- class hl7types.hl7.v2_3_1.segments.QAK.QAK
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
32 |
str |
C |
00696 |
Query Tag |
|
2 |
|
2 |
str |
O |
0208 |
00708 |
Query Response Status |
QRD: QRD - original-style query definition segment¶
Section C.2.4.1
- class hl7types.hl7.v2_3_1.segments.QRD.QRD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00025 |
Query Date/Time |
|||
2 |
|
1 |
str |
R |
0106 |
00026 |
Query Format Code |
3 |
|
1 |
str |
R |
0091 |
00027 |
Query Priority |
4 |
|
10 |
str |
R |
00028 |
Query ID |
|
5 |
|
1 |
str |
O |
0107 |
00029 |
Deferred Response Type |
6 |
|
O |
00030 |
Deferred Response Date/Time |
|||
7 |
|
R |
0126 |
00031 |
Quantity Limited Request |
||
8 |
|
list[XCN] |
R |
00032 |
Who Subject Filter |
||
9 |
|
list[CE] |
R |
0048 |
00033 |
What Subject Filter |
|
10 |
|
list[CE] |
R |
00034 |
What Department Data Code |
||
11 |
|
list[VR] |
O |
00035 |
What Data Code Value Qual. |
||
12 |
|
1 |
str |
O |
0108 |
00036 |
Query Results Level |
QRF: QRF - original style query filter segment¶
Section 2.24.5
- class hl7types.hl7.v2_3_1.segments.QRF.QRF
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
20 |
list[str] |
R |
00037 |
Where Subject Filter |
|
2 |
|
O |
00038 |
When Data Start Date/Time |
|||
3 |
|
O |
00039 |
When Data End Date/Time |
|||
4 |
|
60 |
list[str] |
O |
00040 |
What User Qualifier |
|
5 |
|
60 |
list[str] |
O |
00041 |
Other QRY Subject Filter |
|
6 |
|
12 |
list[str] |
O |
0156 |
00042 |
Which Date/Time Qualifier |
7 |
|
12 |
list[str] |
O |
0157 |
00043 |
Which Date/Time Status Qualifier |
8 |
|
12 |
list[str] |
O |
0158 |
00044 |
Date/Time Selection Qualifier |
9 |
|
O |
00694 |
When Quantity/Timing Qualifier |
RDF: RDF - table row definition segment¶
Section 2.24.18
- class hl7types.hl7.v2_3_1.segments.RDF.RDF
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
3 |
str |
R |
00701 |
Number of Columns per Row |
|
2 |
|
list[RCD] |
R |
00702 |
Column Description |
RDT: RDT - table row data segment¶
Section 2.24.19
- class hl7types.hl7.v2_3_1.segments.RDT.RDT
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
str |
O |
00703 |
Column Value |
RF1: Referral Infomation¶
Section 11.5.1
- class hl7types.hl7.v2_3_1.segments.RF1.RF1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
O |
0283 |
01137 |
Referral Status |
||
2 |
|
O |
0280 |
01138 |
Referral Priority |
||
3 |
|
O |
0281 |
01139 |
Referral Type |
||
4 |
|
list[CE] |
O |
0282 |
01140 |
Referral Disposition |
|
5 |
|
O |
0284 |
01141 |
Referral Category |
||
6 |
|
R |
01142 |
Originating Referral Identifier |
|||
7 |
|
O |
01143 |
Effective Date |
|||
8 |
|
O |
01144 |
Expiration Date |
|||
9 |
|
O |
01145 |
Process Date |
|||
10 |
|
list[CE] |
O |
0336 |
01228 |
Referral Reason |
|
11 |
|
list[EI] |
O |
01300 |
External Referral Identifier |
RGS: RGS - resource group segment¶
Section 10.5.3
- class hl7types.hl7.v2_3_1.segments.RGS.RGS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
01203 |
Set ID - RGS |
|
2 |
|
3 |
str |
C |
0206 |
00763 |
Segment Action Code |
3 |
|
O |
01204 |
Resource Group ID |
ROL: Role¶
Section 12.3.3
- class hl7types.hl7.v2_3_1.segments.ROL.ROL
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01206 |
Role Instance ID |
|||
2 |
|
2 |
str |
R |
0287 |
00816 |
Action Code |
3 |
|
R |
01197 |
Role-ROL |
|||
4 |
|
list[XCN] |
R |
01198 |
Role Person |
||
5 |
|
O |
01199 |
Role Begin Date/Time |
|||
6 |
|
O |
01200 |
Role End Date/Time |
|||
7 |
|
O |
01201 |
Role Duration |
|||
8 |
|
O |
01205 |
Role Action Reason |
RQ1: RQ1 - requisition detail-1 segment¶
Section 4.7.2
- class hl7types.hl7.v2_3_1.segments.RQ1.RQ1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
10 |
str |
O |
00285 |
Anticipated Price |
|
2 |
|
C |
00286 |
Manufacturer ID |
|||
3 |
|
16 |
str |
C |
00287 |
Manufacturer’s Catalog |
|
4 |
|
C |
00288 |
Vendor ID |
|||
5 |
|
16 |
str |
C |
00289 |
Vendor Catalog |
|
6 |
|
1 |
str |
O |
0136 |
00290 |
Taxable |
7 |
|
1 |
str |
O |
0136 |
00291 |
Substitute Allowed |
RQD: RQD - requisition detail segment¶
Section 4.7.1
- class hl7types.hl7.v2_3_1.segments.RQD.RQD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00275 |
Requisition Line Number |
|
2 |
|
C |
00276 |
Item Code - Internal |
|||
3 |
|
C |
00277 |
Item Code - External |
|||
4 |
|
C |
00278 |
Hospital Item Code |
|||
5 |
|
6 |
str |
O |
00279 |
Requisition Quantity |
|
6 |
|
O |
00280 |
Requisition Unit of Measure |
|||
7 |
|
30 |
str |
O |
0319 |
00281 |
Dept. Cost Center |
8 |
|
30 |
str |
O |
0320 |
00282 |
Item Natural Account Code |
9 |
|
O |
00283 |
Deliver To ID |
|||
10 |
|
8 |
str |
O |
00284 |
Date Needed |
RXA: RXA - pharmacy/treatment administration segment¶
Section 4.13
- class hl7types.hl7.v2_3_1.segments.RXA.RXA
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00342 |
Give Sub-ID Counter |
|
2 |
|
4 |
str |
R |
00344 |
Administration Sub-ID Counter |
|
3 |
|
R |
00345 |
Date/Time Start of Administration |
|||
4 |
|
R |
00346 |
Date/Time End of Administration |
|||
5 |
|
R |
0292 |
00347 |
Administered Code |
||
6 |
|
20 |
str |
R |
00348 |
Administered Amount |
|
7 |
|
C |
00349 |
Administered Units |
|||
8 |
|
O |
00350 |
Administered Dosage Form |
|||
9 |
|
list[CE] |
O |
00351 |
Administration Notes |
||
10 |
|
list[XCN] |
O |
00352 |
Administering Provider |
||
11 |
|
C |
00353 |
Administered-at Location |
|||
12 |
|
20 |
str |
C |
00354 |
Administered Per (Time Unit) |
|
13 |
|
20 |
str |
O |
01134 |
Administered Strength |
|
14 |
|
O |
01135 |
Administered Strength Units |
|||
15 |
|
20 |
list[str] |
O |
01129 |
Substance Lot Number |
|
16 |
|
list[TS] |
O |
01130 |
Substance Expiration Date |
||
17 |
|
list[CE] |
O |
0227 |
01131 |
Substance Manufacturer Name |
|
18 |
|
list[CE] |
O |
01136 |
Substance Refusal Reason |
||
19 |
|
list[CE] |
O |
01123 |
Indication |
||
20 |
|
2 |
str |
O |
0322 |
01223 |
Completion Status |
21 |
|
2 |
str |
O |
0323 |
01224 |
Action Code-RXA |
22 |
|
O |
01225 |
System Entry Date/Time |
RXC: RXC - pharmacy/treatment component order segment¶
Section 4.8.4
- class hl7types.hl7.v2_3_1.segments.RXC.RXC
RXD: RXD - pharmacy/treatment dispense segment¶
Section 4.8.10
- class hl7types.hl7.v2_3_1.segments.RXD.RXD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00334 |
Dispense Sub-ID Counter |
|
2 |
|
R |
0292 |
00335 |
Dispense/Give Code |
||
3 |
|
R |
00336 |
Date/Time Dispensed |
|||
4 |
|
20 |
str |
R |
00337 |
Actual Dispense Amount |
|
5 |
|
C |
00338 |
Actual Dispense Units |
|||
6 |
|
O |
00339 |
Actual Dosage Form |
|||
7 |
|
20 |
str |
R |
00325 |
Prescription Number |
|
8 |
|
20 |
str |
C |
00326 |
Number of Refills Remaining |
|
9 |
|
200 |
list[str] |
O |
00340 |
Dispense Notes |
|
10 |
|
list[XCN] |
O |
00341 |
Dispensing Provider |
||
11 |
|
1 |
str |
O |
0167 |
00322 |
Substitution Status |
12 |
|
O |
00329 |
Total Daily Dose |
|||
13 |
|
C |
01303 |
Dispense-To Location |
|||
14 |
|
1 |
str |
O |
0136 |
00307 |
Needs Human Review |
15 |
|
list[CE] |
O |
00330 |
Pharmacy/Treatment Supplier’s Special Dispensing Instructions |
||
16 |
|
20 |
str |
O |
01132 |
Actual Strength |
|
17 |
|
O |
01133 |
Actual Strength Unit |
|||
18 |
|
20 |
list[str] |
O |
01129 |
Substance Lot Number |
|
19 |
|
list[TS] |
O |
01130 |
Substance Expiration Date |
||
20 |
|
list[CE] |
O |
0227 |
01131 |
Substance Manufacturer Name |
|
21 |
|
list[CE] |
O |
01123 |
Indication |
||
22 |
|
20 |
str |
O |
01220 |
Dispense Package Size |
|
23 |
|
O |
01221 |
Dispense Package Size Unit |
|||
24 |
|
2 |
str |
O |
0321 |
01222 |
Dispense Package Method |
RXE: RXE - pharmacy/treatment encoded order segment¶
Section 4.8.7
- class hl7types.hl7.v2_3_1.segments.RXE.RXE
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00221 |
Quantity/Timing |
|||
2 |
|
R |
0292 |
00317 |
Give Code |
||
3 |
|
20 |
str |
R |
00318 |
Give Amount - Minimum |
|
4 |
|
20 |
str |
O |
00319 |
Give Amount - Maximum |
|
5 |
|
R |
00320 |
Give Units |
|||
6 |
|
O |
00321 |
Give Dosage Form |
|||
7 |
|
list[CE] |
O |
00298 |
Provider’s Administration Instructions |
||
8 |
|
C |
00299 |
Deliver-to Location |
|||
9 |
|
1 |
str |
O |
0167 |
00322 |
Substitution Status |
10 |
|
20 |
str |
C |
00323 |
Dispense Amount |
|
11 |
|
C |
00324 |
Dispense Units |
|||
12 |
|
3 |
str |
O |
00304 |
Number Of Refills |
|
13 |
|
list[XCN] |
C |
00305 |
Ordering Provider’s DEA Number |
||
14 |
|
list[XCN] |
O |
00306 |
Pharmacist/Treatment Supplier’s Verifier ID |
||
15 |
|
20 |
str |
C |
00325 |
Prescription Number |
|
16 |
|
20 |
str |
C |
00326 |
Number of Refills Remaining |
|
17 |
|
20 |
str |
C |
00327 |
Number of Refills/Doses Dispensed |
|
18 |
|
C |
00328 |
D/T of Most Recent Refill or Dose Dispensed |
|||
19 |
|
C |
00329 |
Total Daily Dose |
|||
20 |
|
1 |
str |
O |
0136 |
00307 |
Needs Human Review |
21 |
|
list[CE] |
O |
00330 |
Pharmacy/Treatment Supplier’s Special Dispensing Instructions |
||
22 |
|
20 |
str |
C |
00331 |
Give Per (Time Unit) |
|
23 |
|
6 |
str |
O |
00332 |
Give Rate Amount |
|
24 |
|
O |
00333 |
Give Rate Units |
|||
25 |
|
20 |
str |
O |
01126 |
Give Strength |
|
26 |
|
O |
01127 |
Give Strength Units |
|||
27 |
|
list[CE] |
O |
01128 |
Give Indication |
||
28 |
|
20 |
str |
O |
01220 |
Dispense Package Size |
|
29 |
|
O |
01221 |
Dispense Package Size Unit |
|||
30 |
|
2 |
str |
O |
0321 |
01222 |
Dispense Package Method |
RXG: RXG - pharmacy/treatment give segment¶
Section 4.8.12
- class hl7types.hl7.v2_3_1.segments.RXG.RXG
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00342 |
Give Sub-ID Counter |
|
2 |
|
4 |
str |
O |
00334 |
Dispense Sub-ID Counter |
|
3 |
|
R |
00221 |
Quantity/Timing |
|||
4 |
|
R |
0292 |
00317 |
Give Code |
||
5 |
|
20 |
str |
R |
00318 |
Give Amount - Minimum |
|
6 |
|
20 |
str |
O |
00319 |
Give Amount - Maximum |
|
7 |
|
R |
00320 |
Give Units |
|||
8 |
|
O |
00321 |
Give Dosage Form |
|||
9 |
|
list[CE] |
O |
00351 |
Administration Notes |
||
10 |
|
1 |
str |
O |
0167 |
00322 |
Substitution Status |
11 |
|
O |
01303 |
Dispense-To Location |
|||
12 |
|
1 |
str |
O |
0136 |
00307 |
Needs Human Review |
13 |
|
list[CE] |
O |
00343 |
Pharmacy/Treatment Supplier’s Special Administration Instructions |
||
14 |
|
20 |
str |
C |
00331 |
Give Per (Time Unit) |
|
15 |
|
6 |
str |
O |
00332 |
Give Rate Amount |
|
16 |
|
O |
00333 |
Give Rate Units |
|||
17 |
|
20 |
str |
O |
01126 |
Give Strength |
|
18 |
|
O |
01127 |
Give Strength Units |
|||
19 |
|
20 |
list[str] |
O |
01129 |
Substance Lot Number |
|
20 |
|
list[TS] |
O |
01130 |
Substance Expiration Date |
||
21 |
|
list[CE] |
O |
0227 |
01131 |
Substance Manufacturer Name |
|
22 |
|
list[CE] |
O |
01123 |
Indication |
RXO: RXO - pharmacy/treatment order segment¶
Section 4.8.2
- class hl7types.hl7.v2_3_1.segments.RXO.RXO
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
C |
00292 |
Requested Give Code |
|||
2 |
|
20 |
str |
C |
00293 |
Requested Give Amount - Minimum |
|
3 |
|
20 |
str |
O |
00294 |
Requested Give Amount - Maximum |
|
4 |
|
C |
00295 |
Requested Give Units |
|||
5 |
|
O |
00296 |
Requested Dosage Form |
|||
6 |
|
list[CE] |
O |
00297 |
Provider’s Pharmacy/Treatment Instructions |
||
7 |
|
list[CE] |
O |
00298 |
Provider’s Administration Instructions |
||
8 |
|
O |
00299 |
Deliver-to Location |
|||
9 |
|
1 |
str |
O |
0161 |
00300 |
Allow Substitutions |
10 |
|
O |
00301 |
Requested Dispense Code |
|||
11 |
|
20 |
str |
O |
00302 |
Requested Dispense Amount |
|
12 |
|
O |
00303 |
Requested Dispense Units |
|||
13 |
|
3 |
str |
O |
00304 |
Number Of Refills |
|
14 |
|
list[XCN] |
C |
00305 |
Ordering Provider’s DEA Number |
||
15 |
|
list[XCN] |
C |
00306 |
Pharmacist/Treatment Supplier’s Verifier ID |
||
16 |
|
1 |
str |
O |
0136 |
00307 |
Needs Human Review |
17 |
|
20 |
str |
C |
00308 |
Requested Give Per (Time Unit) |
|
18 |
|
20 |
str |
O |
01121 |
Requested Give Strength |
|
19 |
|
O |
01122 |
Requested Give Strength Units |
|||
20 |
|
list[CE] |
O |
01123 |
Indication |
||
21 |
|
6 |
str |
O |
01218 |
Requested Give Rate Amount |
|
22 |
|
O |
01219 |
Requested Give Rate Units |
|||
23 |
|
O |
00329 |
Total Daily Dose |
RXR: RXR - pharmacy/treatment route segment¶
Section 4.8.3
- class hl7types.hl7.v2_3_1.segments.RXR.RXR
SCH: SCH - schedule activity information segment¶
Section 10.5.2
- class hl7types.hl7.v2_3_1.segments.SCH.SCH
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
C |
00860 |
Placer Appointment ID |
|||
2 |
|
C |
00861 |
Filler Appointment ID |
|||
3 |
|
5 |
str |
C |
00862 |
Occurrence Number |
|
4 |
|
O |
00218 |
Placer Group Number |
|||
5 |
|
O |
00864 |
Schedule ID |
|||
6 |
|
R |
00883 |
Event Reason |
|||
7 |
|
O |
0276 |
00866 |
Appointment Reason |
||
8 |
|
O |
0277 |
00867 |
Appointment Type |
||
9 |
|
20 |
str |
O |
00868 |
Appointment Duration |
|
10 |
|
O |
00869 |
Appointment Duration Units |
|||
11 |
|
list[TQ] |
R |
00884 |
Appointment Timing Quantity |
||
12 |
|
list[XCN] |
O |
00874 |
Placer Contact Person |
||
13 |
|
O |
00875 |
Placer Contact Phone Number |
|||
14 |
|
list[XAD] |
O |
00876 |
Placer Contact Address |
||
15 |
|
O |
00877 |
Placer Contact Location |
|||
16 |
|
list[XCN] |
R |
00885 |
Filler Contact Person |
||
17 |
|
O |
00886 |
Filler Contact Phone Number |
|||
18 |
|
list[XAD] |
O |
00887 |
Filler Contact Address |
||
19 |
|
O |
00888 |
Filler Contact Location |
|||
20 |
|
list[XCN] |
R |
00878 |
Entered by Person |
||
21 |
|
list[XTN] |
O |
00879 |
Entered by Phone Number |
||
22 |
|
O |
00880 |
Entered by Location |
|||
23 |
|
O |
00881 |
Parent Placer Appointment ID |
|||
24 |
|
C |
00882 |
Parent Filler Appointment ID |
|||
25 |
|
O |
0278 |
00889 |
Filler Status Code |
SPR: SPR - stored procedure request definition segment¶
Section 2.24.20
- class hl7types.hl7.v2_3_1.segments.SPR.SPR
STF: STF - staff identification segment¶
Section 8.6.2
- class hl7types.hl7.v2_3_1.segments.STF.STF
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
00671 |
Primary Key Value - STF |
|||
2 |
|
list[CX] |
O |
00672 |
Staff ID Code |
||
3 |
|
list[XPN] |
O |
00673 |
Staff Name |
||
4 |
|
2 |
list[str] |
O |
0182 |
00674 |
Staff Type |
5 |
|
1 |
str |
O |
0001 |
00111 |
Sex |
6 |
|
O |
00110 |
Date/Time Of Birth |
|||
7 |
|
1 |
str |
O |
0183 |
00675 |
Active/Inactive Flag |
8 |
|
list[CE] |
O |
0184 |
00676 |
Department |
|
9 |
|
list[CE] |
O |
0069 |
00677 |
Hospital Service |
|
10 |
|
list[XTN] |
O |
00678 |
Phone |
||
11 |
|
list[XAD] |
O |
00679 |
Office/Home Address |
||
12 |
|
list[DIN] |
O |
00680 |
Institution Activation Date |
||
13 |
|
list[DIN] |
O |
00681 |
Institution Inactivation Date |
||
14 |
|
list[CE] |
O |
00682 |
Backup Person ID |
||
15 |
|
40 |
list[str] |
O |
00683 |
E-Mail Address |
|
16 |
|
O |
0185 |
00684 |
Preferred Method Of Contact |
||
17 |
|
O |
0002 |
00119 |
Marital Status |
||
18 |
|
20 |
str |
O |
00785 |
Job Title |
|
19 |
|
O |
0327 |
00786 |
Job Code/Class |
||
20 |
|
2 |
str |
O |
0066 |
01276 |
Employment Status |
21 |
|
1 |
str |
O |
0136 |
01275 |
Additional Insured on Auto |
22 |
|
O |
01302 |
Driver’s License Number - Staff |
|||
23 |
|
1 |
str |
O |
0136 |
01229 |
Copy Auto Ins |
24 |
|
8 |
str |
O |
01232 |
Auto Ins. Expires |
|
25 |
|
8 |
str |
O |
01298 |
Date Last DMV Review |
|
26 |
|
8 |
str |
O |
01234 |
Date Next DMV Review |
TXA: Document notification segment¶
Section 9.5.1
- class hl7types.hl7.v2_3_1.segments.TXA.TXA
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
R |
00914 |
Set ID - TXA |
|
2 |
|
30 |
str |
R |
0270 |
00915 |
Document Type |
3 |
|
2 |
str |
C |
0191 |
00916 |
Document Content Presentation |
4 |
|
O |
00917 |
Activity Date/Time |
|||
5 |
|
list[XCN] |
C |
00918 |
Primary Activity Provider Code/Name |
||
6 |
|
O |
00919 |
Origination Date/Time |
|||
7 |
|
C |
00920 |
Transcription Date/Time |
|||
8 |
|
list[TS] |
O |
00921 |
Edit Date/Time |
||
9 |
|
list[XCN] |
O |
00922 |
Originator Code/Name |
||
10 |
|
list[XCN] |
O |
00923 |
Assigned Document Authenticator |
||
11 |
|
list[XCN] |
C |
00924 |
Transcriptionist Code/Name |
||
12 |
|
R |
00925 |
Unique Document Number |
|||
13 |
|
C |
00926 |
Parent Document Number |
|||
14 |
|
list[EI] |
O |
00216 |
Placer Order Number |
||
15 |
|
O |
00217 |
Filler Order Number |
|||
16 |
|
30 |
str |
O |
00927 |
Unique Document File Name |
|
17 |
|
2 |
str |
R |
0271 |
00928 |
Document Completion Status |
18 |
|
2 |
str |
O |
0272 |
00929 |
Document Confidentiality Status |
19 |
|
2 |
str |
O |
0273 |
00930 |
Document Availability Status |
20 |
|
2 |
str |
O |
0275 |
00932 |
Document Storage Status |
21 |
|
30 |
str |
C |
00933 |
Document Change Reason |
|
22 |
|
list[PPN] |
C |
00934 |
Authentication Person, Time Stamp |
||
23 |
|
list[XCN] |
O |
00935 |
Distributed Copies (Code and Name of Recipients) |
UB1: UB1 - UB82 data segment¶
Section 6.4.10
- class hl7types.hl7.v2_3_1.segments.UB1.UB1
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00530 |
Set ID - UB1 |
|
2 |
|
1 |
str |
O |
00531 |
Blood Deductible (43) |
|
3 |
|
2 |
str |
O |
00532 |
Blood Furnished-Pints Of (40) |
|
4 |
|
2 |
str |
O |
00533 |
Blood Replaced-Pints (41) |
|
5 |
|
2 |
str |
O |
00534 |
Blood Not Replaced-Pints(42) |
|
6 |
|
2 |
str |
O |
00535 |
Co-Insurance Days (25) |
|
7 |
|
14 |
list[str] |
O |
0043 |
00536 |
Condition Code (35-39) |
8 |
|
3 |
str |
O |
00537 |
Covered Days - (23) |
|
9 |
|
3 |
str |
O |
00538 |
Non Covered Days - (24) |
|
10 |
|
list[UVC] |
O |
0153 |
00539 |
Value Amount & Code (46-49) |
|
11 |
|
2 |
str |
O |
00540 |
Number Of Grace Days (90) |
|
12 |
|
O |
0348 |
00541 |
Special Program Indicator (44) |
||
13 |
|
O |
0349 |
00542 |
PSRO/UR Approval Indicator (87) |
||
14 |
|
8 |
str |
O |
00543 |
PSRO/UR Approved Stay-Fm (88) |
|
15 |
|
8 |
str |
O |
00544 |
PSRO/UR Approved Stay-To (89) |
|
16 |
|
list[OCD] |
O |
0350 |
00545 |
Occurrence (28-32) |
|
17 |
|
O |
0351 |
00546 |
Occurrence Span (33) |
||
18 |
|
8 |
str |
O |
00547 |
Occur Span Start Date(33) |
|
19 |
|
8 |
str |
O |
00548 |
Occur Span End Date (33) |
|
20 |
|
30 |
str |
O |
00549 |
UB-82 Locator 2 |
|
21 |
|
7 |
str |
O |
00550 |
UB-82 Locator 9 |
|
22 |
|
8 |
str |
O |
00551 |
UB-82 Locator 27 |
|
23 |
|
17 |
str |
O |
00552 |
UB-82 Locator 45 |
UB2: UB2 - UB92 data segment¶
Section 6.4.11
- class hl7types.hl7.v2_3_1.segments.UB2.UB2
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
4 |
str |
O |
00553 |
Set ID - UB2 |
|
2 |
|
3 |
str |
O |
00554 |
Co-Insurance Days (9) |
|
3 |
|
2 |
list[str] |
O |
0043 |
00555 |
Condition Code (24-30) |
4 |
|
3 |
str |
O |
00556 |
Covered Days (7) |
|
5 |
|
4 |
str |
O |
00557 |
Non-Covered Days (8) |
|
6 |
|
list[UVC] |
O |
0153 |
00558 |
Value Amount & Code |
|
7 |
|
list[OCD] |
O |
0350 |
00559 |
Occurrence Code & Date (32-35) |
|
8 |
|
list[OSP] |
O |
0351 |
00560 |
Occurrence Span Code/Dates (36) |
|
9 |
|
29 |
list[str] |
O |
00561 |
UB92 Locator 2 (State) |
|
10 |
|
12 |
list[str] |
O |
00562 |
UB92 Locator 11 (State) |
|
11 |
|
5 |
str |
O |
00563 |
UB92 Locator 31 (National) |
|
12 |
|
23 |
list[str] |
O |
00564 |
Document Control Number |
|
13 |
|
4 |
list[str] |
O |
00565 |
UB92 Locator 49 (National) |
|
14 |
|
14 |
list[str] |
O |
00566 |
UB92 Locator 56 (State) |
|
15 |
|
27 |
str |
O |
00567 |
UB92 Locator 57 (National) |
|
16 |
|
2 |
list[str] |
O |
00568 |
UB92 Locator 78 (State) |
|
17 |
|
3 |
str |
O |
00815 |
Special Visit Count |
URD: URD - results/update definition segment¶
Section 2.24.6
- class hl7types.hl7.v2_3_1.segments.URD.URD
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
O |
00045 |
R/U Date/Time |
|||
2 |
|
1 |
str |
O |
0109 |
00046 |
Report Priority |
3 |
|
list[XCN] |
R |
00047 |
R/U Who Subject Definition |
||
4 |
|
list[CE] |
O |
0048 |
00048 |
R/U What Subject Definition |
|
5 |
|
list[CE] |
O |
00049 |
R/U What Department Code |
||
6 |
|
20 |
list[str] |
O |
00050 |
R/U Display/Print Locations |
|
7 |
|
1 |
str |
O |
0108 |
00051 |
R/U Results Level |
URS: URS - unsolicited selection segment¶
Section 2.24.7
- class hl7types.hl7.v2_3_1.segments.URS.URS
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
20 |
list[str] |
R |
00052 |
R/U Where Subject Definition |
|
2 |
|
O |
00053 |
R/U When Data Start Date/Time |
|||
3 |
|
O |
00054 |
R/U When Data End Date/Time |
|||
4 |
|
20 |
list[str] |
O |
00055 |
R/U What User Qualifier |
|
5 |
|
20 |
list[str] |
O |
00056 |
R/U Other Results Subject Definition |
|
6 |
|
12 |
list[str] |
O |
0156 |
00057 |
R/U Which Date/Time Qualifier |
7 |
|
12 |
list[str] |
O |
0157 |
00058 |
R/U Which Date/Time Status Qualifier |
8 |
|
12 |
list[str] |
O |
0158 |
00059 |
R/U Date/Time Selection Qualifier |
9 |
|
O |
00695 |
R/U Quantity/Timing Qualifier |
VAR: Variance¶
Section 12.3.5
- class hl7types.hl7.v2_3_1.segments.VAR.VAR
SEQ |
Field |
LEN |
DT |
OPT |
TBL# |
ITEM# |
ELEMENT NAME |
|---|---|---|---|---|---|---|---|
1 |
|
R |
01212 |
Variance Instance ID |
|||
2 |
|
R |
01213 |
Documented Date/Time |
|||
3 |
|
O |
01214 |
Stated Variance Date/Time |
|||
4 |
|
list[XCN] |
O |
01215 |
Variance Originator |
||
5 |
|
O |
01216 |
Variance Classification |
|||
6 |
|
512 |
list[str] |
O |
01217 |
Variance Description |
VTQ: VTQ - virtual table query request segment¶
Section 2.24.17
- class hl7types.hl7.v2_3_1.segments.VTQ.VTQ