v2.8.2 Segments¶
- class hl7types.hl7.v2_8_2.segments.ABS.ABS
HL7 v2 ABS segment.
ABS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ABS.1 |
Optional[XCN] |
optional |
Discharge Care Provider: Item #1514 | Table HL70010 |
|
|
ABS.2 |
Optional[CWE] |
optional |
Transfer Medical Service Code: Item #1515 | Table HL70069 |
|
|
ABS.3 |
Optional[CWE] |
optional |
Severity of Illness Code: Item #1516 | Table HL70421 |
|
|
ABS.4 |
Optional[str] |
optional |
Date/Time of Attestation: Item #1517 |
|
|
ABS.5 |
Optional[XCN] |
optional |
Attested By: Item #1518 |
|
|
ABS.6 |
Optional[CWE] |
optional |
Triage Code: Item #1519 | Table HL70422 |
|
|
ABS.7 |
Optional[str] |
optional |
Abstract Completion Date/Time: Item #1520 |
|
|
ABS.8 |
Optional[XCN] |
optional |
Abstracted By: Item #1521 |
|
|
ABS.9 |
Optional[CWE] |
optional |
Case Category Code: Item #1522 | Table HL70423 |
|
|
ABS.10 |
Optional[str] |
optional |
Caesarian Section Indicator: Item #1523 | Table HL70136 |
|
|
ABS.11 |
Optional[CWE] |
optional |
Gestation Category Code: Item #1524 | Table HL70424 |
|
|
ABS.12 |
Optional[str] |
optional |
Gestation Period - Weeks: Item #1525 |
|
|
ABS.13 |
Optional[CWE] |
optional |
Newborn Code: Item #1526 | Table HL70425 |
|
|
ABS.14 |
Optional[str] |
optional |
Stillborn Indicator: Item #1527 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.ACC.ACC
HL7 v2 ACC segment.
ACC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ACC.1 |
Optional[str] |
optional |
Accident Date/Time: Item #527 |
|
|
ACC.2 |
Optional[CWE] |
optional |
Accident Code: Item #528 | Table HL70050 |
|
|
ACC.3 |
Optional[str] |
optional |
Accident Location: Item #529 |
|
|
ACC.4 |
Optional[CWE] |
optional |
Auto Accident State: Item #812 | Table HL70347 |
|
|
ACC.5 |
Optional[str] |
optional |
Accident Job Related Indicator: Item #813 | Table HL70136 |
|
|
ACC.6 |
Optional[str] |
optional |
Accident Death Indicator: Item #814 | Table HL70136 |
|
|
ACC.7 |
Optional[XCN] |
optional |
Entered By: Item #224 |
|
|
ACC.8 |
Optional[str] |
optional |
Accident Description: Item #1503 |
|
|
ACC.9 |
Optional[str] |
optional |
Brought In By: Item #1504 |
|
|
ACC.10 |
Optional[str] |
optional |
Police Notified Indicator: Item #1505 | Table HL70136 |
|
|
ACC.11 |
Optional[XAD] |
optional |
Accident Address: Item #1853 |
|
|
ACC.12 |
Optional[str] |
optional |
Degree of patient liability: Item #2374 |
|
|
ACC.13 |
Optional[List[EI]] |
optional |
Accident Identifier: Item #3338 |
- class hl7types.hl7.v2_8_2.segments.ADD.ADD
HL7 v2 ADD segment.
ADD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ADD.1 |
Optional[str] |
optional |
Addendum Continuation Pointer: Item #66 |
- class hl7types.hl7.v2_8_2.segments.ADJ.ADJ
HL7 v2 ADJ segment.
ADJ¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ADJ.1 |
required |
Provider Adjustment Number: Item #2003 |
||
|
ADJ.2 |
required |
Payer Adjustment Number: Item #2004 |
||
|
ADJ.3 |
str |
required |
Adjustment Sequence Number: Item #2005 |
|
|
ADJ.4 |
required |
Adjustment Category: Item #2006 | Table HL70564 |
||
|
ADJ.5 |
Optional[List[CP]] |
optional |
Adjustment Amount: Item #2007 |
|
|
ADJ.6 |
Optional[CQ] |
optional |
Adjustment Quantity: Item #2008 | Table HL70560 |
|
|
ADJ.7 |
Optional[CWE] |
optional |
Adjustment Reason PA: Item #2009 | Table HL70565 |
|
|
ADJ.8 |
Optional[str] |
optional |
Adjustment Description: Item #2010 |
|
|
ADJ.9 |
Optional[str] |
optional |
Original Value: Item #2011 |
|
|
ADJ.10 |
Optional[str] |
optional |
Substitute Value: Item #2012 |
|
|
ADJ.11 |
Optional[CWE] |
optional |
Adjustment Action: Item #2013 | Table HL70569 |
|
|
ADJ.12 |
Optional[EI] |
optional |
Provider Adjustment Number Cross Reference: Item #2014 |
|
|
ADJ.13 |
Optional[EI] |
optional |
Provider Product/Service Line Item Number Cross Reference: Item #2015 |
|
|
ADJ.14 |
str |
required |
Adjustment Date: Item #2016 |
|
|
ADJ.15 |
Optional[XON] |
optional |
Responsible Organization: Item #2017 |
- class hl7types.hl7.v2_8_2.segments.AFF.AFF
HL7 v2 AFF segment.
AFF¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AFF.1 |
str |
required |
Set ID - AFF: Item #1427 |
|
|
AFF.2 |
required |
Professional Organization: Item #1444 |
||
|
AFF.3 |
Optional[XAD] |
optional |
Professional Organization Address: Item #1445 |
|
|
AFF.4 |
Optional[List[DR]] |
optional |
Professional Organization Affiliation Date Range: Item #1446 |
|
|
AFF.5 |
Optional[str] |
optional |
Professional Affiliation Additional Information: Item #1447 |
- class hl7types.hl7.v2_8_2.segments.AIG.AIG
HL7 v2 AIG segment.
AIG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AIG.1 |
str |
required |
Set ID - AIG: Item #896 |
|
|
AIG.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
AIG.3 |
Optional[CWE] |
optional |
Resource ID: Item #897 |
|
|
AIG.4 |
required |
Resource Type: Item #898 |
||
|
AIG.5 |
Optional[List[CWE]] |
optional |
Resource Group: Item #899 |
|
|
AIG.6 |
Optional[str] |
optional |
Resource Quantity: Item #900 |
|
|
AIG.7 |
Optional[CNE] |
optional |
Resource Quantity Units: Item #901 |
|
|
AIG.8 |
Optional[str] |
optional |
Start Date/Time: Item #1202 |
|
|
AIG.9 |
Optional[str] |
optional |
Start Date/Time Offset: Item #891 |
|
|
AIG.10 |
Optional[CNE] |
optional |
Start Date/Time Offset Units: Item #892 |
|
|
AIG.11 |
Optional[str] |
optional |
Duration: Item #893 |
|
|
AIG.12 |
Optional[CNE] |
optional |
Duration Units: Item #894 |
|
|
AIG.13 |
Optional[CWE] |
optional |
Allow Substitution Code: Item #895 | Table HL70279 |
|
|
AIG.14 |
Optional[CWE] |
optional |
Filler Status Code: Item #889 | Table HL70278 |
- class hl7types.hl7.v2_8_2.segments.AIL.AIL
HL7 v2 AIL segment.
AIL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AIL.1 |
str |
required |
Set ID - AIL: Item #902 |
|
|
AIL.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
AIL.3 |
Optional[List[PL]] |
optional |
Location Resource ID: Item #903 |
|
|
AIL.4 |
Optional[CWE] |
optional |
Location Type - AIL: Item #904 | Table HL70305 |
|
|
AIL.5 |
Optional[CWE] |
optional |
Location Group: Item #905 |
|
|
AIL.6 |
Optional[str] |
optional |
Start Date/Time: Item #1202 |
|
|
AIL.7 |
Optional[str] |
optional |
Start Date/Time Offset: Item #891 |
|
|
AIL.8 |
Optional[CNE] |
optional |
Start Date/Time Offset Units: Item #892 |
|
|
AIL.9 |
Optional[str] |
optional |
Duration: Item #893 |
|
|
AIL.10 |
Optional[CNE] |
optional |
Duration Units: Item #894 |
|
|
AIL.11 |
Optional[CWE] |
optional |
Allow Substitution Code: Item #895 | Table HL70279 |
|
|
AIL.12 |
Optional[CWE] |
optional |
Filler Status Code: Item #889 | Table HL70278 |
- class hl7types.hl7.v2_8_2.segments.AIP.AIP
HL7 v2 AIP segment.
AIP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AIP.1 |
str |
required |
Set ID - AIP: Item #906 |
|
|
AIP.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
AIP.3 |
Optional[List[XCN]] |
optional |
Personnel Resource ID: Item #913 |
|
|
AIP.4 |
Optional[CWE] |
optional |
Resource Type: Item #907 | Table HL70182 |
|
|
AIP.5 |
Optional[CWE] |
optional |
Resource Group: Item #899 |
|
|
AIP.6 |
Optional[str] |
optional |
Start Date/Time: Item #1202 |
|
|
AIP.7 |
Optional[str] |
optional |
Start Date/Time Offset: Item #891 |
|
|
AIP.8 |
Optional[CNE] |
optional |
Start Date/Time Offset Units: Item #892 |
|
|
AIP.9 |
Optional[str] |
optional |
Duration: Item #893 |
|
|
AIP.10 |
Optional[CNE] |
optional |
Duration Units: Item #894 |
|
|
AIP.11 |
Optional[CWE] |
optional |
Allow Substitution Code: Item #895 | Table HL70279 |
|
|
AIP.12 |
Optional[CWE] |
optional |
Filler Status Code: Item #889 | Table HL70278 |
- class hl7types.hl7.v2_8_2.segments.AIS.AIS
HL7 v2 AIS segment.
AIS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AIS.1 |
str |
required |
Set ID - AIS: Item #890 |
|
|
AIS.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
AIS.3 |
required |
Universal Service Identifier: Item #238 |
||
|
AIS.4 |
Optional[str] |
optional |
Start Date/Time: Item #1202 |
|
|
AIS.5 |
Optional[str] |
optional |
Start Date/Time Offset: Item #891 |
|
|
AIS.6 |
Optional[CNE] |
optional |
Start Date/Time Offset Units: Item #892 |
|
|
AIS.7 |
Optional[str] |
optional |
Duration: Item #893 |
|
|
AIS.8 |
Optional[CNE] |
optional |
Duration Units: Item #894 |
|
|
AIS.9 |
Optional[CWE] |
optional |
Allow Substitution Code: Item #895 | Table HL70279 |
|
|
AIS.10 |
Optional[CWE] |
optional |
Filler Status Code: Item #889 | Table HL70278 |
|
|
AIS.11 |
Optional[List[CWE]] |
optional |
Placer Supplemental Service Information: Item #1474 | Table HL70411 |
|
|
AIS.12 |
Optional[List[CWE]] |
optional |
Filler Supplemental Service Information: Item #1475 | Table HL70411 |
- class hl7types.hl7.v2_8_2.segments.AL1.AL1
HL7 v2 AL1 segment.
AL1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AL1.1 |
str |
required |
Set ID - AL1: Item #203 |
|
|
AL1.2 |
Optional[CWE] |
optional |
Allergen Type Code: Item #204 | Table HL70127 |
|
|
AL1.3 |
required |
Allergen Code/Mnemonic/Description: Item #205 |
||
|
AL1.4 |
Optional[CWE] |
optional |
Allergy Severity Code: Item #206 | Table HL70128 |
|
|
AL1.5 |
Optional[List[str]] |
optional |
Allergy Reaction Code: Item #207 |
- class hl7types.hl7.v2_8_2.segments.APR.APR
HL7 v2 APR segment.
APR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
APR.1 |
Optional[List[SCV]] |
optional |
Time Selection Criteria: Item #908 | Table HL70294 |
|
|
APR.2 |
Optional[List[SCV]] |
optional |
Resource Selection Criteria: Item #909 | Table HL70294 |
|
|
APR.3 |
Optional[List[SCV]] |
optional |
Location Selection Criteria: Item #910 | Table HL70294 |
|
|
APR.4 |
Optional[str] |
optional |
Slot Spacing Criteria: Item #911 |
|
|
APR.5 |
Optional[List[SCV]] |
optional |
Filler Override Criteria: Item #912 |
- class hl7types.hl7.v2_8_2.segments.ARQ.ARQ
HL7 v2 ARQ segment.
ARQ¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ARQ.1 |
required |
Placer Appointment ID: Item #860 |
||
|
ARQ.2 |
Optional[EI] |
optional |
Filler Appointment ID: Item #861 |
|
|
ARQ.3 |
Optional[str] |
optional |
Occurrence Number: Item #862 |
|
|
ARQ.4 |
Optional[EIP] |
optional |
Placer Group Number: Item #218 |
|
|
ARQ.5 |
Optional[CWE] |
optional |
Schedule ID: Item #864 |
|
|
ARQ.6 |
Optional[CWE] |
optional |
Request Event Reason: Item #865 |
|
|
ARQ.7 |
Optional[CWE] |
optional |
Appointment Reason: Item #866 | Table HL70276 |
|
|
ARQ.8 |
Optional[CWE] |
optional |
Appointment Type: Item #867 | Table HL70277 |
|
|
ARQ.9 |
Optional[str] |
optional |
Appointment Duration: Item #868 |
|
|
ARQ.10 |
Optional[CNE] |
optional |
Appointment Duration Units: Item #869 |
|
|
ARQ.11 |
Optional[List[DR]] |
optional |
Requested Start Date/Time Range: Item #870 |
|
|
ARQ.12 |
Optional[str] |
optional |
Priority-ARQ: Item #871 |
|
|
ARQ.13 |
Optional[RI] |
optional |
Repeating Interval: Item #872 |
|
|
ARQ.14 |
Optional[str] |
optional |
Repeating Interval Duration: Item #873 |
|
|
ARQ.15 |
Optional[List[XCN]] |
optional |
Placer Contact Person: Item #874 |
|
|
ARQ.16 |
Optional[List[XTN]] |
optional |
Placer Contact Phone Number: Item #875 |
|
|
ARQ.17 |
Optional[List[XAD]] |
optional |
Placer Contact Address: Item #876 |
|
|
ARQ.18 |
Optional[PL] |
optional |
Placer Contact Location: Item #877 |
|
|
ARQ.19 |
Optional[List[XCN]] |
optional |
Entered By Person: Item #878 |
|
|
ARQ.20 |
Optional[List[XTN]] |
optional |
Entered By Phone Number: Item #879 |
|
|
ARQ.21 |
Optional[PL] |
optional |
Entered By Location: Item #880 |
|
|
ARQ.22 |
Optional[EI] |
optional |
Parent Placer Appointment ID: Item #881 |
|
|
ARQ.23 |
Optional[EI] |
optional |
Parent Filler Appointment ID: Item #882 |
|
|
ARQ.24 |
Optional[List[EI]] |
optional |
Placer Order Number: Item #216 |
|
|
ARQ.25 |
Optional[List[EI]] |
optional |
Filler Order Number: Item #217 |
- class hl7types.hl7.v2_8_2.segments.ARV.ARV
HL7 v2 ARV segment.
ARV¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ARV.1 |
Optional[str] |
optional |
Set ID: Item #2143 |
|
|
ARV.2 |
required |
Access Restriction Action Code: Item #2144 | Table HL70206 |
||
|
ARV.3 |
required |
Access Restriction Value: Item #2145 | Table HL70717 |
||
|
ARV.4 |
Optional[List[CWE]] |
optional |
Access Restriction Reason: Item #2146 | Table HL70719 |
|
|
ARV.5 |
Optional[List[str]] |
optional |
Special Access Restriction Instructions: Item #2147 |
|
|
ARV.6 |
Optional[DR] |
optional |
Access Restriction Date Range: Item #2148 |
- class hl7types.hl7.v2_8_2.segments.AUT.AUT
HL7 v2 AUT segment.
AUT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AUT.1 |
Optional[CWE] |
optional |
Authorizing Payor, Plan ID: Item #1146 | Table HL70072 |
|
|
AUT.2 |
required |
Authorizing Payor, Company ID: Item #1147 | Table HL70285 |
||
|
AUT.3 |
Optional[str] |
optional |
Authorizing Payor, Company Name: Item #1148 |
|
|
AUT.4 |
Optional[str] |
optional |
Authorization Effective Date: Item #1149 |
|
|
AUT.5 |
Optional[str] |
optional |
Authorization Expiration Date: Item #1150 |
|
|
AUT.6 |
Optional[EI] |
optional |
Authorization Identifier: Item #1151 |
|
|
AUT.7 |
Optional[CP] |
optional |
Reimbursement Limit: Item #1152 |
|
|
AUT.8 |
Optional[CQ] |
optional |
Requested Number of Treatments: Item #1153 |
|
|
AUT.9 |
Optional[CQ] |
optional |
Authorized Number of Treatments: Item #1154 |
|
|
AUT.10 |
Optional[str] |
optional |
Process Date: Item #1145 |
|
|
AUT.11 |
Optional[List[CWE]] |
optional |
Requested Discipline(s): Item #2375 |
|
|
AUT.12 |
Optional[List[CWE]] |
optional |
Authorized Discipline(s): Item #2376 |
|
|
AUT.13 |
required |
Authorization Referral Type: Item #3413 |
||
|
AUT.14 |
Optional[CWE] |
optional |
Approval Status: Item #3414 |
|
|
AUT.15 |
Optional[str] |
optional |
Planned Treatment Stop Date: Item #3415 |
|
|
AUT.16 |
Optional[CWE] |
optional |
Clinical Service: Item #3416 |
|
|
AUT.17 |
Optional[str] |
optional |
Reason Text: Item #3417 |
|
|
AUT.18 |
Optional[CQ] |
optional |
Number of Authorized Treatments/Units: Item #3418 |
|
|
AUT.19 |
Optional[CQ] |
optional |
Number of Used Treatments/Units: Item #3419 |
|
|
AUT.20 |
Optional[CQ] |
optional |
Number of Schedule Treatments/Units: Item #3420 |
|
|
AUT.21 |
Optional[CWE] |
optional |
Encounter Type: Item #3421 |
|
|
AUT.22 |
Optional[MO] |
optional |
Remaining Benefit Amount: Item #3422 |
|
|
AUT.23 |
Optional[XON] |
optional |
Authorized Provider: Item #3423 |
|
|
AUT.24 |
Optional[XCN] |
optional |
Authorized Health Professional: Item #3424 |
|
|
AUT.25 |
Optional[str] |
optional |
Source Text: Item #3425 |
|
|
AUT.26 |
Optional[str] |
optional |
Source Date: Item #3426 |
|
|
AUT.27 |
Optional[XTN] |
optional |
Source Phone: Item #3427 |
|
|
AUT.28 |
Optional[str] |
optional |
Comment: Item #3428 |
|
|
AUT.29 |
Optional[str] |
optional |
Action Code: Item #3429 | Table HL70206 |
- class hl7types.hl7.v2_8_2.segments.BHS.BHS
HL7 v2 BHS segment.
BHS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BHS.1 |
str |
optional |
Batch Field Separator: Item #81 |
|
|
BHS.2 |
str |
optional |
Batch Encoding Characters: Item #82 |
|
|
BHS.3 |
Optional[HD] |
optional |
Batch Sending Application: Item #83 |
|
|
BHS.4 |
Optional[HD] |
optional |
Batch Sending Facility: Item #84 |
|
|
BHS.5 |
Optional[HD] |
optional |
Batch Receiving Application: Item #85 |
|
|
BHS.6 |
Optional[HD] |
optional |
Batch Receiving Facility: Item #86 |
|
|
BHS.7 |
Optional[str] |
optional |
Batch Creation Date/Time: Item #87 |
|
|
BHS.8 |
Optional[str] |
optional |
Batch Security: Item #88 |
|
|
BHS.9 |
Optional[str] |
optional |
Batch Name/ID/Type: Item #89 |
|
|
BHS.10 |
Optional[str] |
optional |
Batch Comment: Item #90 |
|
|
BHS.11 |
Optional[str] |
optional |
Batch Control ID: Item #91 |
|
|
BHS.12 |
Optional[str] |
optional |
Reference Batch Control ID: Item #92 |
|
|
BHS.13 |
Optional[HD] |
optional |
Batch Sending Network Address: Item #2271 |
|
|
BHS.14 |
Optional[HD] |
optional |
Batch Receiving Network Address: Item #2272 |
- class hl7types.hl7.v2_8_2.segments.BLC.BLC
HL7 v2 BLC segment.
BLC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BLC.1 |
Optional[CWE] |
optional |
Blood Product Code: Item #1528 | Table HL70426 |
|
|
BLC.2 |
Optional[CQ] |
optional |
Blood Amount: Item #1529 |
- class hl7types.hl7.v2_8_2.segments.BLG.BLG
HL7 v2 BLG segment.
BLG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BLG.1 |
Optional[CCD] |
optional |
When to Charge: Item #234 | Table HL70100 |
|
|
BLG.2 |
Optional[str] |
optional |
Charge Type: Item #235 | Table HL70122 |
|
|
BLG.3 |
Optional[CX] |
optional |
Account ID: Item #236 |
|
|
BLG.4 |
Optional[CWE] |
optional |
Charge Type Reason: Item #1645 | Table HL70475 |
- class hl7types.hl7.v2_8_2.segments.BPO.BPO
HL7 v2 BPO segment.
BPO¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BPO.1 |
str |
required |
Set ID - BPO: Item #1700 |
|
|
BPO.2 |
required |
BP Universal Service Identifier: Item #1701 | Table HL79999 |
||
|
BPO.3 |
Optional[List[CWE]] |
optional |
BP Processing Requirements: Item #1702 | Table HL70508 |
|
|
BPO.4 |
str |
required |
BP Quantity: Item #1703 |
|
|
BPO.5 |
Optional[str] |
optional |
BP Amount: Item #1704 |
|
|
BPO.6 |
Optional[CWE] |
optional |
BP Units: Item #1705 | Table HL79999 |
|
|
BPO.7 |
Optional[str] |
optional |
BP Intended Use Date/Time: Item #1706 |
|
|
BPO.8 |
Optional[PL] |
optional |
BP Intended Dispense From Location: Item #1707 |
|
|
BPO.9 |
Optional[XAD] |
optional |
BP Intended Dispense From Address: Item #1708 |
|
|
BPO.10 |
Optional[str] |
optional |
BP Requested Dispense Date/Time: Item #1709 |
|
|
BPO.11 |
Optional[PL] |
optional |
BP Requested Dispense To Location: Item #1710 |
|
|
BPO.12 |
Optional[XAD] |
optional |
BP Requested Dispense To Address: Item #1711 |
|
|
BPO.13 |
Optional[List[CWE]] |
optional |
BP Indication for Use: Item #1712 | Table HL70509 |
|
|
BPO.14 |
Optional[str] |
optional |
BP Informed Consent Indicator: Item #1713 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.BPX.BPX
HL7 v2 BPX segment.
BPX¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BPX.1 |
str |
required |
Set ID - BPX: Item #1714 |
|
|
BPX.2 |
required |
BP Dispense Status: Item #1715 | Table HL70510 |
||
|
BPX.3 |
str |
required |
BP Status: Item #1716 | Table HL70511 |
|
|
BPX.4 |
str |
required |
BP Date/Time of Status: Item #1717 |
|
|
BPX.5 |
Optional[EI] |
optional |
BC Donation ID: Item #1718 |
|
|
BPX.6 |
Optional[CNE] |
optional |
BC Component: Item #1719 | Table HL79999 |
|
|
BPX.7 |
Optional[CNE] |
optional |
BC Donation Type / Intended Use: Item #1720 | Table HL79999 |
|
|
BPX.8 |
Optional[CWE] |
optional |
CP Commercial Product: Item #1721 | Table HL70512 |
|
|
BPX.9 |
Optional[XON] |
optional |
CP Manufacturer: Item #1722 |
|
|
BPX.10 |
Optional[EI] |
optional |
CP Lot Number: Item #1723 |
|
|
BPX.11 |
Optional[CNE] |
optional |
BP Blood Group: Item #1724 | Table HL79999 |
|
|
BPX.12 |
Optional[List[CNE]] |
optional |
BC Special Testing: Item #1725 | Table HL79999 |
|
|
BPX.13 |
Optional[str] |
optional |
BP Expiration Date/Time: Item #1726 |
|
|
BPX.14 |
str |
required |
BP Quantity: Item #1727 |
|
|
BPX.15 |
Optional[str] |
optional |
BP Amount: Item #1728 |
|
|
BPX.16 |
Optional[CWE] |
optional |
BP Units: Item #1729 | Table HL79999 |
|
|
BPX.17 |
Optional[EI] |
optional |
BP Unique ID: Item #1730 |
|
|
BPX.18 |
Optional[PL] |
optional |
BP Actual Dispensed To Location: Item #1731 |
|
|
BPX.19 |
Optional[XAD] |
optional |
BP Actual Dispensed To Address: Item #1732 |
|
|
BPX.20 |
Optional[XCN] |
optional |
BP Dispensed to Receiver: Item #1733 |
|
|
BPX.21 |
Optional[XCN] |
optional |
BP Dispensing Individual: Item #1734 |
- class hl7types.hl7.v2_8_2.segments.BTS.BTS
HL7 v2 BTS segment.
BTS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BTS.1 |
Optional[str] |
optional |
Batch Message Count: Item #93 |
|
|
BTS.2 |
Optional[str] |
optional |
Batch Comment: Item #90 |
|
|
BTS.3 |
Optional[List[str]] |
optional |
Batch Totals: Item #95 |
- class hl7types.hl7.v2_8_2.segments.BTX.BTX
HL7 v2 BTX segment.
BTX¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BTX.1 |
str |
required |
Set ID - BTX: Item #1735 |
|
|
BTX.2 |
Optional[EI] |
optional |
BC Donation ID: Item #1736 |
|
|
BTX.3 |
Optional[CNE] |
optional |
BC Component: Item #1737 | Table HL79999 |
|
|
BTX.4 |
Optional[CNE] |
optional |
BC Blood Group: Item #1738 | Table HL79999 |
|
|
BTX.5 |
Optional[CWE] |
optional |
CP Commercial Product: Item #1739 | Table HL70512 |
|
|
BTX.6 |
Optional[XON] |
optional |
CP Manufacturer: Item #1740 |
|
|
BTX.7 |
Optional[EI] |
optional |
CP Lot Number: Item #1741 |
|
|
BTX.8 |
str |
required |
BP Quantity: Item #1742 |
|
|
BTX.9 |
Optional[str] |
optional |
BP Amount: Item #1743 |
|
|
BTX.10 |
Optional[CWE] |
optional |
BP Units: Item #1744 | Table HL79999 |
|
|
BTX.11 |
required |
BP Transfusion/Disposition Status: Item #1745 | Table HL70513 |
||
|
BTX.12 |
str |
required |
BP Message Status: Item #1746 | Table HL70511 |
|
|
BTX.13 |
str |
required |
BP Date/Time of Status: Item #1747 |
|
|
BTX.14 |
Optional[XCN] |
optional |
BP Transfusion Administrator: Item #1748 |
|
|
BTX.15 |
Optional[XCN] |
optional |
BP Transfusion Verifier: Item #1749 |
|
|
BTX.16 |
Optional[str] |
optional |
BP Transfusion Start Date/Time of Status: Item #1750 |
|
|
BTX.17 |
Optional[str] |
optional |
BP Transfusion End Date/Time of Status: Item #1751 |
|
|
BTX.18 |
Optional[List[CWE]] |
optional |
BP Adverse Reaction Type: Item #1752 | Table HL70514 |
|
|
BTX.19 |
Optional[CWE] |
optional |
BP Transfusion Interrupted Reason: Item #1753 | Table HL70515 |
|
|
BTX.20 |
Optional[EI] |
optional |
BP Unique ID: Item #3391 |
- class hl7types.hl7.v2_8_2.segments.BUI.BUI
HL7 v2 BUI segment.
BUI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BUI.1 |
Optional[str] |
optional |
Set ID - BUI: Item #3373 |
|
|
BUI.2 |
required |
Blood Unit Identifier: Item #3374 |
||
|
BUI.3 |
required |
Blood Unit Type: Item #3375 | Table HL70566 |
||
|
BUI.4 |
str |
required |
Blood Unit Weight: Item #3376 |
|
|
BUI.5 |
required |
Weight Units: Item #3377 | Table HL70929 |
||
|
BUI.6 |
str |
required |
Blood Unit Volume: Item #3378 |
|
|
BUI.7 |
required |
Volume Units: Item #3379 | Table HL70930 |
||
|
BUI.8 |
str |
required |
Container Catalog Number: Item #3380 |
|
|
BUI.9 |
str |
required |
Container Lot Number: Item #3381 |
|
|
BUI.10 |
required |
Container Manufacturer: Item #3382 |
||
|
BUI.11 |
required |
Transport Temperature: Item #3383 |
||
|
BUI.12 |
required |
Transport Temperature Units: Item #3384 | Table HL70931 |
- class hl7types.hl7.v2_8_2.segments.CDM.CDM
HL7 v2 CDM segment.
CDM¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CDM.1 |
required |
Primary Key Value - CDM: Item #1306 |
||
|
CDM.2 |
Optional[List[CWE]] |
optional |
Charge Code Alias: Item #983 | Table HL70132 |
|
|
CDM.3 |
str |
required |
Charge Description Short: Item #984 |
|
|
CDM.4 |
Optional[str] |
optional |
Charge Description Long: Item #985 |
|
|
CDM.5 |
Optional[CWE] |
optional |
Description Override Indicator: Item #986 | Table HL70268 |
|
|
CDM.6 |
Optional[List[CWE]] |
optional |
Exploding Charges: Item #987 | Table HL70132 |
|
|
CDM.7 |
Optional[List[CNE]] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
CDM.8 |
Optional[str] |
optional |
Active/Inactive Flag: Item #675 | Table HL70183 |
|
|
CDM.9 |
Optional[List[CWE]] |
optional |
Inventory Number: Item #990 | Table HL70463 |
|
|
CDM.10 |
Optional[str] |
optional |
Resource Load: Item #991 |
|
|
CDM.11 |
Optional[List[CX]] |
optional |
Contract Number: Item #992 |
|
|
CDM.12 |
Optional[List[XON]] |
optional |
Contract Organization: Item #993 |
|
|
CDM.13 |
Optional[str] |
optional |
Room Fee Indicator: Item #994 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.CDO.CDO
HL7 v2 CDO segment.
CDO¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CDO.1 |
Optional[str] |
optional |
Set ID - CDO: Item #3430 |
|
|
CDO.2 |
Optional[str] |
optional |
Action Code: Item #816 | Table HL70206 |
|
|
CDO.3 |
Optional[CQ] |
optional |
Cumulative Dosage Limit: Item #3397 |
|
|
CDO.4 |
Optional[CQ] |
optional |
Cumulative Dosage Limit Time Interval: Item #3398 | Table HL70924 |
- class hl7types.hl7.v2_8_2.segments.CER.CER
HL7 v2 CER segment.
CER¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CER.1 |
str |
required |
Set ID - CER: Item #1856 |
|
|
CER.2 |
Optional[str] |
optional |
Serial Number: Item #1857 |
|
|
CER.3 |
Optional[str] |
optional |
Version: Item #1858 |
|
|
CER.4 |
Optional[XON] |
optional |
Granting Authority: Item #1859 |
|
|
CER.5 |
Optional[XCN] |
optional |
Issuing Authority: Item #1860 |
|
|
CER.6 |
Optional[ED] |
optional |
Signature: Item #1861 |
|
|
CER.7 |
Optional[str] |
optional |
Granting Country: Item #1862 | Table HL70399 |
|
|
CER.8 |
Optional[CWE] |
optional |
Granting State/Province: Item #1863 | Table HL70347 |
|
|
CER.9 |
Optional[CWE] |
optional |
Granting County/Parish: Item #1864 | Table HL70289 |
|
|
CER.10 |
Optional[CWE] |
optional |
Certificate Type: Item #1865 |
|
|
CER.11 |
Optional[CWE] |
optional |
Certificate Domain: Item #1866 |
|
|
CER.12 |
Optional[EI] |
optional |
Subject ID: Item #1867 |
|
|
CER.13 |
str |
required |
Subject Name: Item #1907 |
|
|
CER.14 |
Optional[List[CWE]] |
optional |
Subject Directory Attribute Extension: Item #1868 |
|
|
CER.15 |
Optional[CWE] |
optional |
Subject Public Key Info: Item #1869 |
|
|
CER.16 |
Optional[CWE] |
optional |
Authority Key Identifier: Item #1870 |
|
|
CER.17 |
Optional[str] |
optional |
Basic Constraint: Item #1871 | Table HL70136 |
|
|
CER.18 |
Optional[List[CWE]] |
optional |
CRL Distribution Point: Item #1872 |
|
|
CER.19 |
Optional[str] |
optional |
Jurisdiction Country: Item #1875 | Table HL70399 |
|
|
CER.20 |
Optional[CWE] |
optional |
Jurisdiction State/Province: Item #1873 | Table HL70347 |
|
|
CER.21 |
Optional[CWE] |
optional |
Jurisdiction County/Parish: Item #1874 | Table HL70289 |
|
|
CER.22 |
Optional[List[CWE]] |
optional |
Jurisdiction Breadth: Item #1895 | Table HL70547 |
|
|
CER.23 |
Optional[str] |
optional |
Granting Date: Item #1876 |
|
|
CER.24 |
Optional[str] |
optional |
Issuing Date: Item #1877 |
|
|
CER.25 |
Optional[str] |
optional |
Activation Date: Item #1878 |
|
|
CER.26 |
Optional[str] |
optional |
Inactivation Date: Item #1879 |
|
|
CER.27 |
Optional[str] |
optional |
Expiration Date: Item #1880 |
|
|
CER.28 |
Optional[str] |
optional |
Renewal Date: Item #1881 |
|
|
CER.29 |
Optional[str] |
optional |
Revocation Date: Item #1882 |
|
|
CER.30 |
Optional[CWE] |
optional |
Revocation Reason Code: Item #1883 |
|
|
CER.31 |
Optional[CWE] |
optional |
Certificate Status Code: Item #1884 | Table HL70536 |
- class hl7types.hl7.v2_8_2.segments.CM0.CM0
HL7 v2 CM0 segment.
CM0¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CM0.1 |
Optional[str] |
optional |
Set ID - CM0: Item #1010 |
|
|
CM0.2 |
required |
Sponsor Study ID: Item #1011 |
||
|
CM0.3 |
Optional[List[EI]] |
optional |
Alternate Study ID: Item #1036 |
|
|
CM0.4 |
str |
required |
Title of Study: Item #1013 |
|
|
CM0.5 |
Optional[List[XCN]] |
optional |
Chairman of Study: Item #1014 |
|
|
CM0.6 |
Optional[str] |
optional |
Last IRB Approval Date: Item #1015 |
|
|
CM0.7 |
Optional[str] |
optional |
Total Accrual to Date: Item #1016 |
|
|
CM0.8 |
Optional[str] |
optional |
Last Accrual Date: Item #1017 |
|
|
CM0.9 |
Optional[List[XCN]] |
optional |
Contact for Study: Item #1018 |
|
|
CM0.10 |
Optional[XTN] |
optional |
Contact’s Telephone Number: Item #1019 |
|
|
CM0.11 |
Optional[List[XAD]] |
optional |
Contact’s Address: Item #1020 |
- class hl7types.hl7.v2_8_2.segments.CM1.CM1
HL7 v2 CM1 segment.
CM1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CM1.1 |
str |
required |
Set ID - CM1: Item #1021 |
|
|
CM1.2 |
required |
Study Phase Identifier: Item #1022 |
||
|
CM1.3 |
str |
required |
Description of Study Phase: Item #1023 |
- class hl7types.hl7.v2_8_2.segments.CM2.CM2
HL7 v2 CM2 segment.
CM2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CM2.1 |
Optional[str] |
optional |
Set ID- CM2: Item #1024 |
|
|
CM2.2 |
required |
Scheduled Time Point: Item #1025 |
||
|
CM2.3 |
Optional[str] |
optional |
Description of Time Point: Item #1026 |
|
|
CM2.4 |
Optional[List[CWE]] |
optional |
Events Scheduled This Time Point: Item #1027 |
- class hl7types.hl7.v2_8_2.segments.CNS.CNS
HL7 v2 CNS segment.
CNS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CNS.1 |
Optional[str] |
optional |
Starting Notification Reference Number: Item #1402 |
|
|
CNS.2 |
Optional[str] |
optional |
Ending Notification Reference Number: Item #1403 |
|
|
CNS.3 |
Optional[str] |
optional |
Starting Notification Date/Time: Item #1404 |
|
|
CNS.4 |
Optional[str] |
optional |
Ending Notification Date/Time: Item #1405 |
|
|
CNS.5 |
Optional[CWE] |
optional |
Starting Notification Code: Item #1406 | Table HL79999 |
|
|
CNS.6 |
Optional[CWE] |
optional |
Ending Notification Code: Item #1407 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.CON.CON
HL7 v2 CON segment.
CON¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CON.1 |
str |
required |
Set ID - CON: Item #1776 |
|
|
CON.2 |
Optional[CWE] |
optional |
Consent Type: Item #1777 | Table HL70496 |
|
|
CON.3 |
Optional[str] |
optional |
Consent Form ID and Version: Item #1778 |
|
|
CON.4 |
Optional[EI] |
optional |
Consent Form Number: Item #1779 |
|
|
CON.5 |
Optional[List[FT]] |
optional |
Consent Text: Item #1780 |
|
|
CON.6 |
Optional[List[FT]] |
optional |
Subject-specific Consent Text: Item #1781 |
|
|
CON.7 |
Optional[List[FT]] |
optional |
Consent Background Information: Item #1782 |
|
|
CON.8 |
Optional[List[FT]] |
optional |
Subject-specific Consent Background Text: Item #1783 |
|
|
CON.9 |
Optional[List[FT]] |
optional |
Consenter-imposed limitations: Item #1784 |
|
|
CON.10 |
Optional[CNE] |
optional |
Consent Mode: Item #1785 | Table HL70497 |
|
|
CON.11 |
required |
Consent Status: Item #1786 | Table HL70498 |
||
|
CON.12 |
Optional[str] |
optional |
Consent Discussion Date/Time: Item #1787 |
|
|
CON.13 |
Optional[str] |
optional |
Consent Decision Date/Time: Item #1788 |
|
|
CON.14 |
Optional[str] |
optional |
Consent Effective Date/Time: Item #1789 |
|
|
CON.15 |
Optional[str] |
optional |
Consent End Date/Time: Item #1790 |
|
|
CON.16 |
Optional[str] |
optional |
Subject Competence Indicator: Item #1791 | Table HL70136 |
|
|
CON.17 |
Optional[str] |
optional |
Translator Assistance Indicator: Item #1792 | Table HL70136 |
|
|
CON.18 |
Optional[CWE] |
optional |
Language Translated To: Item #1793 | Table HL70296 |
|
|
CON.19 |
Optional[str] |
optional |
Informational Material Supplied Indicator: Item #1794 | Table HL70136 |
|
|
CON.20 |
Optional[CWE] |
optional |
Consent Bypass Reason: Item #1795 | Table HL70499 |
|
|
CON.21 |
Optional[str] |
optional |
Consent Disclosure Level: Item #1796 | Table HL70500 |
|
|
CON.22 |
Optional[CWE] |
optional |
Consent Non-disclosure Reason: Item #1797 | Table HL70501 |
|
|
CON.23 |
Optional[CWE] |
optional |
Non-subject Consenter Reason: Item #1798 | Table HL70502 |
|
|
CON.24 |
Optional[List[XPN]] |
optional |
Consenter ID: Item #1909 |
|
|
CON.25 |
Optional[List[CWE]] |
optional |
Relationship to Subject: Item #1898 | Table HL70548 |
- class hl7types.hl7.v2_8_2.segments.CSP.CSP
HL7 v2 CSP segment.
CSP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CSP.1 |
required |
Study Phase Identifier: Item #1022 |
||
|
CSP.2 |
str |
required |
Date/time Study Phase Began: Item #1052 |
|
|
CSP.3 |
Optional[str] |
optional |
Date/time Study Phase Ended: Item #1053 |
|
|
CSP.4 |
Optional[CWE] |
optional |
Study Phase Evaluability: Item #1054 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.CSR.CSR
HL7 v2 CSR segment.
CSR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CSR.1 |
required |
Sponsor Study ID: Item #1011 |
||
|
CSR.2 |
Optional[EI] |
optional |
Alternate Study ID: Item #1036 |
|
|
CSR.3 |
Optional[CWE] |
optional |
Institution Registering the Patient: Item #1037 | Table HL79999 |
|
|
CSR.4 |
required |
Sponsor Patient ID: Item #1038 |
||
|
CSR.5 |
Optional[CX] |
optional |
Alternate Patient ID - CSR: Item #1039 |
|
|
CSR.6 |
str |
required |
Date/Time of Patient Study Registration: Item #1040 |
|
|
CSR.7 |
Optional[List[XCN]] |
optional |
Person Performing Study Registration: Item #1041 |
|
|
CSR.8 |
Optional[List[XCN]] |
optional |
Study Authorizing Provider: Item #1042 |
|
|
CSR.9 |
Optional[str] |
optional |
Date/Time Patient Study Consent Signed: Item #1043 |
|
|
CSR.10 |
Optional[CWE] |
optional |
Patient Study Eligibility Status: Item #1044 | Table HL79999 |
|
|
CSR.11 |
Optional[List[str]] |
optional |
Study Randomization Date/time: Item #1045 |
|
|
CSR.12 |
Optional[List[CWE]] |
optional |
Randomized Study Arm: Item #1046 | Table HL79999 |
|
|
CSR.13 |
Optional[List[CWE]] |
optional |
Stratum for Study Randomization: Item #1047 | Table HL79999 |
|
|
CSR.14 |
Optional[CWE] |
optional |
Patient Evaluability Status: Item #1048 | Table HL79999 |
|
|
CSR.15 |
Optional[str] |
optional |
Date/Time Ended Study: Item #1049 |
|
|
CSR.16 |
Optional[CWE] |
optional |
Reason Ended Study: Item #1050 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.CSS.CSS
HL7 v2 CSS segment.
CSS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CSS.1 |
required |
Study Scheduled Time Point: Item #1055 | Table HL79999 |
||
|
CSS.2 |
Optional[str] |
optional |
Study Scheduled Patient Time Point: Item #1056 |
|
|
CSS.3 |
Optional[List[CWE]] |
optional |
Study Quality Control Codes: Item #1057 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.CTD.CTD
HL7 v2 CTD segment.
CTD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CTD.1 |
Optional[List[CWE]] |
optional |
Contact Role: Item #196 | Table HL70131 |
|
|
CTD.2 |
Optional[List[XPN]] |
optional |
Contact Name: Item #1165 |
|
|
CTD.3 |
Optional[List[XAD]] |
optional |
Contact Address: Item #1166 |
|
|
CTD.4 |
Optional[PL] |
optional |
Contact Location: Item #1167 |
|
|
CTD.5 |
Optional[List[XTN]] |
optional |
Contact Communication Information: Item #1168 |
|
|
CTD.6 |
Optional[CWE] |
optional |
Preferred Method of Contact: Item #684 | Table HL70185 |
|
|
CTD.7 |
Optional[List[PLN]] |
optional |
Contact Identifiers: Item #1171 | Table HL70338 |
- class hl7types.hl7.v2_8_2.segments.CTI.CTI
HL7 v2 CTI segment.
CTI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
CTI.1 |
required |
Sponsor Study ID: Item #1011 |
||
|
CTI.2 |
Optional[CWE] |
optional |
Study Phase Identifier: Item #1022 |
|
|
CTI.3 |
Optional[CWE] |
optional |
Study Scheduled Time Point: Item #1055 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.DB1.DB1
HL7 v2 DB1 segment.
DB1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DB1.1 |
str |
required |
Set ID - DB1: Item #1283 |
|
|
DB1.2 |
Optional[CWE] |
optional |
Disabled Person Code: Item #1284 | Table HL70334 |
|
|
DB1.3 |
Optional[List[CX]] |
optional |
Disabled Person Identifier: Item #1285 |
|
|
DB1.4 |
Optional[str] |
optional |
Disability Indicator: Item #1286 | Table HL70136 |
|
|
DB1.5 |
Optional[str] |
optional |
Disability Start Date: Item #1287 |
|
|
DB1.6 |
Optional[str] |
optional |
Disability End Date: Item #1288 |
|
|
DB1.7 |
Optional[str] |
optional |
Disability Return to Work Date: Item #1289 |
|
|
DB1.8 |
Optional[str] |
optional |
Disability Unable to Work Date: Item #1290 |
- class hl7types.hl7.v2_8_2.segments.DG1.DG1
HL7 v2 DG1 segment.
DG1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DG1.1 |
str |
required |
Set ID - DG1: Item #375 |
|
|
DG1.3 |
required |
Diagnosis Code - DG1: Item #377 | Table HL70051 |
||
|
DG1.5 |
Optional[str] |
optional |
Diagnosis Date/Time: Item #379 |
|
|
DG1.6 |
required |
Diagnosis Type: Item #380 | Table HL70052 |
||
|
DG1.15 |
Optional[str] |
optional |
Diagnosis Priority: Item #389 | Table HL70359 |
|
|
DG1.16 |
Optional[List[XCN]] |
optional |
Diagnosing Clinician: Item #390 |
|
|
DG1.17 |
Optional[CWE] |
optional |
Diagnosis Classification: Item #766 | Table HL70228 |
|
|
DG1.18 |
Optional[str] |
optional |
Confidential Indicator: Item #767 | Table HL70136 |
|
|
DG1.19 |
Optional[str] |
optional |
Attestation Date/Time: Item #768 |
|
|
DG1.20 |
Optional[EI] |
optional |
Diagnosis Identifier: Item #1850 |
|
|
DG1.21 |
Optional[str] |
optional |
Diagnosis Action Code: Item #1894 | Table HL70206 |
|
|
DG1.22 |
Optional[EI] |
optional |
Parent Diagnosis: Item #2152 |
|
|
DG1.23 |
Optional[CWE] |
optional |
DRG CCL Value Code: Item #2153 | Table HL70728 |
|
|
DG1.24 |
Optional[str] |
optional |
DRG Grouping Usage: Item #2154 | Table HL70136 |
|
|
DG1.25 |
Optional[CWE] |
optional |
DRG Diagnosis Determination Status: Item #2155 | Table HL70731 |
|
|
DG1.26 |
Optional[CWE] |
optional |
Present On Admission (POA) Indicator: Item #2288 | Table HL70895 |
- class hl7types.hl7.v2_8_2.segments.DMI.DMI
HL7 v2 DMI segment.
DMI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DMI.1 |
Optional[CNE] |
optional |
Diagnostic Related Group: Item #382 | Table HL70055 |
|
|
DMI.2 |
Optional[CNE] |
optional |
Major Diagnostic Category: Item #381 | Table HL70118 |
|
|
DMI.3 |
Optional[NR] |
optional |
Lower and Upper Trim Points: Item #2231 |
|
|
DMI.4 |
Optional[str] |
optional |
Average Length of Stay: Item #2232 |
|
|
DMI.5 |
Optional[str] |
optional |
Relative Weight: Item #2233 |
- class hl7types.hl7.v2_8_2.segments.DON.DON
HL7 v2 DON segment.
DON¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DON.1 |
Optional[EI] |
optional |
Donation Identification Number - DIN: Item #3340 |
|
|
DON.2 |
Optional[CNE] |
optional |
Donation Type: Item #3341 |
|
|
DON.3 |
str |
required |
Phlebotomy Start Date/Time: Item #3342 |
|
|
DON.4 |
str |
required |
Phlebotomy End Date/Time: Item #3343 |
|
|
DON.5 |
str |
required |
Donation Duration: Item #3344 |
|
|
DON.6 |
required |
Donation Duration Units: Item #3345 | Table HL70932 |
||
|
DON.7 |
List[CNE] |
required |
Intended Procedure Type: Item #3346 | Table HL70933 |
|
|
DON.8 |
List[CNE] |
required |
Actual Procedure Type: Item #3347 | Table HL70933 |
|
|
DON.9 |
str |
required |
Donor Eligibility Flag: Item #3348 | Table HL70136 |
|
|
DON.10 |
List[CNE] |
required |
Donor Eligibility Procedure Type: Item #3349 | Table HL70933 |
|
|
DON.11 |
str |
required |
Donor Eligibility Date: Item #3350 |
|
|
DON.12 |
required |
Process Interruption: Item #3351 | Table HL70923 |
||
|
DON.13 |
required |
Process Interruption Reason: Item #3352 | Table HL70935 |
||
|
DON.14 |
List[CNE] |
required |
Phlebotomy Issue: Item #3353 | Table HL70925 |
|
|
DON.15 |
str |
required |
Intended Recipient Blood Relative: Item #3354 | Table HL70136 |
|
|
DON.16 |
required |
Intended Recipient Name: Item #3355 |
||
|
DON.17 |
str |
required |
Intended Recipient DOB: Item #3356 |
|
|
DON.18 |
required |
Intended Recipient Facility: Item #3357 |
||
|
DON.19 |
str |
required |
Intended Recipient Procedure Date: Item #3358 |
|
|
DON.20 |
required |
Intended Recipient Ordering Provider: Item #3359 |
||
|
DON.21 |
required |
Phlebotomy Status: Item #3360 | Table HL70926 |
||
|
DON.22 |
required |
Arm Stick: Item #3361 | Table HL70927 |
||
|
DON.23 |
required |
Bleed Start Phlebotomist: Item #3362 |
||
|
DON.24 |
required |
Bleed End Phlebotomist: Item #3363 |
||
|
DON.25 |
str |
required |
Aphaeresis Type Machine: Item #3364 |
|
|
DON.26 |
str |
required |
Aphaeresis Machine Serial Number: Item #3365 |
|
|
DON.27 |
str |
required |
Donor Reaction: Item #3366 | Table HL70136 |
|
|
DON.28 |
required |
Final Review Staff ID: Item #3367 |
||
|
DON.29 |
str |
required |
Final Review Date/Time: Item #3368 |
|
|
DON.30 |
str |
required |
Number of Tubes Collected: Item #3369 |
|
|
DON.31 |
Optional[List[EI]] |
optional |
Donation Sample Identifier: Item #3370 |
|
|
DON.32 |
required |
Donation Accept Staff: Item #3371 |
||
|
DON.33 |
Optional[List[XCN]] |
optional |
Donation Material Review Staff: Item #3372 |
- class hl7types.hl7.v2_8_2.segments.DPS.DPS
HL7 v2 DPS segment.
DPS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DPS.1 |
required |
Diagnosis Code - MCP: Item #3472 | Table HL70051 |
||
|
DPS.2 |
Optional[List[CWE]] |
optional |
Procedure Code: Item #3484 | Table HL70941 |
|
|
DPS.3 |
Optional[str] |
optional |
Effective Date/Time: Item #662 |
|
|
DPS.4 |
Optional[str] |
optional |
Expiration Date/Time: Item #3473 |
|
|
DPS.5 |
Optional[CNE] |
optional |
Type of Limitation: Item #3474 | Table HL70940 |
- class hl7types.hl7.v2_8_2.segments.DRG.DRG
HL7 v2 DRG segment.
DRG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DRG.1 |
Optional[CNE] |
optional |
Diagnostic Related Group: Item #382 | Table HL70055 |
|
|
DRG.2 |
Optional[str] |
optional |
DRG Assigned Date/Time: Item #769 |
|
|
DRG.3 |
Optional[str] |
optional |
DRG Approval Indicator: Item #383 | Table HL70136 |
|
|
DRG.4 |
Optional[CWE] |
optional |
DRG Grouper Review Code: Item #384 | Table HL70056 |
|
|
DRG.5 |
Optional[CWE] |
optional |
Outlier Type: Item #385 | Table HL70083 |
|
|
DRG.6 |
Optional[str] |
optional |
Outlier Days: Item #386 |
|
|
DRG.7 |
Optional[CP] |
optional |
Outlier Cost: Item #387 |
|
|
DRG.8 |
Optional[CWE] |
optional |
DRG Payor: Item #770 | Table HL70229 |
|
|
DRG.9 |
Optional[CP] |
optional |
Outlier Reimbursement: Item #771 |
|
|
DRG.10 |
Optional[str] |
optional |
Confidential Indicator: Item #767 | Table HL70136 |
|
|
DRG.11 |
Optional[CWE] |
optional |
DRG Transfer Type: Item #1500 | Table HL70415 |
|
|
DRG.12 |
Optional[XPN] |
optional |
Name of Coder: Item #2156 |
|
|
DRG.13 |
Optional[CWE] |
optional |
Grouper Status: Item #2157 | Table HL70734 |
|
|
DRG.14 |
Optional[CWE] |
optional |
PCCL Value Code: Item #2158 | Table HL70728 |
|
|
DRG.15 |
Optional[str] |
optional |
Effective Weight: Item #2159 |
|
|
DRG.16 |
Optional[MO] |
optional |
Monetary Amount: Item #2160 |
|
|
DRG.17 |
Optional[CWE] |
optional |
Status Patient: Item #2161 | Table HL70739 |
|
|
DRG.18 |
Optional[str] |
optional |
Grouper Software Name: Item #2162 |
|
|
DRG.19 |
Optional[str] |
optional |
Grouper Software Version: Item #2282 |
|
|
DRG.20 |
Optional[CWE] |
optional |
Status Financial Calculation: Item #2163 | Table HL70742 |
|
|
DRG.21 |
Optional[MO] |
optional |
Relative Discount/Surcharge: Item #2164 |
|
|
DRG.22 |
Optional[MO] |
optional |
Basic Charge: Item #2165 |
|
|
DRG.23 |
Optional[MO] |
optional |
Total Charge: Item #2166 |
|
|
DRG.24 |
Optional[MO] |
optional |
Discount/Surcharge: Item #2167 |
|
|
DRG.25 |
Optional[str] |
optional |
Calculated Days: Item #2168 |
|
|
DRG.26 |
Optional[CWE] |
optional |
Status Gender: Item #2169 | Table HL70749 |
|
|
DRG.27 |
Optional[CWE] |
optional |
Status Age: Item #2170 | Table HL70749 |
|
|
DRG.28 |
Optional[CWE] |
optional |
Status Length of Stay: Item #2171 | Table HL70749 |
|
|
DRG.29 |
Optional[CWE] |
optional |
Status Same Day Flag: Item #2172 | Table HL70749 |
|
|
DRG.30 |
Optional[CWE] |
optional |
Status Separation Mode: Item #2173 | Table HL70749 |
|
|
DRG.31 |
Optional[CWE] |
optional |
Status Weight at Birth: Item #2174 | Table HL70755 |
|
|
DRG.32 |
Optional[CWE] |
optional |
Status Respiration Minutes: Item #2175 | Table HL70757 |
|
|
DRG.33 |
Optional[CWE] |
optional |
Status Admission: Item #2176 | Table HL70759 |
- class hl7types.hl7.v2_8_2.segments.DSC.DSC
HL7 v2 DSC segment.
DSC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DSC.1 |
Optional[str] |
optional |
Continuation Pointer: Item #14 |
|
|
DSC.2 |
Optional[str] |
optional |
Continuation Style: Item #1354 | Table HL70398 |
- class hl7types.hl7.v2_8_2.segments.DSP.DSP
HL7 v2 DSP segment.
DSP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DSP.1 |
Optional[str] |
optional |
Set ID - DSP: Item #61 |
|
|
DSP.2 |
Optional[str] |
optional |
Display Level: Item #62 |
|
|
DSP.3 |
TX |
required |
Data Line: Item #63 |
|
|
DSP.4 |
Optional[str] |
optional |
Logical Break Point: Item #64 |
|
|
DSP.5 |
Optional[TX] |
optional |
Result ID: Item #65 |
- class hl7types.hl7.v2_8_2.segments.ECD.ECD
HL7 v2 ECD segment.
ECD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ECD.1 |
str |
required |
Reference Command Number: Item #1390 |
|
|
ECD.2 |
required |
Remote Control Command: Item #1391 | Table HL70368 |
||
|
ECD.3 |
Optional[str] |
optional |
Response Required: Item #1392 | Table HL70136 |
|
|
ECD.5 |
Optional[List[TX]] |
optional |
Parameters: Item #1394 |
- class hl7types.hl7.v2_8_2.segments.ECR.ECR
HL7 v2 ECR segment.
ECR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ECR.1 |
required |
Command Response: Item #1395 | Table HL70387 |
||
|
ECR.2 |
str |
required |
Date/Time Completed: Item #1396 |
|
|
ECR.3 |
Optional[List[TX]] |
optional |
Command Response Parameters: Item #1397 |
- class hl7types.hl7.v2_8_2.segments.EDU.EDU
HL7 v2 EDU segment.
EDU¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
EDU.1 |
str |
required |
Set ID - EDU: Item #1448 |
|
|
EDU.2 |
Optional[CWE] |
optional |
Academic Degree: Item #1449 | Table HL70360 |
|
|
EDU.3 |
Optional[DR] |
optional |
Academic Degree Program Date Range: Item #1597 |
|
|
EDU.4 |
Optional[DR] |
optional |
Academic Degree Program Participation Date Range: Item #1450 |
|
|
EDU.5 |
Optional[str] |
optional |
Academic Degree Granted Date: Item #1451 |
|
|
EDU.6 |
Optional[XON] |
optional |
School: Item #1452 |
|
|
EDU.7 |
Optional[CWE] |
optional |
School Type Code: Item #1453 | Table HL70402 |
|
|
EDU.8 |
Optional[XAD] |
optional |
School Address: Item #1454 |
|
|
EDU.9 |
Optional[List[CWE]] |
optional |
Major Field of Study: Item #1885 |
- class hl7types.hl7.v2_8_2.segments.EQP.EQP
HL7 v2 EQP segment.
EQP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
EQP.1 |
required |
Event type: Item #1430 | Table HL70450 |
||
|
EQP.2 |
Optional[str] |
optional |
File Name: Item #1431 |
|
|
EQP.3 |
str |
required |
Start Date/Time: Item #1202 |
|
|
EQP.4 |
Optional[str] |
optional |
End Date/Time: Item #1432 |
|
|
EQP.5 |
FT |
required |
Transaction Data: Item #1433 |
- class hl7types.hl7.v2_8_2.segments.EQU.EQU
HL7 v2 EQU segment.
EQU¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
EQU.1 |
Optional[List[EI]] |
optional |
Equipment Instance Identifier: Item #1479 |
|
|
EQU.2 |
str |
required |
Event Date/Time: Item #1322 |
|
|
EQU.3 |
Optional[CWE] |
optional |
Equipment State: Item #1323 | Table HL70365 |
|
|
EQU.4 |
Optional[CWE] |
optional |
Local/Remote Control State: Item #1324 | Table HL70366 |
|
|
EQU.5 |
Optional[CWE] |
optional |
Alert Level: Item #1325 | Table HL70367 |
- class hl7types.hl7.v2_8_2.segments.ERR.ERR
HL7 v2 ERR segment.
ERR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ERR.2 |
Optional[List[ERL]] |
optional |
Error Location: Item #1812 |
|
|
ERR.3 |
required |
HL7 Error Code: Item #1813 | Table HL70357 |
||
|
ERR.4 |
str |
required |
Severity: Item #1814 | Table HL70516 |
|
|
ERR.5 |
Optional[CWE] |
optional |
Application Error Code: Item #1815 | Table HL70533 |
|
|
ERR.6 |
Optional[List[str]] |
optional |
Application Error Parameter: Item #1816 |
|
|
ERR.7 |
Optional[TX] |
optional |
Diagnostic Information: Item #1817 |
|
|
ERR.8 |
Optional[TX] |
optional |
User Message: Item #1818 |
|
|
ERR.9 |
Optional[List[CWE]] |
optional |
Inform Person Indicator: Item #1819 | Table HL70517 |
|
|
ERR.10 |
Optional[CWE] |
optional |
Override Type: Item #1820 | Table HL70518 |
|
|
ERR.11 |
Optional[List[CWE]] |
optional |
Override Reason Code: Item #1821 | Table HL70519 |
|
|
ERR.12 |
Optional[List[XTN]] |
optional |
Help Desk Contact Point: Item #1822 |
- class hl7types.hl7.v2_8_2.segments.EVN.EVN
HL7 v2 EVN segment.
EVN¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
EVN.2 |
str |
required |
Recorded Date/Time: Item #100 |
|
|
EVN.3 |
Optional[str] |
optional |
Date/Time Planned Event: Item #101 |
|
|
EVN.4 |
Optional[CWE] |
optional |
Event Reason Code: Item #102 | Table HL70062 |
|
|
EVN.5 |
Optional[List[XCN]] |
optional |
Operator ID: Item #103 | Table HL70188 |
|
|
EVN.6 |
Optional[str] |
optional |
Event Occurred: Item #1278 |
|
|
EVN.7 |
Optional[HD] |
optional |
Event Facility: Item #1534 |
- class hl7types.hl7.v2_8_2.segments.FAC.FAC
HL7 v2 FAC segment.
FAC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
FAC.1 |
required |
Facility ID-FAC: Item #1262 |
||
|
FAC.2 |
Optional[str] |
optional |
Facility Type: Item #1263 | Table HL70331 |
|
|
FAC.3 |
Optional[List[XAD]] |
optional |
Facility Address: Item #1264 |
|
|
FAC.4 |
required |
Facility Telecommunication: Item #1265 |
||
|
FAC.5 |
Optional[List[XCN]] |
optional |
Contact Person: Item #1266 |
|
|
FAC.6 |
Optional[List[str]] |
optional |
Contact Title: Item #1267 |
|
|
FAC.7 |
Optional[List[XAD]] |
optional |
Contact Address: Item #1166 |
|
|
FAC.8 |
Optional[List[XTN]] |
optional |
Contact Telecommunication: Item #1269 |
|
|
FAC.9 |
Optional[List[XCN]] |
optional |
Signature Authority: Item #1270 |
|
|
FAC.10 |
Optional[str] |
optional |
Signature Authority Title: Item #1271 |
|
|
FAC.11 |
Optional[List[XAD]] |
optional |
Signature Authority Address: Item #1272 |
|
|
FAC.12 |
Optional[XTN] |
optional |
Signature Authority Telecommunication: Item #1273 |
- class hl7types.hl7.v2_8_2.segments.FHS.FHS
HL7 v2 FHS segment.
FHS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
FHS.1 |
str |
optional |
File Field Separator: Item #67 |
|
|
FHS.2 |
str |
optional |
File Encoding Characters: Item #68 |
|
|
FHS.3 |
Optional[HD] |
optional |
File Sending Application: Item #69 |
|
|
FHS.4 |
Optional[HD] |
optional |
File Sending Facility: Item #70 |
|
|
FHS.5 |
Optional[HD] |
optional |
File Receiving Application: Item #71 |
|
|
FHS.6 |
Optional[HD] |
optional |
File Receiving Facility: Item #72 |
|
|
FHS.7 |
Optional[str] |
optional |
File Creation Date/Time: Item #73 |
|
|
FHS.8 |
Optional[str] |
optional |
File Security: Item #74 |
|
|
FHS.9 |
Optional[str] |
optional |
File Name/ID: Item #75 |
|
|
FHS.10 |
Optional[str] |
optional |
File Header Comment: Item #76 |
|
|
FHS.11 |
Optional[str] |
optional |
File Control ID: Item #77 |
|
|
FHS.12 |
Optional[str] |
optional |
Reference File Control ID: Item #78 |
|
|
FHS.13 |
Optional[HD] |
optional |
File Sending Network Address: Item #2269 |
|
|
FHS.14 |
Optional[HD] |
optional |
File Receiving Network Address: Item #2270 |
- class hl7types.hl7.v2_8_2.segments.FT1.FT1
HL7 v2 FT1 segment.
FT1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
FT1.1 |
Optional[str] |
optional |
Set ID - FT1: Item #355 |
|
|
FT1.2 |
Optional[str] |
optional |
Transaction ID: Item #356 |
|
|
FT1.3 |
Optional[str] |
optional |
Transaction Batch ID: Item #357 |
|
|
FT1.4 |
required |
Transaction Date: Item #358 |
||
|
FT1.5 |
Optional[str] |
optional |
Transaction Posting Date: Item #359 |
|
|
FT1.6 |
required |
Transaction Type: Item #360 | Table HL70017 |
||
|
FT1.7 |
required |
Transaction Code: Item #361 | Table HL70132 |
||
|
FT1.10 |
Optional[str] |
optional |
Transaction Quantity: Item #364 |
|
|
FT1.11 |
Optional[CP] |
optional |
Transaction Amount - Extended: Item #365 |
|
|
FT1.12 |
Optional[CP] |
optional |
Transaction amount - unit: Item #366 |
|
|
FT1.13 |
Optional[CWE] |
optional |
Department Code: Item #367 | Table HL70049 |
|
|
FT1.14 |
Optional[CWE] |
optional |
Health Plan ID: Item #368 | Table HL70072 |
|
|
FT1.15 |
Optional[CP] |
optional |
Insurance Amount: Item #369 |
|
|
FT1.16 |
Optional[PL] |
optional |
Assigned Patient Location: Item #133 |
|
|
FT1.17 |
Optional[CWE] |
optional |
Fee Schedule: Item #370 | Table HL70024 |
|
|
FT1.18 |
Optional[CWE] |
optional |
Patient Type: Item #148 | Table HL70018 |
|
|
FT1.19 |
Optional[List[CWE]] |
optional |
Diagnosis Code - FT1: Item #371 | Table HL70051 |
|
|
FT1.20 |
Optional[List[XCN]] |
optional |
Performed By Code: Item #372 | Table HL70084 |
|
|
FT1.21 |
Optional[List[XCN]] |
optional |
Ordered By Code: Item #373 |
|
|
FT1.22 |
Optional[CP] |
optional |
Unit Cost: Item #374 |
|
|
FT1.23 |
Optional[EI] |
optional |
Filler Order Number: Item #217 |
|
|
FT1.24 |
Optional[List[XCN]] |
optional |
Entered By Code: Item #765 |
|
|
FT1.25 |
Optional[CNE] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
FT1.26 |
Optional[List[CNE]] |
optional |
Procedure Code Modifier: Item #1316 | Table HL70340 |
|
|
FT1.27 |
Optional[CWE] |
optional |
Advanced Beneficiary Notice Code: Item #1310 | Table HL70339 |
|
|
FT1.28 |
Optional[CWE] |
optional |
Medically Necessary Duplicate Procedure Reason: Item #1646 | Table HL70476 |
|
|
FT1.29 |
Optional[CWE] |
optional |
NDC Code: Item #1845 | Table HL70549 |
|
|
FT1.30 |
Optional[CX] |
optional |
Payment Reference ID: Item #1846 |
|
|
FT1.31 |
Optional[List[str]] |
optional |
Transaction Reference Key: Item #1847 |
|
|
FT1.32 |
Optional[List[XON]] |
optional |
Performing Facility: Item #2361 |
|
|
FT1.33 |
Optional[XON] |
optional |
Ordering Facility: Item #2362 |
|
|
FT1.34 |
Optional[CWE] |
optional |
Item Number: Item #2363 |
|
|
FT1.35 |
Optional[str] |
optional |
Model Number: Item #2364 |
|
|
FT1.36 |
Optional[List[CWE]] |
optional |
Special Processing Code: Item #2365 |
|
|
FT1.37 |
Optional[CWE] |
optional |
Clinic Code: Item #2366 |
|
|
FT1.38 |
Optional[CX] |
optional |
Referral Number: Item #2367 |
|
|
FT1.39 |
Optional[CX] |
optional |
Authorization Number: Item #2368 |
|
|
FT1.40 |
Optional[CWE] |
optional |
Service Provider Taxonomy Code: Item #2369 |
|
|
FT1.41 |
Optional[CWE] |
optional |
Revenue Code: Item #1600 | Table HL70456 |
|
|
FT1.42 |
Optional[str] |
optional |
Prescription Number: Item #325 |
|
|
FT1.43 |
Optional[CQ] |
optional |
NDC Qty and UOM: Item #2370 |
- class hl7types.hl7.v2_8_2.segments.FTS.FTS
HL7 v2 FTS segment.
FTS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
FTS.1 |
Optional[str] |
optional |
File Batch Count: Item #79 |
|
|
FTS.2 |
Optional[str] |
optional |
File Trailer Comment: Item #80 |
- class hl7types.hl7.v2_8_2.segments.GOL.GOL
HL7 v2 GOL segment.
GOL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
GOL.1 |
str |
required |
Action Code: Item #816 | Table HL70206 |
|
|
GOL.2 |
str |
required |
Action Date/Time: Item #817 |
|
|
GOL.3 |
required |
Goal ID: Item #818 |
||
|
GOL.4 |
required |
Goal Instance ID: Item #819 |
||
|
GOL.5 |
Optional[EI] |
optional |
Episode of Care ID: Item #820 |
|
|
GOL.6 |
Optional[str] |
optional |
Goal List Priority: Item #821 |
|
|
GOL.7 |
Optional[str] |
optional |
Goal Established Date/Time: Item #822 |
|
|
GOL.8 |
Optional[str] |
optional |
Expected Goal Achieve Date/Time: Item #824 |
|
|
GOL.9 |
Optional[CWE] |
optional |
Goal Classification: Item #825 |
|
|
GOL.10 |
Optional[CWE] |
optional |
Goal Management Discipline: Item #826 |
|
|
GOL.11 |
Optional[CWE] |
optional |
Current Goal Review Status: Item #827 |
|
|
GOL.12 |
Optional[str] |
optional |
Current Goal Review Date/Time: Item #828 |
|
|
GOL.13 |
Optional[str] |
optional |
Next Goal Review Date/Time: Item #829 |
|
|
GOL.14 |
Optional[str] |
optional |
Previous Goal Review Date/Time: Item #830 |
|
|
GOL.16 |
Optional[CWE] |
optional |
Goal Evaluation: Item #832 |
|
|
GOL.17 |
Optional[List[str]] |
optional |
Goal Evaluation Comment: Item #833 |
|
|
GOL.18 |
Optional[CWE] |
optional |
Goal Life Cycle Status: Item #834 |
|
|
GOL.19 |
Optional[str] |
optional |
Goal Life Cycle Status Date/Time: Item #835 |
|
|
GOL.20 |
Optional[List[CWE]] |
optional |
Goal Target Type: Item #836 |
|
|
GOL.21 |
Optional[List[XPN]] |
optional |
Goal Target Name: Item #837 |
|
|
GOL.22 |
Optional[CNE] |
optional |
Mood Code: Item #2182 | Table HL70725 |
- class hl7types.hl7.v2_8_2.segments.GP1.GP1
HL7 v2 GP1 segment.
GP1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
GP1.1 |
required |
Type of Bill Code: Item #1599 | Table HL70455 |
||
|
GP1.2 |
Optional[List[CWE]] |
optional |
Revenue Code: Item #1600 | Table HL70456 |
|
|
GP1.3 |
Optional[CWE] |
optional |
Overall Claim Disposition Code: Item #1601 | Table HL70457 |
|
|
GP1.4 |
Optional[List[CWE]] |
optional |
OCE Edits per Visit Code: Item #1602 | Table HL70458 |
|
|
GP1.5 |
Optional[CP] |
optional |
Outlier Cost: Item #387 |
- class hl7types.hl7.v2_8_2.segments.GP2.GP2
HL7 v2 GP2 segment.
GP2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
GP2.1 |
Optional[CWE] |
optional |
Revenue Code: Item #1600 | Table HL70456 |
|
|
GP2.2 |
Optional[str] |
optional |
Number of Service Units: Item #1604 |
|
|
GP2.3 |
Optional[CP] |
optional |
Charge: Item #1605 |
|
|
GP2.4 |
Optional[CWE] |
optional |
Reimbursement Action Code: Item #1606 | Table HL70459 |
|
|
GP2.5 |
Optional[CWE] |
optional |
Denial or Rejection Code: Item #1607 | Table HL70460 |
|
|
GP2.6 |
Optional[List[CWE]] |
optional |
OCE Edit Code: Item #1608 | Table HL70458 |
|
|
GP2.7 |
Optional[CWE] |
optional |
Ambulatory Payment Classification Code: Item #1609 | Table HL70466 |
|
|
GP2.8 |
Optional[List[CWE]] |
optional |
Modifier Edit Code: Item #1610 | Table HL70467 |
|
|
GP2.9 |
Optional[CWE] |
optional |
Payment Adjustment Code: Item #1611 | Table HL70468 |
|
|
GP2.10 |
Optional[CWE] |
optional |
Packaging Status Code: Item #1617 | Table HL70469 |
|
|
GP2.11 |
Optional[CP] |
optional |
Expected CMS Payment Amount: Item #1618 |
|
|
GP2.12 |
Optional[CWE] |
optional |
Reimbursement Type Code: Item #1619 | Table HL70470 |
|
|
GP2.13 |
Optional[CP] |
optional |
Co-Pay Amount: Item #1620 |
|
|
GP2.14 |
Optional[str] |
optional |
Pay Rate per Service Unit: Item #1621 |
- class hl7types.hl7.v2_8_2.segments.GT1.GT1
HL7 v2 GT1 segment.
GT1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
GT1.1 |
str |
required |
Set ID - GT1: Item #405 |
|
|
GT1.2 |
Optional[List[CX]] |
optional |
Guarantor Number: Item #406 |
|
|
GT1.3 |
Optional[List[XPN]] |
optional |
Guarantor Name: Item #407 |
|
|
GT1.4 |
Optional[List[XPN]] |
optional |
Guarantor Spouse Name: Item #408 |
|
|
GT1.5 |
Optional[List[XAD]] |
optional |
Guarantor Address: Item #409 |
|
|
GT1.6 |
Optional[List[XTN]] |
optional |
Guarantor Ph Num - Home: Item #410 |
|
|
GT1.7 |
Optional[List[XTN]] |
optional |
Guarantor Ph Num - Business: Item #411 |
|
|
GT1.8 |
Optional[str] |
optional |
Guarantor Date/Time Of Birth: Item #412 |
|
|
GT1.9 |
Optional[CWE] |
optional |
Guarantor Administrative Sex: Item #413 | Table HL70001 |
|
|
GT1.10 |
Optional[CWE] |
optional |
Guarantor Type: Item #414 | Table HL70068 |
|
|
GT1.11 |
Optional[CWE] |
optional |
Guarantor Relationship: Item #415 | Table HL70063 |
|
|
GT1.12 |
Optional[str] |
optional |
Guarantor SSN: Item #416 |
|
|
GT1.13 |
Optional[str] |
optional |
Guarantor Date - Begin: Item #417 |
|
|
GT1.14 |
Optional[str] |
optional |
Guarantor Date - End: Item #418 |
|
|
GT1.15 |
Optional[str] |
optional |
Guarantor Priority: Item #419 |
|
|
GT1.16 |
Optional[List[XPN]] |
optional |
Guarantor Employer Name: Item #420 |
|
|
GT1.17 |
Optional[List[XAD]] |
optional |
Guarantor Employer Address: Item #421 |
|
|
GT1.18 |
Optional[List[XTN]] |
optional |
Guarantor Employer Phone Number: Item #422 |
|
|
GT1.19 |
Optional[List[CX]] |
optional |
Guarantor Employee ID Number: Item #423 |
|
|
GT1.20 |
Optional[CWE] |
optional |
Guarantor Employment Status: Item #424 | Table HL70066 |
|
|
GT1.21 |
Optional[List[XON]] |
optional |
Guarantor Organization Name: Item #425 |
|
|
GT1.22 |
Optional[str] |
optional |
Guarantor Billing Hold Flag: Item #773 | Table HL70136 |
|
|
GT1.23 |
Optional[CWE] |
optional |
Guarantor Credit Rating Code: Item #774 | Table HL70341 |
|
|
GT1.24 |
Optional[str] |
optional |
Guarantor Death Date And Time: Item #775 |
|
|
GT1.25 |
Optional[str] |
optional |
Guarantor Death Flag: Item #776 | Table HL70136 |
|
|
GT1.26 |
Optional[CWE] |
optional |
Guarantor Charge Adjustment Code: Item #777 | Table HL70218 |
|
|
GT1.27 |
Optional[CP] |
optional |
Guarantor Household Annual Income: Item #778 |
|
|
GT1.28 |
Optional[str] |
optional |
Guarantor Household Size: Item #779 |
|
|
GT1.29 |
Optional[List[CX]] |
optional |
Guarantor Employer ID Number: Item #780 |
|
|
GT1.30 |
Optional[CWE] |
optional |
Guarantor Marital Status Code: Item #781 | Table HL70002 |
|
|
GT1.31 |
Optional[str] |
optional |
Guarantor Hire Effective Date: Item #782 |
|
|
GT1.32 |
Optional[str] |
optional |
Employment Stop Date: Item #783 |
|
|
GT1.33 |
Optional[CWE] |
optional |
Living Dependency: Item #755 | Table HL70223 |
|
|
GT1.34 |
Optional[List[CWE]] |
optional |
Ambulatory Status: Item #145 | Table HL70009 |
|
|
GT1.35 |
Optional[List[CWE]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
GT1.36 |
Optional[CWE] |
optional |
Primary Language: Item #118 | Table HL70296 |
|
|
GT1.37 |
Optional[CWE] |
optional |
Living Arrangement: Item #742 | Table HL70220 |
|
|
GT1.38 |
Optional[CWE] |
optional |
Publicity Code: Item #743 | Table HL70215 |
|
|
GT1.39 |
Optional[str] |
optional |
Protection Indicator: Item #744 | Table HL70136 |
|
|
GT1.40 |
Optional[CWE] |
optional |
Student Indicator: Item #745 | Table HL70231 |
|
|
GT1.41 |
Optional[CWE] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
GT1.42 |
Optional[List[XPN]] |
optional |
Mother’s Maiden Name: Item #109 |
|
|
GT1.43 |
Optional[CWE] |
optional |
Nationality: Item #739 | Table HL70212 |
|
|
GT1.44 |
Optional[List[CWE]] |
optional |
Ethnic Group: Item #125 | Table HL70189 |
|
|
GT1.45 |
Optional[List[XPN]] |
optional |
Contact Person’s Name: Item #748 |
|
|
GT1.46 |
Optional[List[XTN]] |
optional |
Contact Person’s Telephone Number: Item #749 |
|
|
GT1.47 |
Optional[CWE] |
optional |
Contact Reason: Item #747 | Table HL70222 |
|
|
GT1.48 |
Optional[CWE] |
optional |
Contact Relationship: Item #784 | Table HL70063 |
|
|
GT1.49 |
Optional[str] |
optional |
Job Title: Item #785 |
|
|
GT1.50 |
Optional[JCC] |
optional |
Job Code/Class: Item #786 |
|
|
GT1.51 |
Optional[List[XON]] |
optional |
Guarantor Employer’s Organization Name: Item #1299 |
|
|
GT1.52 |
Optional[CWE] |
optional |
Handicap: Item #753 | Table HL70295 |
|
|
GT1.53 |
Optional[CWE] |
optional |
Job Status: Item #752 | Table HL70311 |
|
|
GT1.54 |
Optional[FC] |
optional |
Guarantor Financial Class: Item #1231 |
|
|
GT1.55 |
Optional[List[CWE]] |
optional |
Guarantor Race: Item #1291 | Table HL70005 |
|
|
GT1.56 |
Optional[str] |
optional |
Guarantor Birth Place: Item #1851 |
|
|
GT1.57 |
Optional[CWE] |
optional |
VIP Indicator: Item #146 | Table HL70099 |
- class hl7types.hl7.v2_8_2.segments.IAM.IAM
HL7 v2 IAM segment.
IAM¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IAM.1 |
str |
required |
Set ID - IAM: Item #1612 |
|
|
IAM.2 |
Optional[CWE] |
optional |
Allergen Type Code: Item #204 | Table HL70127 |
|
|
IAM.3 |
required |
Allergen Code/Mnemonic/Description: Item #205 |
||
|
IAM.4 |
Optional[CWE] |
optional |
Allergy Severity Code: Item #206 | Table HL70128 |
|
|
IAM.5 |
Optional[List[str]] |
optional |
Allergy Reaction Code: Item #207 |
|
|
IAM.6 |
required |
Allergy Action Code: Item #1551 | Table HL70206 |
||
|
IAM.7 |
Optional[EI] |
optional |
Allergy Unique Identifier: Item #1552 |
|
|
IAM.8 |
Optional[str] |
optional |
Action Reason: Item #1553 |
|
|
IAM.9 |
Optional[CWE] |
optional |
Sensitivity to Causative Agent Code: Item #1554 | Table HL70436 |
|
|
IAM.10 |
Optional[CWE] |
optional |
Allergen Group Code/Mnemonic/Description: Item #1555 |
|
|
IAM.11 |
Optional[str] |
optional |
Onset Date: Item #1556 |
|
|
IAM.12 |
Optional[str] |
optional |
Onset Date Text: Item #1557 |
|
|
IAM.13 |
Optional[str] |
optional |
Reported Date/Time: Item #1558 |
|
|
IAM.14 |
Optional[XPN] |
optional |
Reported By: Item #1559 |
|
|
IAM.15 |
Optional[CWE] |
optional |
Relationship to Patient Code: Item #1560 | Table HL70063 |
|
|
IAM.16 |
Optional[CWE] |
optional |
Alert Device Code: Item #1561 | Table HL70437 |
|
|
IAM.17 |
Optional[CWE] |
optional |
Allergy Clinical Status Code: Item #1562 | Table HL70438 |
|
|
IAM.18 |
Optional[XCN] |
optional |
Statused by Person: Item #1563 |
|
|
IAM.19 |
Optional[XON] |
optional |
Statused by Organization: Item #1564 |
|
|
IAM.20 |
Optional[str] |
optional |
Statused at Date/Time: Item #1565 |
|
|
IAM.21 |
Optional[XCN] |
optional |
Inactivated by Person: Item #2294 |
|
|
IAM.22 |
Optional[str] |
optional |
Inactivated Date/Time: Item #2295 |
|
|
IAM.23 |
Optional[XCN] |
optional |
Initially Recorded by Person: Item #2296 |
|
|
IAM.24 |
Optional[str] |
optional |
Initially Recorded Date/Time: Item #2297 |
|
|
IAM.25 |
Optional[XCN] |
optional |
Modified by Person: Item #2298 |
|
|
IAM.26 |
Optional[str] |
optional |
Modified Date/Time: Item #2299 |
|
|
IAM.27 |
Optional[CWE] |
optional |
Clinician Identified Code: Item #2300 |
|
|
IAM.28 |
Optional[XON] |
optional |
Initially Recorded by Organization: Item #3293 |
|
|
IAM.29 |
Optional[XON] |
optional |
Modified by Organization: Item #3294 |
|
|
IAM.30 |
Optional[XON] |
optional |
Inactivated by Organization: Item #3295 |
- class hl7types.hl7.v2_8_2.segments.IAR.IAR
HL7 v2 IAR segment.
IAR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IAR.1 |
required |
Allergy Reaction Code: Item #3296 |
||
|
IAR.2 |
required |
Allergy Severity Code: Item #3297 | Table HL70128 |
||
|
IAR.3 |
Optional[CWE] |
optional |
Sensitivity to Causative Agent Code: Item #3298 | Table HL70436 |
|
|
IAR.4 |
Optional[str] |
optional |
Management: Item #3299 |
- class hl7types.hl7.v2_8_2.segments.IIM.IIM
HL7 v2 IIM segment.
IIM¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IIM.1 |
required |
Primary Key Value - IIM: Item #1897 |
||
|
IIM.2 |
required |
Service Item Code: Item #1799 |
||
|
IIM.3 |
Optional[str] |
optional |
Inventory Lot Number: Item #1800 |
|
|
IIM.4 |
Optional[str] |
optional |
Inventory Expiration Date: Item #1801 |
|
|
IIM.5 |
Optional[CWE] |
optional |
Inventory Manufacturer Name: Item #1802 |
|
|
IIM.6 |
Optional[CWE] |
optional |
Inventory Location: Item #1803 |
|
|
IIM.7 |
Optional[str] |
optional |
Inventory Received Date: Item #1804 |
|
|
IIM.8 |
Optional[str] |
optional |
Inventory Received Quantity: Item #1805 |
|
|
IIM.9 |
Optional[CWE] |
optional |
Inventory Received Quantity Unit: Item #1806 |
|
|
IIM.10 |
Optional[MO] |
optional |
Inventory Received Item Cost: Item #1807 |
|
|
IIM.11 |
Optional[str] |
optional |
Inventory On Hand Date: Item #1808 |
|
|
IIM.12 |
Optional[str] |
optional |
Inventory On Hand Quantity: Item #1809 |
|
|
IIM.13 |
Optional[CWE] |
optional |
Inventory On Hand Quantity Unit: Item #1810 |
|
|
IIM.14 |
Optional[CNE] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
IIM.15 |
Optional[List[CNE]] |
optional |
Procedure Code Modifier: Item #1316 | Table HL70340 |
- class hl7types.hl7.v2_8_2.segments.ILT.ILT
HL7 v2 ILT segment.
ILT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ILT.1 |
str |
required |
Set Id - ILT: Item #2086 |
|
|
ILT.2 |
str |
required |
Inventory Lot Number: Item #1800 |
|
|
ILT.3 |
Optional[str] |
optional |
Inventory Expiration Date: Item #1801 |
|
|
ILT.4 |
Optional[str] |
optional |
Inventory Received Date: Item #1804 |
|
|
ILT.5 |
Optional[str] |
optional |
Inventory Received Quantity: Item #1805 |
|
|
ILT.6 |
Optional[CWE] |
optional |
Inventory Received Quantity Unit: Item #1806 |
|
|
ILT.7 |
Optional[MO] |
optional |
Inventory Received Item Cost: Item #1807 |
|
|
ILT.8 |
Optional[str] |
optional |
Inventory On Hand Date: Item #1808 |
|
|
ILT.9 |
Optional[str] |
optional |
Inventory On Hand Quantity: Item #1809 |
|
|
ILT.10 |
Optional[CWE] |
optional |
Inventory On Hand Quantity Unit: Item #1810 |
- class hl7types.hl7.v2_8_2.segments.IN1.IN1
HL7 v2 IN1 segment.
IN1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN1.1 |
str |
required |
Set ID - IN1: Item #426 |
|
|
IN1.2 |
required |
Health Plan ID: Item #368 | Table HL70072 |
||
|
IN1.3 |
List[CX] |
required |
Insurance Company ID: Item #428 |
|
|
IN1.4 |
Optional[List[XON]] |
optional |
Insurance Company Name: Item #429 |
|
|
IN1.5 |
Optional[List[XAD]] |
optional |
Insurance Company Address: Item #430 |
|
|
IN1.6 |
Optional[List[XPN]] |
optional |
Insurance Co Contact Person: Item #431 |
|
|
IN1.7 |
Optional[List[XTN]] |
optional |
Insurance Co Phone Number: Item #432 |
|
|
IN1.8 |
Optional[str] |
optional |
Group Number: Item #433 |
|
|
IN1.9 |
Optional[List[XON]] |
optional |
Group Name: Item #434 |
|
|
IN1.10 |
Optional[List[CX]] |
optional |
Insured’s Group Emp ID: Item #435 |
|
|
IN1.11 |
Optional[List[XON]] |
optional |
Insured’s Group Emp Name: Item #436 |
|
|
IN1.12 |
Optional[str] |
optional |
Plan Effective Date: Item #437 |
|
|
IN1.13 |
Optional[str] |
optional |
Plan Expiration Date: Item #438 |
|
|
IN1.14 |
Optional[AUI] |
optional |
Authorization Information: Item #439 |
|
|
IN1.15 |
Optional[CWE] |
optional |
Plan Type: Item #440 | Table HL70086 |
|
|
IN1.16 |
Optional[List[XPN]] |
optional |
Name Of Insured: Item #441 |
|
|
IN1.17 |
Optional[CWE] |
optional |
Insured’s Relationship To Patient: Item #442 | Table HL70063 |
|
|
IN1.18 |
Optional[str] |
optional |
Insured’s Date Of Birth: Item #443 |
|
|
IN1.19 |
Optional[List[XAD]] |
optional |
Insured’s Address: Item #444 |
|
|
IN1.20 |
Optional[CWE] |
optional |
Assignment Of Benefits: Item #445 | Table HL70135 |
|
|
IN1.21 |
Optional[CWE] |
optional |
Coordination Of Benefits: Item #446 | Table HL70173 |
|
|
IN1.22 |
Optional[str] |
optional |
Coord Of Ben. Priority: Item #447 |
|
|
IN1.23 |
Optional[str] |
optional |
Notice Of Admission Flag: Item #448 | Table HL70136 |
|
|
IN1.24 |
Optional[str] |
optional |
Notice Of Admission Date: Item #449 |
|
|
IN1.25 |
Optional[str] |
optional |
Report Of Eligibility Flag: Item #450 | Table HL70136 |
|
|
IN1.26 |
Optional[str] |
optional |
Report Of Eligibility Date: Item #451 |
|
|
IN1.27 |
Optional[CWE] |
optional |
Release Information Code: Item #452 | Table HL70093 |
|
|
IN1.28 |
Optional[str] |
optional |
Pre-Admit Cert (PAC): Item #453 |
|
|
IN1.29 |
Optional[str] |
optional |
Verification Date/Time: Item #454 |
|
|
IN1.30 |
Optional[List[XCN]] |
optional |
Verification By: Item #455 |
|
|
IN1.31 |
Optional[CWE] |
optional |
Type Of Agreement Code: Item #456 | Table HL70098 |
|
|
IN1.32 |
Optional[CWE] |
optional |
Billing Status: Item #457 | Table HL70022 |
|
|
IN1.33 |
Optional[str] |
optional |
Lifetime Reserve Days: Item #458 |
|
|
IN1.34 |
Optional[str] |
optional |
Delay Before L.R. Day: Item #459 |
|
|
IN1.35 |
Optional[CWE] |
optional |
Company Plan Code: Item #460 | Table HL70042 |
|
|
IN1.36 |
Optional[str] |
optional |
Policy Number: Item #461 |
|
|
IN1.37 |
Optional[CP] |
optional |
Policy Deductible: Item #462 |
|
|
IN1.39 |
Optional[str] |
optional |
Policy Limit - Days: Item #464 |
|
|
IN1.42 |
Optional[CWE] |
optional |
Insured’s Employment Status: Item #467 | Table HL70066 |
|
|
IN1.43 |
Optional[CWE] |
optional |
Insured’s Administrative Sex: Item #468 | Table HL70001 |
|
|
IN1.44 |
Optional[List[XAD]] |
optional |
Insured’s Employer’s Address: Item #469 |
|
|
IN1.45 |
Optional[str] |
optional |
Verification Status: Item #470 |
|
|
IN1.46 |
Optional[CWE] |
optional |
Prior Insurance Plan ID: Item #471 | Table HL70072 |
|
|
IN1.47 |
Optional[CWE] |
optional |
Coverage Type: Item #1227 | Table HL70309 |
|
|
IN1.48 |
Optional[CWE] |
optional |
Handicap: Item #753 | Table HL70295 |
|
|
IN1.49 |
Optional[List[CX]] |
optional |
Insured’s ID Number: Item #1230 |
|
|
IN1.50 |
Optional[CWE] |
optional |
Signature Code: Item #1854 | Table HL70535 |
|
|
IN1.51 |
Optional[str] |
optional |
Signature Code Date: Item #1855 |
|
|
IN1.52 |
Optional[str] |
optional |
Insured’s Birth Place: Item #1899 |
|
|
IN1.53 |
Optional[CWE] |
optional |
VIP Indicator: Item #1852 | Table HL70099 |
|
|
IN1.54 |
Optional[List[CX]] |
optional |
External Health Plan Identifiers: Item #3292 |
|
|
IN1.55 |
Optional[str] |
optional |
Insurance Action Code: Item #3335 | Table HL70206 |
- class hl7types.hl7.v2_8_2.segments.IN2.IN2
HL7 v2 IN2 segment.
IN2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN2.1 |
Optional[List[CX]] |
optional |
Insured’s Employee ID: Item #472 |
|
|
IN2.2 |
Optional[str] |
optional |
Insured’s Social Security Number: Item #473 |
|
|
IN2.3 |
Optional[List[XCN]] |
optional |
Insured’s Employer’s Name and ID: Item #474 |
|
|
IN2.4 |
Optional[CWE] |
optional |
Employer Information Data: Item #475 | Table HL70139 |
|
|
IN2.5 |
Optional[List[CWE]] |
optional |
Mail Claim Party: Item #476 | Table HL70137 |
|
|
IN2.6 |
Optional[str] |
optional |
Medicare Health Ins Card Number: Item #477 |
|
|
IN2.7 |
Optional[List[XPN]] |
optional |
Medicaid Case Name: Item #478 |
|
|
IN2.8 |
Optional[str] |
optional |
Medicaid Case Number: Item #479 |
|
|
IN2.9 |
Optional[List[XPN]] |
optional |
Military Sponsor Name: Item #480 |
|
|
IN2.10 |
Optional[str] |
optional |
Military ID Number: Item #481 |
|
|
IN2.11 |
Optional[CWE] |
optional |
Dependent Of Military Recipient: Item #482 | Table HL70342 |
|
|
IN2.12 |
Optional[str] |
optional |
Military Organization: Item #483 |
|
|
IN2.13 |
Optional[str] |
optional |
Military Station: Item #484 |
|
|
IN2.14 |
Optional[CWE] |
optional |
Military Service: Item #485 | Table HL70140 |
|
|
IN2.15 |
Optional[CWE] |
optional |
Military Rank/Grade: Item #486 | Table HL70141 |
|
|
IN2.16 |
Optional[CWE] |
optional |
Military Status: Item #487 | Table HL70142 |
|
|
IN2.17 |
Optional[str] |
optional |
Military Retire Date: Item #488 |
|
|
IN2.18 |
Optional[str] |
optional |
Military Non-Avail Cert On File: Item #489 | Table HL70136 |
|
|
IN2.19 |
Optional[str] |
optional |
Baby Coverage: Item #490 | Table HL70136 |
|
|
IN2.20 |
Optional[str] |
optional |
Combine Baby Bill: Item #491 | Table HL70136 |
|
|
IN2.21 |
Optional[str] |
optional |
Blood Deductible: Item #492 |
|
|
IN2.22 |
Optional[List[XPN]] |
optional |
Special Coverage Approval Name: Item #493 |
|
|
IN2.23 |
Optional[str] |
optional |
Special Coverage Approval Title: Item #494 |
|
|
IN2.24 |
Optional[List[CWE]] |
optional |
Non-Covered Insurance Code: Item #495 | Table HL70143 |
|
|
IN2.25 |
Optional[List[CX]] |
optional |
Payor ID: Item #496 |
|
|
IN2.26 |
Optional[List[CX]] |
optional |
Payor Subscriber ID: Item #497 |
|
|
IN2.27 |
Optional[CWE] |
optional |
Eligibility Source: Item #498 | Table HL70144 |
|
|
IN2.28 |
Optional[List[RMC]] |
optional |
Room Coverage Type/Amount: Item #499 |
|
|
IN2.29 |
Optional[List[PTA]] |
optional |
Policy Type/Amount: Item #500 |
|
|
IN2.30 |
Optional[DDI] |
optional |
Daily Deductible: Item #501 |
|
|
IN2.31 |
Optional[CWE] |
optional |
Living Dependency: Item #755 | Table HL70223 |
|
|
IN2.32 |
Optional[List[CWE]] |
optional |
Ambulatory Status: Item #145 | Table HL70009 |
|
|
IN2.33 |
Optional[List[CWE]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
IN2.34 |
Optional[CWE] |
optional |
Primary Language: Item #118 | Table HL70296 |
|
|
IN2.35 |
Optional[CWE] |
optional |
Living Arrangement: Item #742 | Table HL70220 |
|
|
IN2.36 |
Optional[CWE] |
optional |
Publicity Code: Item #743 | Table HL70215 |
|
|
IN2.37 |
Optional[str] |
optional |
Protection Indicator: Item #744 | Table HL70136 |
|
|
IN2.38 |
Optional[CWE] |
optional |
Student Indicator: Item #745 | Table HL70231 |
|
|
IN2.39 |
Optional[CWE] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
IN2.40 |
Optional[List[XPN]] |
optional |
Mother’s Maiden Name: Item #109 |
|
|
IN2.41 |
Optional[CWE] |
optional |
Nationality: Item #739 | Table HL70212 |
|
|
IN2.42 |
Optional[List[CWE]] |
optional |
Ethnic Group: Item #125 | Table HL70189 |
|
|
IN2.43 |
Optional[List[CWE]] |
optional |
Marital Status: Item #119 | Table HL70002 |
|
|
IN2.44 |
Optional[str] |
optional |
Insured’s Employment Start Date: Item #787 |
|
|
IN2.45 |
Optional[str] |
optional |
Employment Stop Date: Item #783 |
|
|
IN2.46 |
Optional[str] |
optional |
Job Title: Item #785 |
|
|
IN2.47 |
Optional[JCC] |
optional |
Job Code/Class: Item #786 |
|
|
IN2.48 |
Optional[CWE] |
optional |
Job Status: Item #752 | Table HL70311 |
|
|
IN2.49 |
Optional[List[XPN]] |
optional |
Employer Contact Person Name: Item #789 |
|
|
IN2.50 |
Optional[List[XTN]] |
optional |
Employer Contact Person Phone Number: Item #790 |
|
|
IN2.51 |
Optional[CWE] |
optional |
Employer Contact Reason: Item #791 | Table HL70222 |
|
|
IN2.52 |
Optional[List[XPN]] |
optional |
Insured’s Contact Person’s Name: Item #792 |
|
|
IN2.53 |
Optional[List[XTN]] |
optional |
Insured’s Contact Person Phone Number: Item #793 |
|
|
IN2.54 |
Optional[List[CWE]] |
optional |
Insured’s Contact Person Reason: Item #794 | Table HL70222 |
|
|
IN2.55 |
Optional[str] |
optional |
Relationship to the Patient Start Date: Item #795 |
|
|
IN2.56 |
Optional[List[str]] |
optional |
Relationship to the Patient Stop Date: Item #796 |
|
|
IN2.57 |
Optional[CWE] |
optional |
Insurance Co Contact Reason: Item #797 | Table HL70232 |
|
|
IN2.58 |
Optional[List[XTN]] |
optional |
Insurance Co Contact Phone Number: Item #798 |
|
|
IN2.59 |
Optional[CWE] |
optional |
Policy Scope: Item #799 | Table HL70312 |
|
|
IN2.60 |
Optional[CWE] |
optional |
Policy Source: Item #800 | Table HL70313 |
|
|
IN2.61 |
Optional[CX] |
optional |
Patient Member Number: Item #801 |
|
|
IN2.62 |
Optional[CWE] |
optional |
Guarantor’s Relationship to Insured: Item #802 | Table HL70063 |
|
|
IN2.63 |
Optional[List[XTN]] |
optional |
Insured’s Phone Number - Home: Item #803 |
|
|
IN2.64 |
Optional[List[XTN]] |
optional |
Insured’s Employer Phone Number: Item #804 |
|
|
IN2.65 |
Optional[CWE] |
optional |
Military Handicapped Program: Item #805 | Table HL70343 |
|
|
IN2.66 |
Optional[str] |
optional |
Suspend Flag: Item #806 | Table HL70136 |
|
|
IN2.67 |
Optional[str] |
optional |
Copay Limit Flag: Item #807 | Table HL70136 |
|
|
IN2.68 |
Optional[str] |
optional |
Stoploss Limit Flag: Item #808 | Table HL70136 |
|
|
IN2.69 |
Optional[List[XON]] |
optional |
Insured Organization Name and ID: Item #809 |
|
|
IN2.70 |
Optional[List[XON]] |
optional |
Insured Employer Organization Name and ID: Item #810 |
|
|
IN2.71 |
Optional[List[CWE]] |
optional |
Race: Item #113 | Table HL70005 |
|
|
IN2.72 |
Optional[CWE] |
optional |
Patient’s Relationship to Insured: Item #811 | Table HL70344 |
- class hl7types.hl7.v2_8_2.segments.IN3.IN3
HL7 v2 IN3 segment.
IN3¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN3.1 |
str |
required |
Set ID - IN3: Item #502 |
|
|
IN3.2 |
Optional[CX] |
optional |
Certification Number: Item #503 |
|
|
IN3.3 |
Optional[List[XCN]] |
optional |
Certified By: Item #504 |
|
|
IN3.4 |
Optional[str] |
optional |
Certification Required: Item #505 | Table HL70136 |
|
|
IN3.5 |
Optional[MOP] |
optional |
Penalty: Item #506 |
|
|
IN3.6 |
Optional[str] |
optional |
Certification Date/Time: Item #507 |
|
|
IN3.7 |
Optional[str] |
optional |
Certification Modify Date/Time: Item #508 |
|
|
IN3.8 |
Optional[List[XCN]] |
optional |
Operator: Item #509 |
|
|
IN3.9 |
Optional[str] |
optional |
Certification Begin Date: Item #510 |
|
|
IN3.10 |
Optional[str] |
optional |
Certification End Date: Item #511 |
|
|
IN3.11 |
Optional[DTN] |
optional |
Days: Item #512 |
|
|
IN3.12 |
Optional[CWE] |
optional |
Non-Concur Code/Description: Item #513 | Table HL70233 |
|
|
IN3.13 |
Optional[str] |
optional |
Non-Concur Effective Date/Time: Item #514 |
|
|
IN3.14 |
Optional[List[XCN]] |
optional |
Physician Reviewer: Item #515 | Table HL70010 |
|
|
IN3.15 |
Optional[str] |
optional |
Certification Contact: Item #516 |
|
|
IN3.16 |
Optional[List[XTN]] |
optional |
Certification Contact Phone Number: Item #517 |
|
|
IN3.17 |
Optional[CWE] |
optional |
Appeal Reason: Item #518 | Table HL70345 |
|
|
IN3.18 |
Optional[CWE] |
optional |
Certification Agency: Item #519 | Table HL70346 |
|
|
IN3.19 |
Optional[List[XTN]] |
optional |
Certification Agency Phone Number: Item #520 |
|
|
IN3.20 |
Optional[List[ICD]] |
optional |
Pre-Certification Requirement: Item #521 | Table HL70136 |
|
|
IN3.21 |
Optional[str] |
optional |
Case Manager: Item #522 |
|
|
IN3.22 |
Optional[str] |
optional |
Second Opinion Date: Item #523 |
|
|
IN3.23 |
Optional[CWE] |
optional |
Second Opinion Status: Item #524 | Table HL70151 |
|
|
IN3.24 |
Optional[List[CWE]] |
optional |
Second Opinion Documentation Received: Item #525 | Table HL70152 |
|
|
IN3.25 |
Optional[List[XCN]] |
optional |
Second Opinion Physician: Item #526 | Table HL70010 |
|
|
IN3.26 |
Optional[CWE] |
optional |
Certification Type: Item #3336 | Table HL70921 |
|
|
IN3.27 |
Optional[CWE] |
optional |
Certification Category: Item #3337 | Table HL70922 |
- class hl7types.hl7.v2_8_2.segments.INV.INV
HL7 v2 INV segment.
INV¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
INV.1 |
required |
Substance Identifier: Item #1372 | Table HL70451 |
||
|
INV.2 |
Optional[List[CWE]] |
optional |
Substance Status: Item #1373 | Table HL70383 |
|
|
INV.3 |
Optional[CWE] |
optional |
Substance Type: Item #1374 | Table HL70384 |
|
|
INV.4 |
Optional[CWE] |
optional |
Inventory Container Identifier: Item #1532 | Table HL79999 |
|
|
INV.5 |
Optional[CWE] |
optional |
Container Carrier Identifier: Item #1376 | Table HL79999 |
|
|
INV.6 |
Optional[CWE] |
optional |
Position on Carrier: Item #1377 | Table HL79999 |
|
|
INV.7 |
Optional[str] |
optional |
Initial Quantity: Item #1378 |
|
|
INV.8 |
Optional[str] |
optional |
Current Quantity: Item #1379 |
|
|
INV.9 |
Optional[str] |
optional |
Available Quantity: Item #1380 |
|
|
INV.10 |
Optional[str] |
optional |
Consumption Quantity: Item #1381 |
|
|
INV.11 |
Optional[CWE] |
optional |
Quantity Units: Item #1382 | Table HL79999 |
|
|
INV.12 |
Optional[str] |
optional |
Expiration Date/Time: Item #1383 |
|
|
INV.13 |
Optional[str] |
optional |
First Used Date/Time: Item #1384 |
|
|
INV.15 |
Optional[List[CWE]] |
optional |
Test/Fluid Identifier(s): Item #1386 | Table HL79999 |
|
|
INV.16 |
Optional[str] |
optional |
Manufacturer Lot Number: Item #1387 |
|
|
INV.17 |
Optional[CWE] |
optional |
Manufacturer Identifier: Item #286 | Table HL70385 |
|
|
INV.18 |
Optional[CWE] |
optional |
Supplier Identifier: Item #1389 | Table HL70386 |
|
|
INV.19 |
Optional[CQ] |
optional |
On Board Stability Time: Item #1626 |
|
|
INV.20 |
Optional[CQ] |
optional |
Target Value: Item #1896 |
- class hl7types.hl7.v2_8_2.segments.IPC.IPC
HL7 v2 IPC segment.
IPC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IPC.1 |
required |
Accession Identifier: Item #1330 |
||
|
IPC.2 |
required |
Requested Procedure ID: Item #1658 |
||
|
IPC.3 |
required |
Study Instance UID: Item #1659 |
||
|
IPC.4 |
required |
Scheduled Procedure Step ID: Item #1660 |
||
|
IPC.5 |
Optional[CWE] |
optional |
Modality: Item #1661 | Table HL79999 |
|
|
IPC.6 |
Optional[List[CWE]] |
optional |
Protocol Code: Item #1662 | Table HL79999 |
|
|
IPC.7 |
Optional[EI] |
optional |
Scheduled Station Name: Item #1663 |
|
|
IPC.8 |
Optional[List[CWE]] |
optional |
Scheduled Procedure Step Location: Item #1664 | Table HL79999 |
|
|
IPC.9 |
Optional[str] |
optional |
Scheduled Station AE Title: Item #1665 |
- class hl7types.hl7.v2_8_2.segments.IPR.IPR
HL7 v2 IPR segment.
IPR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IPR.1 |
required |
IPR Identifier: Item #2030 |
||
|
IPR.2 |
required |
Provider Cross Reference Identifier: Item #2031 |
||
|
IPR.3 |
required |
Payer Cross Reference Identifier: Item #2032 |
||
|
IPR.4 |
required |
IPR Status: Item #2033 | Table HL70571 |
||
|
IPR.5 |
str |
required |
IPR Date/Time: Item #2034 |
|
|
IPR.6 |
Optional[CP] |
optional |
Adjudicated/Paid Amount: Item #2035 |
|
|
IPR.7 |
Optional[str] |
optional |
Expected Payment Date/Time: Item #2036 |
|
|
IPR.8 |
str |
required |
IPR Checksum: Item #2037 |
- class hl7types.hl7.v2_8_2.segments.ISD.ISD
HL7 v2 ISD segment.
ISD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ISD.1 |
str |
required |
Reference Interaction Number: Item #1326 |
|
|
ISD.2 |
Optional[CWE] |
optional |
Interaction Type Identifier: Item #1327 | Table HL70368 |
|
|
ISD.3 |
required |
Interaction Active State: Item #1328 | Table HL70387 |
- class hl7types.hl7.v2_8_2.segments.ITM.ITM
HL7 v2 ITM segment.
ITM¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ITM.1 |
required |
Item Identifier: Item #2186 |
||
|
ITM.2 |
Optional[str] |
optional |
Item Description: Item #2274 |
|
|
ITM.3 |
Optional[CWE] |
optional |
Item Status: Item #2187 | Table HL70776 |
|
|
ITM.4 |
Optional[CWE] |
optional |
Item Type: Item #2188 | Table HL70778 |
|
|
ITM.5 |
Optional[CWE] |
optional |
Item Category: Item #2189 |
|
|
ITM.6 |
Optional[CNE] |
optional |
Subject to Expiration Indicator: Item #2190 | Table HL70532 |
|
|
ITM.7 |
Optional[EI] |
optional |
Manufacturer Identifier: Item #2191 |
|
|
ITM.8 |
Optional[str] |
optional |
Manufacturer Name: Item #2275 |
|
|
ITM.9 |
Optional[str] |
optional |
Manufacturer Catalog Number: Item #2192 |
|
|
ITM.10 |
Optional[CWE] |
optional |
Manufacturer Labeler Identification Code: Item #2193 |
|
|
ITM.11 |
Optional[CNE] |
optional |
Patient Chargeable Indicator: Item #2070 | Table HL70532 |
|
|
ITM.12 |
Optional[CWE] |
optional |
Transaction Code: Item #361 | Table HL70132 |
|
|
ITM.13 |
Optional[CP] |
optional |
Transaction amount - unit: Item #366 |
|
|
ITM.14 |
Optional[CNE] |
optional |
Stocked Item Indicator: Item #2197 | Table HL70532 |
|
|
ITM.15 |
Optional[CWE] |
optional |
Supply Risk Codes: Item #2266 | Table HL70871 |
|
|
ITM.16 |
Optional[List[XON]] |
optional |
Approving Regulatory Agency: Item #2199 | Table HL70790 |
|
|
ITM.17 |
Optional[CNE] |
optional |
Latex Indicator: Item #2200 | Table HL70532 |
|
|
ITM.18 |
Optional[List[CWE]] |
optional |
Ruling Act: Item #2201 | Table HL70793 |
|
|
ITM.19 |
Optional[CWE] |
optional |
Item Natural Account Code: Item #282 | Table HL70320 |
|
|
ITM.20 |
Optional[str] |
optional |
Approved To Buy Quantity: Item #2203 |
|
|
ITM.21 |
Optional[MO] |
optional |
Approved To Buy Price: Item #2204 |
|
|
ITM.22 |
Optional[CNE] |
optional |
Taxable Item Indicator: Item #2205 | Table HL70532 |
|
|
ITM.23 |
Optional[CNE] |
optional |
Freight Charge Indicator: Item #2206 | Table HL70532 |
|
|
ITM.24 |
Optional[CNE] |
optional |
Item Set Indicator: Item #2207 | Table HL70532 |
|
|
ITM.25 |
Optional[EI] |
optional |
Item Set Identifier: Item #2208 |
|
|
ITM.26 |
Optional[CNE] |
optional |
Track Department Usage Indicator: Item #2209 | Table HL70532 |
|
|
ITM.27 |
Optional[CNE] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
ITM.28 |
Optional[List[CNE]] |
optional |
Procedure Code Modifier: Item #1316 | Table HL70340 |
|
|
ITM.29 |
Optional[CWE] |
optional |
Special Handling Code: Item #1370 | Table HL70376 |
|
|
ITM.30 |
Optional[CNE] |
optional |
Hazardous Indicator: Item #3388 | Table HL70532 |
|
|
ITM.31 |
Optional[CNE] |
optional |
Sterile Indicator: Item #3304 | Table HL70532 |
|
|
ITM.32 |
Optional[EI] |
optional |
Material Data Safety Sheet Number: Item #3305 |
|
|
ITM.33 |
Optional[CWE] |
optional |
United Nations Standard Products and Services Code (UNSPSC): Item #3306 | Table HL70396 |
- class hl7types.hl7.v2_8_2.segments.IVC.IVC
HL7 v2 IVC segment.
IVC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IVC.1 |
required |
Provider Invoice Number: Item #1914 |
||
|
IVC.2 |
Optional[EI] |
optional |
Payer Invoice Number: Item #1915 |
|
|
IVC.3 |
Optional[EI] |
optional |
Contract/Agreement Number: Item #1916 |
|
|
IVC.4 |
required |
Invoice Control: Item #1917 | Table HL70553 |
||
|
IVC.5 |
required |
Invoice Reason: Item #1918 | Table HL70554 |
||
|
IVC.6 |
required |
Invoice Type: Item #1919 | Table HL70555 |
||
|
IVC.7 |
str |
required |
Invoice Date/Time: Item #1920 |
|
|
IVC.8 |
required |
Invoice Amount: Item #1921 |
||
|
IVC.9 |
Optional[str] |
optional |
Payment Terms: Item #1922 |
|
|
IVC.10 |
required |
Provider Organization: Item #1923 |
||
|
IVC.11 |
required |
Payer Organization: Item #1924 |
||
|
IVC.12 |
Optional[XCN] |
optional |
Attention: Item #1925 |
|
|
IVC.13 |
Optional[str] |
optional |
Last Invoice Indicator: Item #1926 | Table HL70136 |
|
|
IVC.14 |
Optional[str] |
optional |
Invoice Booking Period: Item #1927 |
|
|
IVC.15 |
Optional[str] |
optional |
Origin: Item #1928 |
|
|
IVC.16 |
Optional[CP] |
optional |
Invoice Fixed Amount: Item #1929 |
|
|
IVC.17 |
Optional[CP] |
optional |
Special Costs: Item #1930 |
|
|
IVC.18 |
Optional[CP] |
optional |
Amount for Doctors Treatment: Item #1931 |
|
|
IVC.19 |
Optional[XCN] |
optional |
Responsible Physician: Item #1932 |
|
|
IVC.20 |
Optional[CX] |
optional |
Cost Center: Item #1933 |
|
|
IVC.21 |
Optional[CP] |
optional |
Invoice Prepaid Amount: Item #1934 |
|
|
IVC.22 |
Optional[CP] |
optional |
Total Invoice Amount without Prepaid Amount: Item #1935 |
|
|
IVC.23 |
Optional[CP] |
optional |
Total-Amount of VAT: Item #1936 |
|
|
IVC.24 |
Optional[List[str]] |
optional |
VAT-Rates applied: Item #1937 |
|
|
IVC.25 |
required |
Benefit Group: Item #1938 | Table HL70556 |
||
|
IVC.26 |
Optional[str] |
optional |
Provider Tax ID: Item #2038 |
|
|
IVC.27 |
Optional[str] |
optional |
Payer Tax ID: Item #2039 |
|
|
IVC.28 |
Optional[CWE] |
optional |
Provider Tax Status: Item #2040 | Table HL70572 |
|
|
IVC.29 |
Optional[CWE] |
optional |
Payer Tax Status: Item #2041 | Table HL70572 |
|
|
IVC.30 |
Optional[str] |
optional |
Sales Tax ID: Item #2042 |
- class hl7types.hl7.v2_8_2.segments.IVT.IVT
HL7 v2 IVT segment.
IVT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IVT.1 |
str |
required |
Set Id - IVT: Item #2062 |
|
|
IVT.2 |
required |
Inventory Location Identifier: Item #2063 |
||
|
IVT.3 |
Optional[str] |
optional |
Inventory Location Name: Item #2277 |
|
|
IVT.4 |
Optional[EI] |
optional |
Source Location Identifier: Item #2064 |
|
|
IVT.5 |
Optional[str] |
optional |
Source Location Name: Item #2278 |
|
|
IVT.6 |
Optional[CWE] |
optional |
Item Status: Item #2065 | Table HL70625 |
|
|
IVT.7 |
Optional[List[EI]] |
optional |
Bin Location Identifier: Item #2066 |
|
|
IVT.8 |
Optional[CWE] |
optional |
Order Packaging: Item #2067 | Table HL70818 |
|
|
IVT.9 |
Optional[CWE] |
optional |
Issue Packaging: Item #2068 |
|
|
IVT.10 |
Optional[EI] |
optional |
Default Inventory Asset Account: Item #2069 |
|
|
IVT.11 |
Optional[CNE] |
optional |
Patient Chargeable Indicator: Item #2070 | Table HL70532 |
|
|
IVT.12 |
Optional[CWE] |
optional |
Transaction Code: Item #361 | Table HL70132 |
|
|
IVT.13 |
Optional[CP] |
optional |
Transaction amount - unit: Item #366 |
|
|
IVT.14 |
Optional[CWE] |
optional |
Item Importance Code: Item #2073 | Table HL70634 |
|
|
IVT.15 |
Optional[CNE] |
optional |
Stocked Item Indicator: Item #2074 | Table HL70532 |
|
|
IVT.16 |
Optional[CNE] |
optional |
Consignment Item Indicator: Item #2075 | Table HL70532 |
|
|
IVT.17 |
Optional[CNE] |
optional |
Reusable Item Indicator: Item #2076 | Table HL70532 |
|
|
IVT.18 |
Optional[CP] |
optional |
Reusable Cost: Item #2077 |
|
|
IVT.19 |
Optional[List[EI]] |
optional |
Substitute Item Identifier: Item #2078 |
|
|
IVT.20 |
Optional[EI] |
optional |
Latex-Free Substitute Item Identifier: Item #2079 |
|
|
IVT.21 |
Optional[CWE] |
optional |
Recommended Reorder Theory: Item #2080 | Table HL70642 |
|
|
IVT.22 |
Optional[str] |
optional |
Recommended Safety Stock Days: Item #2081 |
|
|
IVT.23 |
Optional[str] |
optional |
Recommended Maximum Days Inventory: Item #2082 |
|
|
IVT.24 |
Optional[str] |
optional |
Recommended Order Point: Item #2083 |
|
|
IVT.25 |
Optional[str] |
optional |
Recommended Order Amount: Item #2084 |
|
|
IVT.26 |
Optional[CNE] |
optional |
Operating Room Par Level Indicator: Item #2085 | Table HL70532 |
- class hl7types.hl7.v2_8_2.segments.LAN.LAN
HL7 v2 LAN segment.
LAN¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LAN.1 |
str |
required |
Set ID - LAN: Item #1455 |
|
|
LAN.2 |
required |
Language Code: Item #1456 | Table HL70296 |
||
|
LAN.3 |
Optional[List[CWE]] |
optional |
Language Ability Code: Item #1457 | Table HL70403 |
|
|
LAN.4 |
Optional[CWE] |
optional |
Language Proficiency Code: Item #1458 | Table HL70404 |
- class hl7types.hl7.v2_8_2.segments.LCC.LCC
HL7 v2 LCC segment.
LCC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LCC.1 |
required |
Primary Key Value - LCC: Item #979 |
||
|
LCC.2 |
required |
Location Department: Item #964 | Table HL70264 |
||
|
LCC.3 |
Optional[List[CWE]] |
optional |
Accommodation Type: Item #980 | Table HL70129 |
|
|
LCC.4 |
Optional[List[CWE]] |
optional |
Charge Code: Item #981 | Table HL70132 |
- class hl7types.hl7.v2_8_2.segments.LCH.LCH
HL7 v2 LCH segment.
LCH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LCH.1 |
required |
Primary Key Value - LCH: Item #1305 |
||
|
LCH.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
LCH.3 |
Optional[EI] |
optional |
Segment Unique Key: Item #764 |
|
|
LCH.4 |
required |
Location Characteristic ID: Item #1295 | Table HL70324 |
||
|
LCH.5 |
required |
Location Characteristic Value - LCH: Item #1294 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.LDP.LDP
HL7 v2 LDP segment.
LDP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LDP.1 |
required |
Primary Key Value - LDP: Item #963 |
||
|
LDP.2 |
required |
Location Department: Item #964 | Table HL70264 |
||
|
LDP.3 |
Optional[List[CWE]] |
optional |
Location Service: Item #965 | Table HL70069 |
|
|
LDP.4 |
Optional[List[CWE]] |
optional |
Specialty Type: Item #966 | Table HL70265 |
|
|
LDP.5 |
Optional[List[CWE]] |
optional |
Valid Patient Classes: Item #967 | Table HL70004 |
|
|
LDP.6 |
Optional[str] |
optional |
Active/Inactive Flag: Item #675 | Table HL70183 |
|
|
LDP.7 |
Optional[str] |
optional |
Activation Date - LDP: Item #969 |
|
|
LDP.8 |
Optional[str] |
optional |
Inactivation Date - LDP: Item #970 |
|
|
LDP.9 |
Optional[str] |
optional |
Inactivated Reason: Item #971 |
|
|
LDP.10 |
Optional[List[VH]] |
optional |
Visiting Hours: Item #976 | Table HL70267 |
|
|
LDP.11 |
Optional[XTN] |
optional |
Contact Phone: Item #978 |
|
|
LDP.12 |
Optional[CWE] |
optional |
Location Cost Center: Item #1584 | Table HL70462 |
- class hl7types.hl7.v2_8_2.segments.LOC.LOC
HL7 v2 LOC segment.
LOC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LOC.1 |
required |
Primary Key Value - LOC: Item #1307 |
||
|
LOC.2 |
Optional[str] |
optional |
Location Description: Item #944 |
|
|
LOC.3 |
Optional[List[CWE]] |
optional |
Location Type - LOC: Item #945 | Table HL70260 |
|
|
LOC.4 |
Optional[List[XON]] |
optional |
Organization Name - LOC: Item #947 |
|
|
LOC.5 |
Optional[List[XAD]] |
optional |
Location Address: Item #948 |
|
|
LOC.6 |
Optional[List[XTN]] |
optional |
Location Phone: Item #949 |
|
|
LOC.7 |
Optional[List[CWE]] |
optional |
License Number: Item #951 | Table HL70461 |
|
|
LOC.8 |
Optional[List[CWE]] |
optional |
Location Equipment: Item #953 | Table HL70261 |
|
|
LOC.9 |
Optional[CWE] |
optional |
Location Service Code: Item #1583 | Table HL70442 |
- class hl7types.hl7.v2_8_2.segments.LRL.LRL
HL7 v2 LRL segment.
LRL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
LRL.1 |
required |
Primary Key Value - LRL: Item #943 |
||
|
LRL.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
LRL.3 |
Optional[EI] |
optional |
Segment Unique Key: Item #764 |
|
|
LRL.4 |
required |
Location Relationship ID: Item #1277 | Table HL70325 |
||
|
LRL.5 |
Optional[List[XON]] |
optional |
Organizational Location Relationship Value: Item #1301 |
|
|
LRL.6 |
Optional[PL] |
optional |
Patient Location Relationship Value: Item #1292 |
- class hl7types.hl7.v2_8_2.segments.MCP.MCP
HL7 v2 MCP segment.
MCP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MCP.1 |
str |
required |
Set ID - MCP: Item #3468 |
|
|
MCP.2 |
required |
Producer’s Service/Test/Observation ID: Item #587 |
||
|
MCP.3 |
Optional[MO] |
optional |
Universal Service Price Range - Low Value: Item #3469 |
|
|
MCP.4 |
Optional[MO] |
optional |
Universal Service Price Range - High Value: Item #3470 |
|
|
MCP.5 |
Optional[str] |
optional |
Reason for Universal Service Cost Range: Item #3471 |
- class hl7types.hl7.v2_8_2.segments.MFA.MFA
HL7 v2 MFA segment.
MFA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MFA.1 |
str |
required |
Record-Level Event Code: Item #664 | Table HL70180 |
|
|
MFA.2 |
Optional[str] |
optional |
MFN Control ID: Item #665 |
|
|
MFA.3 |
Optional[str] |
optional |
Event Completion Date/Time: Item #668 |
|
|
MFA.4 |
required |
MFN Record Level Error Return: Item #669 | Table HL70181 |
||
|
MFA.5 |
Optional[List[varies]] |
optional |
Primary Key Value - MFA: Item #1308 | Table HL79999 |
|
|
MFA.6 |
List[str] |
required |
Primary Key Value Type - MFA: Item #1320 | Table HL70355 |
- class hl7types.hl7.v2_8_2.segments.MFE.MFE
HL7 v2 MFE segment.
MFE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MFE.1 |
str |
required |
Record-Level Event Code: Item #664 | Table HL70180 |
|
|
MFE.2 |
Optional[str] |
optional |
MFN Control ID: Item #665 |
|
|
MFE.3 |
Optional[str] |
optional |
Effective Date/Time: Item #662 |
|
|
MFE.4 |
Optional[List[varies]] |
optional |
Primary Key Value - MFE: Item #667 | Table HL79999 |
|
|
MFE.5 |
List[str] |
required |
Primary Key Value Type: Item #1319 | Table HL70355 |
|
|
MFE.6 |
Optional[str] |
optional |
Entered Date/Time: Item #661 |
|
|
MFE.7 |
Optional[XCN] |
optional |
Entered By: Item #224 |
- class hl7types.hl7.v2_8_2.segments.MFI.MFI
HL7 v2 MFI segment.
MFI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MFI.1 |
required |
Master File Identifier: Item #658 | Table HL70175 |
||
|
MFI.2 |
Optional[List[HD]] |
optional |
Master File Application Identifier: Item #659 | Table HL70361 |
|
|
MFI.3 |
str |
required |
File-Level Event Code: Item #660 | Table HL70178 |
|
|
MFI.4 |
Optional[str] |
optional |
Entered Date/Time: Item #661 |
|
|
MFI.5 |
Optional[str] |
optional |
Effective Date/Time: Item #662 |
|
|
MFI.6 |
str |
required |
Response Level Code: Item #663 | Table HL70179 |
- class hl7types.hl7.v2_8_2.segments.MRG.MRG
HL7 v2 MRG segment.
MRG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MRG.1 |
List[CX] |
required |
Prior Patient Identifier List: Item #211 | Table HL70061 |
|
|
MRG.3 |
Optional[CX] |
optional |
Prior Patient Account Number: Item #213 | Table HL70061 |
|
|
MRG.5 |
Optional[CX] |
optional |
Prior Visit Number: Item #1279 | Table HL70061 |
|
|
MRG.6 |
Optional[List[CX]] |
optional |
Prior Alternate Visit ID: Item #1280 | Table HL70061 |
|
|
MRG.7 |
Optional[List[XPN]] |
optional |
Prior Patient Name: Item #1281 | Table HL70200 |
- class hl7types.hl7.v2_8_2.segments.MSA.MSA
HL7 v2 MSA segment.
MSA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MSA.1 |
str |
required |
Acknowledgment Code: Item #18 | Table HL70008 |
|
|
MSA.2 |
str |
required |
Message Control ID: Item #10 |
|
|
MSA.4 |
Optional[str] |
optional |
Expected Sequence Number: Item #21 |
|
|
MSA.7 |
Optional[str] |
optional |
Message Waiting Number: Item #1827 |
|
|
MSA.8 |
Optional[str] |
optional |
Message Waiting Priority: Item #1828 | Table HL70520 |
- class hl7types.hl7.v2_8_2.segments.MSH.MSH
HL7 v2 MSH segment.
MSH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MSH.1 |
str |
optional |
Field Separator: Item #1 |
|
|
MSH.2 |
str |
optional |
Encoding Characters: Item #2 |
|
|
MSH.3 |
Optional[HD] |
optional |
Sending Application: Item #3 | Table HL70361 |
|
|
MSH.4 |
Optional[HD] |
optional |
Sending Facility: Item #4 | Table HL70362 |
|
|
MSH.5 |
Optional[HD] |
optional |
Receiving Application: Item #5 | Table HL70361 |
|
|
MSH.6 |
Optional[HD] |
optional |
Receiving Facility: Item #6 | Table HL70362 |
|
|
MSH.7 |
str |
required |
Date/Time of Message: Item #7 |
|
|
MSH.8 |
Optional[str] |
optional |
Security: Item #8 |
|
|
MSH.9 |
required |
Message Type: Item #9 |
||
|
MSH.10 |
str |
required |
Message Control ID: Item #10 |
|
|
MSH.11 |
required |
Processing ID: Item #11 |
||
|
MSH.12 |
required |
Version ID: Item #12 |
||
|
MSH.13 |
Optional[str] |
optional |
Sequence Number: Item #13 |
|
|
MSH.14 |
Optional[str] |
optional |
Continuation Pointer: Item #14 |
|
|
MSH.15 |
Optional[str] |
optional |
Accept Acknowledgment Type: Item #15 | Table HL70155 |
|
|
MSH.16 |
Optional[str] |
optional |
Application Acknowledgment Type: Item #16 | Table HL70155 |
|
|
MSH.17 |
Optional[str] |
optional |
Country Code: Item #17 | Table HL70399 |
|
|
MSH.18 |
Optional[List[str]] |
optional |
Character Set: Item #692 | Table HL70211 |
|
|
MSH.19 |
Optional[CWE] |
optional |
Principal Language Of Message: Item #693 |
|
|
MSH.20 |
Optional[str] |
optional |
Alternate Character Set Handling Scheme: Item #1317 | Table HL70356 |
|
|
MSH.21 |
Optional[List[EI]] |
optional |
Message Profile Identifier: Item #1598 |
|
|
MSH.22 |
Optional[XON] |
optional |
Sending Responsible Organization: Item #1823 |
|
|
MSH.23 |
Optional[XON] |
optional |
Receiving Responsible Organization: Item #1824 |
|
|
MSH.24 |
Optional[HD] |
optional |
Sending Network Address: Item #1825 |
|
|
MSH.25 |
Optional[HD] |
optional |
Receiving Network Address: Item #1826 |
- class hl7types.hl7.v2_8_2.segments.NCK.NCK
HL7 v2 NCK segment.
NCK¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NCK.1 |
str |
required |
System Date/Time: Item #1172 |
- class hl7types.hl7.v2_8_2.segments.NDS.NDS
HL7 v2 NDS segment.
NDS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NDS.1 |
str |
required |
Notification Reference Number: Item #1398 |
|
|
NDS.2 |
str |
required |
Notification Date/Time: Item #1399 |
|
|
NDS.3 |
required |
Notification Alert Severity: Item #1400 | Table HL70367 |
||
|
NDS.4 |
required |
Notification Code: Item #1401 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.NK1.NK1
HL7 v2 NK1 segment.
NK1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NK1.1 |
str |
required |
Set ID - NK1: Item #190 |
|
|
NK1.2 |
Optional[List[XPN]] |
optional |
Name: Item #191 | Table HL70200 |
|
|
NK1.3 |
Optional[CWE] |
optional |
Relationship: Item #192 | Table HL70063 |
|
|
NK1.4 |
Optional[List[XAD]] |
optional |
Address: Item #193 |
|
|
NK1.5 |
Optional[List[XTN]] |
optional |
Phone Number: Item #194 |
|
|
NK1.6 |
Optional[List[XTN]] |
optional |
Business Phone Number: Item #195 |
|
|
NK1.7 |
Optional[CWE] |
optional |
Contact Role: Item #196 | Table HL70131 |
|
|
NK1.8 |
Optional[str] |
optional |
Start Date: Item #197 |
|
|
NK1.9 |
Optional[str] |
optional |
End Date: Item #198 |
|
|
NK1.10 |
Optional[str] |
optional |
Next of Kin / Associated Parties Job Title: Item #199 |
|
|
NK1.11 |
Optional[JCC] |
optional |
Next of Kin / Associated Parties Job Code/Class: Item #200 |
|
|
NK1.12 |
Optional[CX] |
optional |
Next of Kin / Associated Parties Employee Number: Item #201 |
|
|
NK1.13 |
Optional[List[XON]] |
optional |
Organization Name - NK1: Item #202 |
|
|
NK1.14 |
Optional[CWE] |
optional |
Marital Status: Item #119 | Table HL70002 |
|
|
NK1.15 |
Optional[CWE] |
optional |
Administrative Sex: Item #111 | Table HL70001 |
|
|
NK1.16 |
Optional[str] |
optional |
Date/Time of Birth: Item #110 |
|
|
NK1.17 |
Optional[List[CWE]] |
optional |
Living Dependency: Item #755 | Table HL70223 |
|
|
NK1.18 |
Optional[List[CWE]] |
optional |
Ambulatory Status: Item #145 | Table HL70009 |
|
|
NK1.19 |
Optional[List[CWE]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
NK1.20 |
Optional[CWE] |
optional |
Primary Language: Item #118 | Table HL70296 |
|
|
NK1.21 |
Optional[CWE] |
optional |
Living Arrangement: Item #742 | Table HL70220 |
|
|
NK1.22 |
Optional[CWE] |
optional |
Publicity Code: Item #743 | Table HL70215 |
|
|
NK1.23 |
Optional[str] |
optional |
Protection Indicator: Item #744 | Table HL70136 |
|
|
NK1.24 |
Optional[CWE] |
optional |
Student Indicator: Item #745 | Table HL70231 |
|
|
NK1.25 |
Optional[CWE] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
NK1.26 |
Optional[List[XPN]] |
optional |
Mother’s Maiden Name: Item #109 |
|
|
NK1.27 |
Optional[CWE] |
optional |
Nationality: Item #739 | Table HL70212 |
|
|
NK1.28 |
Optional[List[CWE]] |
optional |
Ethnic Group: Item #125 | Table HL70189 |
|
|
NK1.29 |
Optional[List[CWE]] |
optional |
Contact Reason: Item #747 | Table HL70222 |
|
|
NK1.30 |
Optional[List[XPN]] |
optional |
Contact Person’s Name: Item #748 |
|
|
NK1.31 |
Optional[List[XTN]] |
optional |
Contact Person’s Telephone Number: Item #749 |
|
|
NK1.32 |
Optional[List[XAD]] |
optional |
Contact Person’s Address: Item #750 |
|
|
NK1.33 |
Optional[List[CX]] |
optional |
Next of Kin/Associated Party’s Identifiers: Item #751 |
|
|
NK1.34 |
Optional[CWE] |
optional |
Job Status: Item #752 | Table HL70311 |
|
|
NK1.35 |
Optional[List[CWE]] |
optional |
Race: Item #113 | Table HL70005 |
|
|
NK1.36 |
Optional[CWE] |
optional |
Handicap: Item #753 | Table HL70295 |
|
|
NK1.37 |
Optional[str] |
optional |
Contact Person Social Security Number: Item #754 |
|
|
NK1.38 |
Optional[str] |
optional |
Next of Kin Birth Place: Item #1905 |
|
|
NK1.39 |
Optional[CWE] |
optional |
VIP Indicator: Item #146 | Table HL70099 |
|
|
NK1.40 |
Optional[XTN] |
optional |
Next of Kin Telecommunication Information: Item #2292 |
|
|
NK1.41 |
Optional[XTN] |
optional |
Contact Person’s Telecommunication Information: Item #2293 |
- class hl7types.hl7.v2_8_2.segments.NPU.NPU
HL7 v2 NPU segment.
NPU¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NPU.1 |
required |
Bed Location: Item #209 |
||
|
NPU.2 |
Optional[CWE] |
optional |
Bed Status: Item #170 | Table HL70116 |
- class hl7types.hl7.v2_8_2.segments.NSC.NSC
HL7 v2 NSC segment.
NSC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NSC.1 |
required |
Application Change Type: Item #1188 | Table HL70409 |
||
|
NSC.2 |
Optional[str] |
optional |
Current CPU: Item #1189 |
|
|
NSC.3 |
Optional[str] |
optional |
Current Fileserver: Item #1190 |
|
|
NSC.4 |
Optional[HD] |
optional |
Current Application: Item #1191 | Table HL70361 |
|
|
NSC.5 |
Optional[HD] |
optional |
Current Facility: Item #1192 | Table HL70362 |
|
|
NSC.6 |
Optional[str] |
optional |
New CPU: Item #1193 |
|
|
NSC.7 |
Optional[str] |
optional |
New Fileserver: Item #1194 |
|
|
NSC.8 |
Optional[HD] |
optional |
New Application: Item #1195 | Table HL70361 |
|
|
NSC.9 |
Optional[HD] |
optional |
New Facility: Item #1196 | Table HL70362 |
- class hl7types.hl7.v2_8_2.segments.NST.NST
HL7 v2 NST segment.
NST¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NST.1 |
str |
required |
Statistics Available: Item #1173 | Table HL70136 |
|
|
NST.2 |
Optional[str] |
optional |
Source Identifier: Item #1174 |
|
|
NST.3 |
Optional[str] |
optional |
Source Type: Item #1175 | Table HL70332 |
|
|
NST.4 |
Optional[str] |
optional |
Statistics Start: Item #1176 |
|
|
NST.5 |
Optional[str] |
optional |
Statistics End: Item #1177 |
|
|
NST.6 |
Optional[str] |
optional |
Receive Character Count: Item #1178 |
|
|
NST.7 |
Optional[str] |
optional |
Send Character Count: Item #1179 |
|
|
NST.8 |
Optional[str] |
optional |
Messages Received: Item #1180 |
|
|
NST.9 |
Optional[str] |
optional |
Messages Sent: Item #1181 |
|
|
NST.10 |
Optional[str] |
optional |
Checksum Errors Received: Item #1182 |
|
|
NST.11 |
Optional[str] |
optional |
Length Errors Received: Item #1183 |
|
|
NST.12 |
Optional[str] |
optional |
Other Errors Received: Item #1184 |
|
|
NST.13 |
Optional[str] |
optional |
Connect Timeouts: Item #1185 |
|
|
NST.14 |
Optional[str] |
optional |
Receive Timeouts: Item #1186 |
|
|
NST.15 |
Optional[str] |
optional |
Application control-level Errors: Item #1187 |
- class hl7types.hl7.v2_8_2.segments.NTE.NTE
HL7 v2 NTE segment.
NTE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NTE.1 |
Optional[str] |
optional |
Set ID - NTE: Item #96 |
|
|
NTE.2 |
Optional[str] |
optional |
Source of Comment: Item #97 | Table HL70105 |
|
|
NTE.3 |
Optional[List[FT]] |
optional |
Comment: Item #98 |
|
|
NTE.4 |
Optional[CWE] |
optional |
Comment Type: Item #1318 | Table HL70364 |
|
|
NTE.5 |
Optional[XCN] |
optional |
Entered By: Item #224 |
|
|
NTE.6 |
Optional[str] |
optional |
Entered Date/Time: Item #661 |
|
|
NTE.7 |
Optional[str] |
optional |
Effective Start Date: Item #1004 |
|
|
NTE.8 |
Optional[str] |
optional |
Expiration Date: Item #2185 |
- class hl7types.hl7.v2_8_2.segments.OBR.OBR
HL7 v2 OBR segment.
OBR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OBR.1 |
Optional[str] |
optional |
Set ID - OBR: Item #237 |
|
|
OBR.2 |
Optional[EI] |
optional |
Placer Order Number: Item #216 |
|
|
OBR.3 |
Optional[EI] |
optional |
Filler Order Number: Item #217 |
|
|
OBR.4 |
required |
Universal Service Identifier: Item #238 |
||
|
OBR.7 |
Optional[str] |
optional |
Observation Date/Time #: Item #241 |
|
|
OBR.8 |
Optional[str] |
optional |
Observation End Date/Time #: Item #242 |
|
|
OBR.9 |
Optional[CQ] |
optional |
Collection Volume *: Item #243 |
|
|
OBR.10 |
Optional[List[XCN]] |
optional |
Collector Identifier *: Item #244 |
|
|
OBR.11 |
Optional[str] |
optional |
Specimen Action Code *: Item #245 | Table HL70065 |
|
|
OBR.12 |
Optional[CWE] |
optional |
Danger Code: Item #246 | Table HL79999 |
|
|
OBR.13 |
Optional[List[CWE]] |
optional |
Relevant Clinical Information: Item #247 | Table HL70916 |
|
|
OBR.16 |
Optional[List[XCN]] |
optional |
Ordering Provider: Item #226 |
|
|
OBR.17 |
Optional[List[XTN]] |
optional |
Order Callback Phone Number: Item #250 |
|
|
OBR.18 |
Optional[str] |
optional |
Placer Field 1: Item #251 |
|
|
OBR.19 |
Optional[str] |
optional |
Placer Field 2: Item #252 |
|
|
OBR.20 |
Optional[str] |
optional |
Filler Field 1 +: Item #253 |
|
|
OBR.21 |
Optional[str] |
optional |
Filler Field 2 +: Item #254 |
|
|
OBR.22 |
Optional[str] |
optional |
Results Rpt/Status Chng - Date/Time +: Item #255 |
|
|
OBR.23 |
Optional[MOC] |
optional |
Charge to Practice +: Item #256 |
|
|
OBR.24 |
Optional[str] |
optional |
Diagnostic Serv Sect ID: Item #257 | Table HL70074 |
|
|
OBR.25 |
Optional[str] |
optional |
Result Status +: Item #258 | Table HL70123 |
|
|
OBR.26 |
Optional[PRL] |
optional |
Parent Result +: Item #259 |
|
|
OBR.28 |
Optional[List[XCN]] |
optional |
Result Copies To: Item #260 |
|
|
OBR.29 |
Optional[EIP] |
optional |
Parent Results Observation Identifier: Item #261 |
|
|
OBR.30 |
Optional[str] |
optional |
Transportation Mode: Item #262 | Table HL70124 |
|
|
OBR.31 |
Optional[List[CWE]] |
optional |
Reason for Study: Item #263 | Table HL79999 |
|
|
OBR.32 |
Optional[NDL] |
optional |
Principal Result Interpreter +: Item #264 |
|
|
OBR.33 |
Optional[List[NDL]] |
optional |
Assistant Result Interpreter +: Item #265 |
|
|
OBR.34 |
Optional[List[NDL]] |
optional |
Technician +: Item #266 |
|
|
OBR.35 |
Optional[List[NDL]] |
optional |
Transcriptionist +: Item #267 |
|
|
OBR.36 |
Optional[str] |
optional |
Scheduled Date/Time +: Item #268 |
|
|
OBR.37 |
Optional[str] |
optional |
Number of Sample Containers *: Item #1028 |
|
|
OBR.38 |
Optional[List[CWE]] |
optional |
Transport Logistics of Collected Sample *: Item #1029 | Table HL79999 |
|
|
OBR.39 |
Optional[List[CWE]] |
optional |
Collector’s Comment *: Item #1030 | Table HL79999 |
|
|
OBR.40 |
Optional[CWE] |
optional |
Transport Arrangement Responsibility: Item #1031 | Table HL79999 |
|
|
OBR.41 |
Optional[str] |
optional |
Transport Arranged: Item #1032 | Table HL70224 |
|
|
OBR.42 |
Optional[str] |
optional |
Escort Required: Item #1033 | Table HL70225 |
|
|
OBR.43 |
Optional[List[CWE]] |
optional |
Planned Patient Transport Comment: Item #1034 | Table HL79999 |
|
|
OBR.44 |
Optional[CNE] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
OBR.45 |
Optional[List[CNE]] |
optional |
Procedure Code Modifier: Item #1316 | Table HL70340 |
|
|
OBR.46 |
Optional[List[CWE]] |
optional |
Placer Supplemental Service Information: Item #1474 | Table HL70411 |
|
|
OBR.47 |
Optional[List[CWE]] |
optional |
Filler Supplemental Service Information: Item #1475 | Table HL70411 |
|
|
OBR.48 |
Optional[CWE] |
optional |
Medically Necessary Duplicate Procedure Reason: Item #1646 | Table HL70476 |
|
|
OBR.49 |
Optional[CWE] |
optional |
Result Handling: Item #1647 | Table HL70507 |
|
|
OBR.50 |
Optional[CWE] |
optional |
Parent Universal Service Identifier: Item #2286 |
|
|
OBR.51 |
Optional[EI] |
optional |
Observation Group ID: Item #2307 |
|
|
OBR.52 |
Optional[EI] |
optional |
Parent Observation Group ID: Item #2308 |
|
|
OBR.53 |
Optional[List[CX]] |
optional |
Alternate Placer Order Number: Item #3303 |
|
|
OBR.54 |
Optional[EIP] |
optional |
Parent Order: Item #222 |
- class hl7types.hl7.v2_8_2.segments.OBX.OBX
HL7 v2 OBX segment.
OBX¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OBX.1 |
Optional[str] |
optional |
Set ID - OBX: Item #569 |
|
|
OBX.2 |
Optional[str] |
optional |
Value Type: Item #570 | Table HL70125 |
|
|
OBX.3 |
required |
Observation Identifier: Item #571 | Table HL79999 |
||
|
OBX.4 |
Optional[OG] |
optional |
Observation Sub-ID: Item #572 |
|
|
OBX.5 |
Optional[List[varies]] |
optional |
Observation Value: Item #573 |
|
|
OBX.6 |
Optional[CWE] |
optional |
Units: Item #574 | Table HL79999 |
|
|
OBX.7 |
Optional[str] |
optional |
References Range: Item #575 |
|
|
OBX.8 |
Optional[List[CWE]] |
optional |
Interpretation Codes: Item #576 | Table HL70078 |
|
|
OBX.9 |
Optional[str] |
optional |
Probability: Item #577 |
|
|
OBX.10 |
Optional[List[str]] |
optional |
Nature of Abnormal Test: Item #578 | Table HL70080 |
|
|
OBX.11 |
str |
required |
Observation Result Status: Item #579 | Table HL70085 |
|
|
OBX.12 |
Optional[str] |
optional |
Effective Date of Reference Range: Item #580 |
|
|
OBX.13 |
Optional[str] |
optional |
User Defined Access Checks: Item #581 |
|
|
OBX.14 |
Optional[str] |
optional |
Date/Time of the Observation: Item #582 |
|
|
OBX.15 |
Optional[CWE] |
optional |
Producer’s ID: Item #583 | Table HL79999 |
|
|
OBX.16 |
Optional[List[XCN]] |
optional |
Responsible Observer: Item #584 |
|
|
OBX.17 |
Optional[List[CWE]] |
optional |
Observation Method: Item #936 | Table HL79999 |
|
|
OBX.18 |
Optional[List[EI]] |
optional |
Equipment Instance Identifier: Item #1479 |
|
|
OBX.19 |
Optional[str] |
optional |
Date/Time of the Analysis: Item #1480 |
|
|
OBX.20 |
Optional[List[CWE]] |
optional |
Observation Site: Item #2179 | Table HL70163 |
|
|
OBX.21 |
Optional[EI] |
optional |
Observation Instance Identifier: Item #2180 |
|
|
OBX.22 |
Optional[CNE] |
optional |
Mood Code: Item #2182 | Table HL70725 |
|
|
OBX.23 |
Optional[XON] |
optional |
Performing Organization Name: Item #2283 |
|
|
OBX.24 |
Optional[XAD] |
optional |
Performing Organization Address: Item #2284 |
|
|
OBX.25 |
Optional[XCN] |
optional |
Performing Organization Medical Director: Item #2285 |
|
|
OBX.26 |
Optional[str] |
optional |
Patient Results Release Category: Item #2313 | Table HL70909 |
|
|
OBX.27 |
Optional[CWE] |
optional |
Root Cause: Item #3308 | Table HL70914 |
|
|
OBX.28 |
Optional[List[CWE]] |
optional |
Local Process Control: Item #3309 | Table HL70915 |
|
|
OBX.29 |
Optional[str] |
optional |
Observation Type: Item #3432 | Table HL70936 |
|
|
OBX.30 |
Optional[str] |
optional |
Observation Sub-Type: Item #3475 | Table HL70937 |
- class hl7types.hl7.v2_8_2.segments.ODS.ODS
HL7 v2 ODS segment.
ODS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ODS.1 |
str |
required |
Type: Item #269 | Table HL70159 |
|
|
ODS.2 |
Optional[List[CWE]] |
optional |
Service Period: Item #270 | Table HL79999 |
|
|
ODS.3 |
Optional[List[CWE]] |
optional |
Diet, Supplement, or Preference Code: Item #271 | Table HL79999 |
|
|
ODS.4 |
Optional[List[str]] |
optional |
Text Instruction: Item #272 |
- class hl7types.hl7.v2_8_2.segments.ODT.ODT
HL7 v2 ODT segment.
ODT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ODT.1 |
required |
Tray Type: Item #273 | Table HL70160 |
||
|
ODT.2 |
Optional[List[CWE]] |
optional |
Service Period: Item #270 | Table HL79999 |
|
|
ODT.3 |
Optional[str] |
optional |
Text Instruction: Item #272 |
- class hl7types.hl7.v2_8_2.segments.OM1.OM1
HL7 v2 OM1 segment.
OM1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM1.1 |
str |
required |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM1.2 |
required |
Producer’s Service/Test/Observation ID: Item #587 |
||
|
OM1.3 |
Optional[List[str]] |
optional |
Permitted Data Types: Item #588 | Table HL70125 |
|
|
OM1.4 |
str |
required |
Specimen Required: Item #589 | Table HL70136 |
|
|
OM1.5 |
required |
Producer ID: Item #590 | Table HL79999 |
||
|
OM1.6 |
Optional[TX] |
optional |
Observation Description: Item #591 |
|
|
OM1.7 |
Optional[List[CWE]] |
optional |
Other Service/Test/Observation IDs for the Observation: Item #592 | Table HL79999 |
|
|
OM1.8 |
Optional[List[str]] |
optional |
Other Names: Item #593 |
|
|
OM1.9 |
Optional[str] |
optional |
Preferred Report Name for the Observation: Item #594 |
|
|
OM1.10 |
Optional[str] |
optional |
Preferred Short Name or Mnemonic for the Observation: Item #595 |
|
|
OM1.11 |
Optional[str] |
optional |
Preferred Long Name for the Observation: Item #596 |
|
|
OM1.12 |
Optional[str] |
optional |
Orderability: Item #597 | Table HL70136 |
|
|
OM1.13 |
Optional[List[CWE]] |
optional |
Identity of Instrument Used to Perform this Study: Item #598 | Table HL79999 |
|
|
OM1.14 |
Optional[List[CWE]] |
optional |
Coded Representation of Method: Item #599 | Table HL79999 |
|
|
OM1.15 |
Optional[str] |
optional |
Portable Device Indicator: Item #600 | Table HL70136 |
|
|
OM1.16 |
Optional[List[CWE]] |
optional |
Observation Producing Department/Section: Item #601 | Table HL79999 |
|
|
OM1.17 |
Optional[XTN] |
optional |
Telephone Number of Section: Item #602 |
|
|
OM1.18 |
required |
Nature of Service/Test/Observation: Item #603 | Table HL70174 |
||
|
OM1.19 |
Optional[CWE] |
optional |
Report Subheader: Item #604 | Table HL79999 |
|
|
OM1.20 |
Optional[str] |
optional |
Report Display Order: Item #605 |
|
|
OM1.21 |
Optional[str] |
optional |
Date/Time Stamp for Any Change in Definition for the Observation: Item #606 |
|
|
OM1.22 |
Optional[str] |
optional |
Effective Date/Time of Change: Item #607 |
|
|
OM1.23 |
Optional[str] |
optional |
Typical Turn-Around Time: Item #608 |
|
|
OM1.24 |
Optional[str] |
optional |
Processing Time: Item #609 |
|
|
OM1.25 |
Optional[List[str]] |
optional |
Processing Priority: Item #610 | Table HL70168 |
|
|
OM1.26 |
Optional[str] |
optional |
Reporting Priority: Item #611 | Table HL70169 |
|
|
OM1.27 |
Optional[List[CWE]] |
optional |
Outside Site(s) Where Observation May Be Performed: Item #612 | Table HL79999 |
|
|
OM1.28 |
Optional[List[XAD]] |
optional |
Address of Outside Site(s): Item #613 |
|
|
OM1.29 |
Optional[XTN] |
optional |
Phone Number of Outside Site: Item #614 |
|
|
OM1.30 |
Optional[CWE] |
optional |
Confidentiality Code: Item #615 | Table HL70177 |
|
|
OM1.31 |
Optional[List[CWE]] |
optional |
Observations Required to Interpret this Observation: Item #616 | Table HL79999 |
|
|
OM1.32 |
Optional[TX] |
optional |
Interpretation of Observations: Item #617 |
|
|
OM1.33 |
Optional[List[CWE]] |
optional |
Contraindications to Observations: Item #618 | Table HL79999 |
|
|
OM1.34 |
Optional[List[CWE]] |
optional |
Reflex Tests/Observations: Item #619 | Table HL79999 |
|
|
OM1.35 |
Optional[List[TX]] |
optional |
Rules that Trigger Reflex Testing: Item #620 |
|
|
OM1.36 |
Optional[List[CWE]] |
optional |
Fixed Canned Message: Item #621 | Table HL79999 |
|
|
OM1.37 |
Optional[List[TX]] |
optional |
Patient Preparation: Item #622 |
|
|
OM1.38 |
Optional[CWE] |
optional |
Procedure Medication: Item #623 | Table HL79999 |
|
|
OM1.39 |
Optional[TX] |
optional |
Factors that may Affect the Observation: Item #624 |
|
|
OM1.40 |
Optional[List[str]] |
optional |
Service/Test/Observation Performance Schedule: Item #625 |
|
|
OM1.41 |
Optional[TX] |
optional |
Description of Test Methods: Item #626 |
|
|
OM1.42 |
Optional[CWE] |
optional |
Kind of Quantity Observed: Item #937 | Table HL70254 |
|
|
OM1.43 |
Optional[CWE] |
optional |
Point Versus Interval: Item #938 | Table HL70255 |
|
|
OM1.44 |
Optional[TX] |
optional |
Challenge Information: Item #939 | Table HL70256 |
|
|
OM1.45 |
Optional[CWE] |
optional |
Relationship Modifier: Item #940 | Table HL70258 |
|
|
OM1.46 |
Optional[CWE] |
optional |
Target Anatomic Site Of Test: Item #941 | Table HL79999 |
|
|
OM1.47 |
Optional[CWE] |
optional |
Modality of Imaging Measurement: Item #942 | Table HL70910 |
|
|
OM1.48 |
Optional[str] |
optional |
Exclusive Test: Item #3310 | Table HL70919 |
|
|
OM1.49 |
Optional[str] |
optional |
Diagnostic Serv Sect ID: Item #257 | Table HL70074 |
|
|
OM1.50 |
Optional[CWE] |
optional |
Taxonomic Classification Code: Item #1539 |
|
|
OM1.51 |
Optional[List[str]] |
optional |
Other Names: Item #3399 |
|
|
OM1.52 |
Optional[List[CWE]] |
optional |
Replacement Producer’s Service/Test/Observation ID: Item #3433 | Table HL79999 |
|
|
OM1.53 |
Optional[List[TX]] |
optional |
Prior Resuts Instructions: Item #3434 |
|
|
OM1.54 |
Optional[TX] |
optional |
Special Instructions: Item #3435 |
|
|
OM1.55 |
Optional[List[CWE]] |
optional |
Test Category: Item #3436 |
|
|
OM1.56 |
Optional[CWE] |
optional |
Observation/Identifier associated with Producer’s Service/Test/Observation ID: Item #3437 | Table HL79999 |
|
|
OM1.57 |
Optional[CQ] |
optional |
Typical Turn-Around Time: Item #3438 |
|
|
OM1.58 |
Optional[List[CWE]] |
optional |
Gender Restriction: Item #3439 | Table HL70001 |
|
|
OM1.59 |
Optional[List[NR]] |
optional |
Age Restriction: Item #3440 |
- class hl7types.hl7.v2_8_2.segments.OM2.OM2
HL7 v2 OM2 segment.
OM2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM2.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM2.2 |
Optional[CWE] |
optional |
Units of Measure: Item #627 | Table HL79999 |
|
|
OM2.3 |
Optional[List[str]] |
optional |
Range of Decimal Precision: Item #628 |
|
|
OM2.4 |
Optional[CWE] |
optional |
Corresponding SI Units of Measure: Item #629 | Table HL79999 |
|
|
OM2.5 |
Optional[TX] |
optional |
SI Conversion Factor: Item #630 |
|
|
OM2.6 |
Optional[List[RFR]] |
optional |
Reference (Normal) Range for Ordinal and Continuous Observations: Item #631 |
|
|
OM2.7 |
Optional[List[RFR]] |
optional |
Critical Range for Ordinal and Continuous Observations: Item #632 |
|
|
OM2.8 |
Optional[RFR] |
optional |
Absolute Range for Ordinal and Continuous Observations: Item #633 |
|
|
OM2.9 |
Optional[List[DLT]] |
optional |
Delta Check Criteria: Item #634 |
|
|
OM2.10 |
Optional[str] |
optional |
Minimum Meaningful Increments: Item #635 |
- class hl7types.hl7.v2_8_2.segments.OM3.OM3
HL7 v2 OM3 segment.
OM3¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM3.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM3.2 |
Optional[CWE] |
optional |
Preferred Coding System: Item #636 | Table HL79999 |
|
|
OM3.3 |
Optional[List[CWE]] |
optional |
Valid Coded “Answers”: Item #637 | Table HL79999 |
|
|
OM3.4 |
Optional[List[CWE]] |
optional |
Normal Text/Codes for Categorical Observations: Item #638 | Table HL79999 |
|
|
OM3.5 |
Optional[List[CWE]] |
optional |
Abnormal Text/Codes for Categorical Observations: Item #639 | Table HL79999 |
|
|
OM3.6 |
Optional[List[CWE]] |
optional |
Critical Text/Codes for Categorical Observations: Item #640 | Table HL79999 |
|
|
OM3.7 |
Optional[str] |
optional |
Value Type: Item #570 | Table HL70125 |
- class hl7types.hl7.v2_8_2.segments.OM4.OM4
HL7 v2 OM4 segment.
OM4¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM4.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM4.2 |
Optional[str] |
optional |
Derived Specimen: Item #642 | Table HL70170 |
|
|
OM4.3 |
Optional[List[TX]] |
optional |
Container Description: Item #643 |
|
|
OM4.4 |
Optional[List[str]] |
optional |
Container Volume: Item #644 |
|
|
OM4.5 |
Optional[List[CWE]] |
optional |
Container Units: Item #645 | Table HL79999 |
|
|
OM4.6 |
Optional[CWE] |
optional |
Specimen: Item #646 | Table HL79999 |
|
|
OM4.7 |
Optional[CWE] |
optional |
Additive: Item #647 | Table HL70371 |
|
|
OM4.8 |
Optional[TX] |
optional |
Preparation: Item #648 |
|
|
OM4.9 |
Optional[TX] |
optional |
Special Handling Requirements: Item #649 |
|
|
OM4.10 |
Optional[CQ] |
optional |
Normal Collection Volume: Item #650 |
|
|
OM4.11 |
Optional[CQ] |
optional |
Minimum Collection Volume: Item #651 |
|
|
OM4.12 |
Optional[TX] |
optional |
Specimen Requirements: Item #652 |
|
|
OM4.13 |
Optional[List[str]] |
optional |
Specimen Priorities: Item #653 | Table HL70027 |
|
|
OM4.14 |
Optional[CQ] |
optional |
Specimen Retention Time: Item #654 |
|
|
OM4.15 |
Optional[List[CWE]] |
optional |
Specimen Handling Code: Item #1908 | Table HL70376 |
|
|
OM4.16 |
Optional[str] |
optional |
Specimen Preference: Item #3311 | Table HL70920 |
|
|
OM4.17 |
Optional[str] |
optional |
Preferred Specimen/Attribture Sequence ID: Item #3312 |
|
|
OM4.18 |
Optional[List[CWE]] |
optional |
Taxonomic Classification Code: Item #1539 |
- class hl7types.hl7.v2_8_2.segments.OM5.OM5
HL7 v2 OM5 segment.
OM5¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM5.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM5.2 |
Optional[List[CWE]] |
optional |
Test/Observations Included Within an Ordered Test Battery: Item #655 | Table HL79999 |
|
|
OM5.3 |
Optional[str] |
optional |
Observation ID Suffixes: Item #656 |
- class hl7types.hl7.v2_8_2.segments.OM6.OM6
HL7 v2 OM6 segment.
OM6¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM6.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM6.2 |
Optional[TX] |
optional |
Derivation Rule: Item #657 |
- class hl7types.hl7.v2_8_2.segments.OM7.OM7
HL7 v2 OM7 segment.
OM7¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM7.1 |
str |
required |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OM7.2 |
required |
Universal Service Identifier: Item #238 |
||
|
OM7.3 |
Optional[List[CWE]] |
optional |
Category Identifier: Item #1481 | Table HL70412 |
|
|
OM7.4 |
Optional[TX] |
optional |
Category Description: Item #1482 |
|
|
OM7.5 |
Optional[List[str]] |
optional |
Category Synonym: Item #1483 |
|
|
OM7.6 |
Optional[str] |
optional |
Effective Test/Service Start Date/Time: Item #1484 |
|
|
OM7.7 |
Optional[str] |
optional |
Effective Test/Service End Date/Time: Item #1485 |
|
|
OM7.8 |
Optional[str] |
optional |
Test/Service Default Duration Quantity: Item #1486 |
|
|
OM7.9 |
Optional[CWE] |
optional |
Test/Service Default Duration Units: Item #1487 | Table HL79999 |
|
|
OM7.10 |
Optional[CWE] |
optional |
Test/Service Default Frequency: Item #1488 |
|
|
OM7.11 |
Optional[str] |
optional |
Consent Indicator: Item #1489 | Table HL70136 |
|
|
OM7.12 |
Optional[CWE] |
optional |
Consent Identifier: Item #1490 | Table HL70413 |
|
|
OM7.13 |
Optional[str] |
optional |
Consent Effective Start Date/Time: Item #1491 |
|
|
OM7.14 |
Optional[str] |
optional |
Consent Effective End Date/Time: Item #1492 |
|
|
OM7.15 |
Optional[str] |
optional |
Consent Interval Quantity: Item #1493 |
|
|
OM7.16 |
Optional[CWE] |
optional |
Consent Interval Units: Item #1494 | Table HL70414 |
|
|
OM7.17 |
Optional[str] |
optional |
Consent Waiting Period Quantity: Item #1495 |
|
|
OM7.18 |
Optional[CWE] |
optional |
Consent Waiting Period Units: Item #1496 | Table HL70414 |
|
|
OM7.19 |
Optional[str] |
optional |
Effective Date/Time of Change: Item #607 |
|
|
OM7.20 |
Optional[XCN] |
optional |
Entered By: Item #224 |
|
|
OM7.21 |
Optional[List[PL]] |
optional |
Orderable-at Location: Item #1497 |
|
|
OM7.22 |
Optional[CWE] |
optional |
Formulary Status: Item #1498 | Table HL70473 |
|
|
OM7.23 |
Optional[str] |
optional |
Special Order Indicator: Item #1499 | Table HL70136 |
|
|
OM7.24 |
Optional[List[CWE]] |
optional |
Primary Key Value - CDM: Item #1306 |
- class hl7types.hl7.v2_8_2.segments.OMC.OMC
HL7 v2 OMC segment.
OMC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OMC.1 |
Optional[str] |
optional |
Sequence Number - Test/Observation Master File: Item #586 |
|
|
OMC.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
OMC.3 |
Optional[EI] |
optional |
Segment Unique Key: Item #764 |
|
|
OMC.4 |
required |
Clinical Information Request: Item #3444 | Table HL79999 |
||
|
OMC.5 |
Optional[List[CWE]] |
optional |
Collection Event/Process Step: Item #3445 | Table HL70938 |
|
|
OMC.6 |
required |
Communication Location: Item #3446 | Table HL70939 |
||
|
OMC.7 |
Optional[str] |
optional |
Answer Required: Item #3447 | Table HL70136 |
|
|
OMC.8 |
Optional[str] |
optional |
Hint/Help Text: Item #3448 |
|
|
OMC.9 |
Optional[varies] |
optional |
Type of Answer: Item #3449 | Table HL70125 |
|
|
OMC.10 |
Optional[str] |
optional |
Multiple Answers Allowed: Item #3450 | Table HL70136 |
|
|
OMC.11 |
Optional[List[CWE]] |
optional |
Answer Choices: Item #3451 | Table HL79999 |
|
|
OMC.12 |
Optional[str] |
optional |
Character Limit: Item #3452 |
|
|
OMC.13 |
Optional[str] |
optional |
Number of Decimals: Item #3453 |
- class hl7types.hl7.v2_8_2.segments.ORC.ORC
HL7 v2 ORC segment.
ORC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ORC.1 |
str |
required |
Order Control: Item #215 | Table HL70119 |
|
|
ORC.2 |
Optional[EI] |
optional |
Placer Order Number: Item #216 |
|
|
ORC.3 |
Optional[EI] |
optional |
Filler Order Number: Item #217 |
|
|
ORC.4 |
Optional[EIP] |
optional |
Placer Group Number: Item #218 |
|
|
ORC.5 |
Optional[str] |
optional |
Order Status: Item #219 | Table HL70038 |
|
|
ORC.6 |
Optional[str] |
optional |
Response Flag: Item #220 | Table HL70121 |
|
|
ORC.8 |
Optional[EIP] |
optional |
Parent Order: Item #222 |
|
|
ORC.9 |
Optional[str] |
optional |
Date/Time of Transaction: Item #223 |
|
|
ORC.10 |
Optional[List[XCN]] |
optional |
Entered By: Item #224 |
|
|
ORC.11 |
Optional[List[XCN]] |
optional |
Verified By: Item #225 |
|
|
ORC.12 |
Optional[List[XCN]] |
optional |
Ordering Provider: Item #226 |
|
|
ORC.13 |
Optional[PL] |
optional |
Enterer’s Location: Item #227 |
|
|
ORC.14 |
Optional[List[XTN]] |
optional |
Call Back Phone Number: Item #228 |
|
|
ORC.15 |
Optional[str] |
optional |
Order Effective Date/Time: Item #229 |
|
|
ORC.16 |
Optional[CWE] |
optional |
Order Control Code Reason: Item #230 | Table HL79999 |
|
|
ORC.17 |
Optional[CWE] |
optional |
Entering Organization: Item #231 | Table HL79999 |
|
|
ORC.18 |
Optional[CWE] |
optional |
Entering Device: Item #232 | Table HL79999 |
|
|
ORC.19 |
Optional[List[XCN]] |
optional |
Action By: Item #233 |
|
|
ORC.20 |
Optional[CWE] |
optional |
Advanced Beneficiary Notice Code: Item #1310 | Table HL70339 |
|
|
ORC.21 |
Optional[List[XON]] |
optional |
Ordering Facility Name: Item #1311 |
|
|
ORC.22 |
Optional[List[XAD]] |
optional |
Ordering Facility Address: Item #1312 |
|
|
ORC.23 |
Optional[List[XTN]] |
optional |
Ordering Facility Phone Number: Item #1313 |
|
|
ORC.24 |
Optional[List[XAD]] |
optional |
Ordering Provider Address: Item #1314 |
|
|
ORC.25 |
Optional[CWE] |
optional |
Order Status Modifier: Item #1473 | Table HL79999 |
|
|
ORC.26 |
Optional[CWE] |
optional |
Advanced Beneficiary Notice Override Reason: Item #1641 | Table HL70552 |
|
|
ORC.27 |
Optional[str] |
optional |
Filler’s Expected Availability Date/Time: Item #1642 |
|
|
ORC.28 |
Optional[CWE] |
optional |
Confidentiality Code: Item #615 | Table HL70177 |
|
|
ORC.29 |
Optional[CWE] |
optional |
Order Type: Item #1643 | Table HL70482 |
|
|
ORC.30 |
Optional[CNE] |
optional |
Enterer Authorization Mode: Item #1644 | Table HL70483 |
|
|
ORC.31 |
Optional[CWE] |
optional |
Parent Universal Service Identifier: Item #2287 |
|
|
ORC.32 |
Optional[str] |
optional |
Advanced Beneficiary Notice Date: Item #2301 |
|
|
ORC.33 |
Optional[List[CX]] |
optional |
Alternate Placer Order Number: Item #3300 |
|
|
ORC.34 |
Optional[List[CWE]] |
optional |
Order Workflow Profile: Item #3387 | Table HL70934 |
- class hl7types.hl7.v2_8_2.segments.ORG.ORG
HL7 v2 ORG segment.
ORG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ORG.1 |
str |
required |
Set ID - ORG: Item #1459 |
|
|
ORG.2 |
Optional[CWE] |
optional |
Organization Unit Code: Item #1460 | Table HL70405 |
|
|
ORG.3 |
Optional[CWE] |
optional |
Organization Unit Type Code: Item #1625 | Table HL70474 |
|
|
ORG.4 |
Optional[str] |
optional |
Primary Org Unit Indicator: Item #1462 | Table HL70136 |
|
|
ORG.5 |
Optional[CX] |
optional |
Practitioner Org Unit Identifier: Item #1463 |
|
|
ORG.6 |
Optional[CWE] |
optional |
Health Care Provider Type Code: Item #1464 | Table HL70452 |
|
|
ORG.7 |
Optional[CWE] |
optional |
Health Care Provider Classification Code: Item #1614 | Table HL70453 |
|
|
ORG.8 |
Optional[CWE] |
optional |
Health Care Provider Area of Specialization Code: Item #1615 | Table HL70454 |
|
|
ORG.9 |
Optional[DR] |
optional |
Effective Date Range: Item #1465 |
|
|
ORG.10 |
Optional[CWE] |
optional |
Employment Status Code: Item #1276 | Table HL70066 |
|
|
ORG.11 |
Optional[str] |
optional |
Board Approval Indicator: Item #1467 | Table HL70136 |
|
|
ORG.12 |
Optional[str] |
optional |
Primary Care Physician Indicator: Item #1468 | Table HL70136 |
|
|
ORG.13 |
Optional[List[CWE]] |
optional |
Cost Center Code: Item #1891 | Table HL70539 |
- class hl7types.hl7.v2_8_2.segments.OVR.OVR
HL7 v2 OVR segment.
OVR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OVR.1 |
Optional[CWE] |
optional |
Business Rule Override Type: Item #1829 | Table HL70518 |
|
|
OVR.2 |
Optional[CWE] |
optional |
Business Rule Override Code: Item #1830 | Table HL70521 |
|
|
OVR.3 |
Optional[TX] |
optional |
Override Comments: Item #1831 |
|
|
OVR.4 |
Optional[XCN] |
optional |
Override Entered By: Item #1832 |
|
|
OVR.5 |
Optional[XCN] |
optional |
Override Authorized By: Item #1833 |
- class hl7types.hl7.v2_8_2.segments.PAC.PAC
HL7 v2 PAC segment.
PAC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PAC.1 |
str |
required |
Set Id - PAC: Item #2350 |
|
|
PAC.2 |
Optional[EI] |
optional |
Package ID: Item #2351 |
|
|
PAC.3 |
Optional[EI] |
optional |
Parent Package ID: Item #2352 |
|
|
PAC.4 |
Optional[NA] |
optional |
Position in Parent Package: Item #2353 |
|
|
PAC.5 |
required |
Package Type: Item #2354 | Table HL70908 |
||
|
PAC.6 |
Optional[List[CWE]] |
optional |
Package Condition: Item #2355 | Table HL70544 |
|
|
PAC.7 |
Optional[List[CWE]] |
optional |
Package Handling Code: Item #2356 | Table HL70376 |
|
|
PAC.8 |
Optional[List[CWE]] |
optional |
Package Risk Code: Item #2357 | Table HL70489 |
- class hl7types.hl7.v2_8_2.segments.PCE.PCE
HL7 v2 PCE segment.
PCE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PCE.1 |
str |
required |
Set ID - PCE: Item #2228 |
|
|
PCE.2 |
Optional[CX] |
optional |
Cost Center Account Number: Item #281 | Table HL70319 |
|
|
PCE.3 |
Optional[CWE] |
optional |
Transaction Code: Item #361 | Table HL70132 |
|
|
PCE.4 |
Optional[CP] |
optional |
Transaction amount - unit: Item #366 |
- class hl7types.hl7.v2_8_2.segments.PCR.PCR
HL7 v2 PCR segment.
PCR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PCR.1 |
required |
Implicated Product: Item #1098 | Table HL79999 |
||
|
PCR.2 |
Optional[str] |
optional |
Generic Product: Item #1099 | Table HL70249 |
|
|
PCR.3 |
Optional[CWE] |
optional |
Product Class: Item #1100 | Table HL79999 |
|
|
PCR.4 |
Optional[CQ] |
optional |
Total Duration Of Therapy: Item #1101 |
|
|
PCR.5 |
Optional[str] |
optional |
Product Manufacture Date: Item #1102 |
|
|
PCR.6 |
Optional[str] |
optional |
Product Expiration Date: Item #1103 |
|
|
PCR.7 |
Optional[str] |
optional |
Product Implantation Date: Item #1104 |
|
|
PCR.8 |
Optional[str] |
optional |
Product Explantation Date: Item #1105 |
|
|
PCR.9 |
Optional[CWE] |
optional |
Single Use Device: Item #1106 | Table HL70244 |
|
|
PCR.10 |
Optional[CWE] |
optional |
Indication For Product Use: Item #1107 | Table HL79999 |
|
|
PCR.11 |
Optional[CWE] |
optional |
Product Problem: Item #1108 | Table HL70245 |
|
|
PCR.12 |
Optional[List[str]] |
optional |
Product Serial/Lot Number: Item #1109 |
|
|
PCR.13 |
Optional[CWE] |
optional |
Product Available For Inspection: Item #1110 | Table HL70246 |
|
|
PCR.14 |
Optional[CWE] |
optional |
Product Evaluation Performed: Item #1111 | Table HL79999 |
|
|
PCR.15 |
Optional[CWE] |
optional |
Product Evaluation Status: Item #1112 | Table HL70247 |
|
|
PCR.16 |
Optional[CWE] |
optional |
Product Evaluation Results: Item #1113 | Table HL79999 |
|
|
PCR.17 |
Optional[str] |
optional |
Evaluated Product Source: Item #1114 | Table HL70248 |
|
|
PCR.18 |
Optional[str] |
optional |
Date Product Returned To Manufacturer: Item #1115 |
|
|
PCR.19 |
Optional[str] |
optional |
Device Operator Qualifications: Item #1116 | Table HL70242 |
|
|
PCR.20 |
Optional[str] |
optional |
Relatedness Assessment: Item #1117 | Table HL70250 |
|
|
PCR.21 |
Optional[List[str]] |
optional |
Action Taken In Response To The Event: Item #1118 | Table HL70251 |
|
|
PCR.22 |
Optional[List[str]] |
optional |
Event Causality Observations: Item #1119 | Table HL70252 |
|
|
PCR.23 |
Optional[List[str]] |
optional |
Indirect Exposure Mechanism: Item #1120 | Table HL70253 |
- class hl7types.hl7.v2_8_2.segments.PD1.PD1
HL7 v2 PD1 segment.
PD1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PD1.1 |
Optional[List[CWE]] |
optional |
Living Dependency: Item #755 | Table HL70223 |
|
|
PD1.2 |
Optional[CWE] |
optional |
Living Arrangement: Item #742 | Table HL70220 |
|
|
PD1.3 |
Optional[List[XON]] |
optional |
Patient Primary Facility: Item #756 | Table HL70204 |
|
|
PD1.5 |
Optional[CWE] |
optional |
Student Indicator: Item #745 | Table HL70231 |
|
|
PD1.6 |
Optional[CWE] |
optional |
Handicap: Item #753 | Table HL70295 |
|
|
PD1.7 |
Optional[CWE] |
optional |
Living Will Code: Item #759 | Table HL70315 |
|
|
PD1.8 |
Optional[CWE] |
optional |
Organ Donor Code: Item #760 | Table HL70316 |
|
|
PD1.9 |
Optional[str] |
optional |
Separate Bill: Item #761 | Table HL70136 |
|
|
PD1.10 |
Optional[List[CX]] |
optional |
Duplicate Patient: Item #762 |
|
|
PD1.11 |
Optional[CWE] |
optional |
Publicity Code: Item #743 | Table HL70215 |
|
|
PD1.12 |
Optional[str] |
optional |
Protection Indicator: Item #744 | Table HL70136 |
|
|
PD1.13 |
Optional[str] |
optional |
Protection Indicator Effective Date: Item #1566 |
|
|
PD1.14 |
Optional[List[XON]] |
optional |
Place of Worship: Item #1567 |
|
|
PD1.15 |
Optional[List[CWE]] |
optional |
Advance Directive Code: Item #1548 | Table HL70435 |
|
|
PD1.16 |
Optional[CWE] |
optional |
Immunization Registry Status: Item #1569 | Table HL70441 |
|
|
PD1.17 |
Optional[str] |
optional |
Immunization Registry Status Effective Date: Item #1570 |
|
|
PD1.18 |
Optional[str] |
optional |
Publicity Code Effective Date: Item #1571 |
|
|
PD1.19 |
Optional[CWE] |
optional |
Military Branch: Item #1572 | Table HL70140 |
|
|
PD1.20 |
Optional[CWE] |
optional |
Military Rank/Grade: Item #486 | Table HL70141 |
|
|
PD1.21 |
Optional[CWE] |
optional |
Military Status: Item #1573 | Table HL70142 |
|
|
PD1.22 |
Optional[str] |
optional |
Advance Directive Last Verified Date: Item #2141 |
- class hl7types.hl7.v2_8_2.segments.PDA.PDA
HL7 v2 PDA segment.
PDA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PDA.1 |
Optional[List[CWE]] |
optional |
Death Cause Code: Item #1574 |
|
|
PDA.2 |
Optional[PL] |
optional |
Death Location: Item #1575 |
|
|
PDA.3 |
Optional[str] |
optional |
Death Certified Indicator: Item #1576 | Table HL70136 |
|
|
PDA.4 |
Optional[str] |
optional |
Death Certificate Signed Date/Time: Item #1577 |
|
|
PDA.5 |
Optional[XCN] |
optional |
Death Certified By: Item #1578 |
|
|
PDA.6 |
Optional[str] |
optional |
Autopsy Indicator: Item #1579 | Table HL70136 |
|
|
PDA.7 |
Optional[DR] |
optional |
Autopsy Start and End Date/Time: Item #1580 |
|
|
PDA.8 |
Optional[XCN] |
optional |
Autopsy Performed By: Item #1581 |
|
|
PDA.9 |
Optional[str] |
optional |
Coroner Indicator: Item #1582 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.PDC.PDC
HL7 v2 PDC segment.
PDC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PDC.1 |
Optional[List[XON]] |
optional |
Manufacturer/Distributor: Item #1247 |
|
|
PDC.2 |
required |
Country: Item #1248 | Table HL79999 |
||
|
PDC.3 |
str |
required |
Brand Name: Item #1249 |
|
|
PDC.4 |
Optional[str] |
optional |
Device Family Name: Item #1250 |
|
|
PDC.5 |
Optional[CWE] |
optional |
Generic Name: Item #1251 | Table HL79999 |
|
|
PDC.6 |
Optional[List[str]] |
optional |
Model Identifier: Item #1252 |
|
|
PDC.7 |
Optional[str] |
optional |
Catalogue Identifier: Item #1253 |
|
|
PDC.8 |
Optional[List[str]] |
optional |
Other Identifier: Item #1254 |
|
|
PDC.9 |
Optional[CWE] |
optional |
Product Code: Item #1255 | Table HL79999 |
|
|
PDC.10 |
Optional[str] |
optional |
Marketing Basis: Item #1256 | Table HL70330 |
|
|
PDC.11 |
Optional[str] |
optional |
Marketing Approval ID: Item #1257 |
|
|
PDC.12 |
Optional[CQ] |
optional |
Labeled Shelf Life: Item #1258 |
|
|
PDC.13 |
Optional[CQ] |
optional |
Expected Shelf Life: Item #1259 |
|
|
PDC.14 |
Optional[str] |
optional |
Date First Marketed: Item #1260 |
|
|
PDC.15 |
Optional[str] |
optional |
Date Last Marketed: Item #1261 |
- class hl7types.hl7.v2_8_2.segments.PEO.PEO
HL7 v2 PEO segment.
PEO¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PEO.1 |
Optional[List[CWE]] |
optional |
Event Identifiers Used: Item #1073 | Table HL79999 |
|
|
PEO.2 |
Optional[List[CWE]] |
optional |
Event Symptom/Diagnosis Code: Item #1074 | Table HL79999 |
|
|
PEO.3 |
str |
required |
Event Onset Date/Time: Item #1075 |
|
|
PEO.4 |
Optional[str] |
optional |
Event Exacerbation Date/Time: Item #1076 |
|
|
PEO.5 |
Optional[str] |
optional |
Event Improved Date/Time: Item #1077 |
|
|
PEO.6 |
Optional[str] |
optional |
Event Ended Data/Time: Item #1078 |
|
|
PEO.7 |
Optional[List[XAD]] |
optional |
Event Location Occurred Address: Item #1079 |
|
|
PEO.8 |
Optional[List[str]] |
optional |
Event Qualification: Item #1080 | Table HL70237 |
|
|
PEO.9 |
Optional[str] |
optional |
Event Serious: Item #1081 | Table HL70238 |
|
|
PEO.10 |
Optional[str] |
optional |
Event Expected: Item #1082 | Table HL70239 |
|
|
PEO.11 |
Optional[List[str]] |
optional |
Event Outcome: Item #1083 | Table HL70240 |
|
|
PEO.12 |
Optional[str] |
optional |
Patient Outcome: Item #1084 | Table HL70241 |
|
|
PEO.13 |
Optional[List[FT]] |
optional |
Event Description from Others: Item #1085 |
|
|
PEO.14 |
Optional[List[FT]] |
optional |
Event Description from Original Reporter: Item #1086 |
|
|
PEO.15 |
Optional[List[FT]] |
optional |
Event Description from Patient: Item #1087 |
|
|
PEO.16 |
Optional[List[FT]] |
optional |
Event Description from Practitioner: Item #1088 |
|
|
PEO.17 |
Optional[List[FT]] |
optional |
Event Description from Autopsy: Item #1089 |
|
|
PEO.18 |
Optional[List[CWE]] |
optional |
Cause Of Death: Item #1090 | Table HL79999 |
|
|
PEO.19 |
Optional[List[XPN]] |
optional |
Primary Observer Name: Item #1091 |
|
|
PEO.20 |
Optional[List[XAD]] |
optional |
Primary Observer Address: Item #1092 |
|
|
PEO.21 |
Optional[List[XTN]] |
optional |
Primary Observer Telephone: Item #1093 |
|
|
PEO.22 |
Optional[str] |
optional |
Primary Observer’s Qualification: Item #1094 | Table HL70242 |
|
|
PEO.23 |
Optional[str] |
optional |
Confirmation Provided By: Item #1095 | Table HL70242 |
|
|
PEO.24 |
Optional[str] |
optional |
Primary Observer Aware Date/Time: Item #1096 |
|
|
PEO.25 |
Optional[str] |
optional |
Primary Observer’s identity May Be Divulged: Item #1097 | Table HL70243 |
- class hl7types.hl7.v2_8_2.segments.PES.PES
HL7 v2 PES segment.
PES¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PES.1 |
Optional[List[XON]] |
optional |
Sender Organization Name: Item #1059 |
|
|
PES.2 |
Optional[List[XCN]] |
optional |
Sender Individual Name: Item #1060 |
|
|
PES.3 |
Optional[List[XAD]] |
optional |
Sender Address: Item #1062 |
|
|
PES.4 |
Optional[List[XTN]] |
optional |
Sender Telephone: Item #1063 |
|
|
PES.5 |
Optional[EI] |
optional |
Sender Event Identifier: Item #1064 |
|
|
PES.6 |
Optional[str] |
optional |
Sender Sequence Number: Item #1065 |
|
|
PES.7 |
Optional[List[FT]] |
optional |
Sender Event Description: Item #1066 |
|
|
PES.8 |
Optional[FT] |
optional |
Sender Comment: Item #1067 |
|
|
PES.9 |
Optional[str] |
optional |
Sender Aware Date/Time: Item #1068 |
|
|
PES.10 |
str |
required |
Event Report Date: Item #1069 |
|
|
PES.11 |
Optional[List[str]] |
optional |
Event Report Timing/Type: Item #1070 | Table HL70234 |
|
|
PES.12 |
Optional[str] |
optional |
Event Report Source: Item #1071 | Table HL70235 |
|
|
PES.13 |
Optional[List[str]] |
optional |
Event Reported To: Item #1072 | Table HL70236 |
- class hl7types.hl7.v2_8_2.segments.PID.PID
HL7 v2 PID segment.
PID¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PID.1 |
Optional[str] |
optional |
Set ID - PID: Item #104 |
|
|
PID.3 |
List[CX] |
required |
Patient Identifier List: Item #106 |
|
|
PID.5 |
Optional[List[XPN]] |
optional |
Patient Name: Item #108 | Table HL70200 |
|
|
PID.6 |
Optional[List[XPN]] |
optional |
Mother’s Maiden Name: Item #109 |
|
|
PID.7 |
Optional[str] |
optional |
Date/Time of Birth: Item #110 |
|
|
PID.8 |
Optional[CWE] |
optional |
Administrative Sex: Item #111 | Table HL70001 |
|
|
PID.10 |
Optional[List[CWE]] |
optional |
Race: Item #113 | Table HL70005 |
|
|
PID.11 |
Optional[List[XAD]] |
optional |
Patient Address: Item #114 |
|
|
PID.13 |
Optional[List[XTN]] |
optional |
Phone Number - Home: Item #116 |
|
|
PID.14 |
Optional[List[XTN]] |
optional |
Phone Number - Business: Item #117 |
|
|
PID.15 |
Optional[CWE] |
optional |
Primary Language: Item #118 | Table HL70296 |
|
|
PID.16 |
Optional[CWE] |
optional |
Marital Status: Item #119 | Table HL70002 |
|
|
PID.17 |
Optional[CWE] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
PID.18 |
Optional[CX] |
optional |
Patient Account Number: Item #121 |
|
|
PID.21 |
Optional[List[CX]] |
optional |
Mother’s Identifier: Item #124 |
|
|
PID.22 |
Optional[List[CWE]] |
optional |
Ethnic Group: Item #125 | Table HL70189 |
|
|
PID.23 |
Optional[str] |
optional |
Birth Place: Item #126 |
|
|
PID.24 |
Optional[str] |
optional |
Multiple Birth Indicator: Item #127 | Table HL70136 |
|
|
PID.25 |
Optional[str] |
optional |
Birth Order: Item #128 |
|
|
PID.26 |
Optional[List[CWE]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
PID.27 |
Optional[CWE] |
optional |
Veterans Military Status: Item #130 | Table HL70172 |
|
|
PID.29 |
Optional[str] |
optional |
Patient Death Date and Time: Item #740 |
|
|
PID.30 |
Optional[str] |
optional |
Patient Death Indicator: Item #741 | Table HL70136 |
|
|
PID.31 |
Optional[str] |
optional |
Identity Unknown Indicator: Item #1535 | Table HL70136 |
|
|
PID.32 |
Optional[List[CWE]] |
optional |
Identity Reliability Code: Item #1536 | Table HL70445 |
|
|
PID.33 |
Optional[str] |
optional |
Last Update Date/Time: Item #1537 |
|
|
PID.34 |
Optional[HD] |
optional |
Last Update Facility: Item #1538 |
|
|
PID.35 |
Optional[CWE] |
optional |
Taxonomic Classification Code: Item #1539 |
|
|
PID.36 |
Optional[CWE] |
optional |
Breed Code: Item #1540 | Table HL70447 |
|
|
PID.37 |
Optional[str] |
optional |
Strain: Item #1541 |
|
|
PID.38 |
Optional[List[CWE]] |
optional |
Production Class Code: Item #1542 | Table HL70429 |
|
|
PID.39 |
Optional[List[CWE]] |
optional |
Tribal Citizenship: Item #1840 | Table HL70171 |
|
|
PID.40 |
Optional[List[XTN]] |
optional |
Patient Telecommunication Information: Item #2289 |
- class hl7types.hl7.v2_8_2.segments.PKG.PKG
HL7 v2 PKG segment.
PKG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PKG.1 |
str |
required |
Set Id - PKG: Item #2221 |
|
|
PKG.2 |
Optional[CWE] |
optional |
Packaging Units: Item #2222 | Table HL70818 |
|
|
PKG.3 |
Optional[CNE] |
optional |
Default Order Unit Of Measure Indicator: Item #2223 | Table HL70532 |
|
|
PKG.4 |
Optional[str] |
optional |
Package Quantity: Item #2224 |
|
|
PKG.5 |
Optional[CP] |
optional |
Price: Item #2225 |
|
|
PKG.6 |
Optional[CP] |
optional |
Future Item Price: Item #2226 |
|
|
PKG.7 |
Optional[str] |
optional |
Future Item Price Effective Date: Item #2227 |
|
|
PKG.8 |
Optional[CWE] |
optional |
Global Trade Item Number: Item #3307 |
- class hl7types.hl7.v2_8_2.segments.PM1.PM1
HL7 v2 PM1 segment.
PM1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PM1.1 |
required |
Health Plan ID: Item #368 | Table HL70072 |
||
|
PM1.2 |
List[CX] |
required |
Insurance Company ID: Item #428 |
|
|
PM1.3 |
Optional[List[XON]] |
optional |
Insurance Company Name: Item #429 |
|
|
PM1.4 |
Optional[List[XAD]] |
optional |
Insurance Company Address: Item #430 |
|
|
PM1.5 |
Optional[List[XPN]] |
optional |
Insurance Co Contact Person: Item #431 |
|
|
PM1.6 |
Optional[List[XTN]] |
optional |
Insurance Co Phone Number: Item #432 |
|
|
PM1.7 |
Optional[str] |
optional |
Group Number: Item #433 |
|
|
PM1.8 |
Optional[List[XON]] |
optional |
Group Name: Item #434 |
|
|
PM1.9 |
Optional[str] |
optional |
Plan Effective Date: Item #437 |
|
|
PM1.10 |
Optional[str] |
optional |
Plan Expiration Date: Item #438 |
|
|
PM1.11 |
Optional[str] |
optional |
Patient DOB Required: Item #3454 | Table HL70136 |
|
|
PM1.12 |
Optional[str] |
optional |
Patient Gender Required: Item #3455 | Table HL70136 |
|
|
PM1.13 |
Optional[str] |
optional |
Patient Relationship Required: Item #3456 | Table HL70136 |
|
|
PM1.14 |
Optional[str] |
optional |
Patient Signature Required: Item #3457 | Table HL70136 |
|
|
PM1.15 |
Optional[str] |
optional |
Diagnosis Required: Item #3458 | Table HL70136 |
|
|
PM1.16 |
Optional[str] |
optional |
Service Required: Item #3459 | Table HL70136 |
|
|
PM1.17 |
Optional[str] |
optional |
Patient Name Required: Item #3460 | Table HL70136 |
|
|
PM1.18 |
Optional[str] |
optional |
Patient Address Required: Item #3461 | Table HL70136 |
|
|
PM1.19 |
Optional[str] |
optional |
Subscribers Name Required: Item #3462 | Table HL70136 |
|
|
PM1.20 |
Optional[str] |
optional |
Workman’s Comp Indicator: Item #3463 | Table HL70136 |
|
|
PM1.21 |
Optional[str] |
optional |
Bill Type Required: Item #3464 | Table HL70136 |
|
|
PM1.22 |
Optional[str] |
optional |
Commercial Carrier Name and Address Required: Item #3465 | Table HL70136 |
|
|
PM1.23 |
Optional[str] |
optional |
Policy Number Pattern: Item #3466 |
|
|
PM1.24 |
Optional[str] |
optional |
Group Number Pattern: Item #3467 |
- class hl7types.hl7.v2_8_2.segments.PMT.PMT
HL7 v2 PMT segment.
PMT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PMT.1 |
required |
Payment/Remittance Advice Number: Item #2018 |
||
|
PMT.2 |
str |
required |
Payment/Remittance Effective Date/Time: Item #2019 |
|
|
PMT.3 |
str |
required |
Payment/Remittance Expiration Date/Time: Item #2020 |
|
|
PMT.4 |
required |
Payment Method: Item #2021 | Table HL70570 |
||
|
PMT.5 |
str |
required |
Payment/Remittance Date/Time: Item #2022 |
|
|
PMT.6 |
required |
Payment/Remittance Amount: Item #2023 |
||
|
PMT.7 |
Optional[EI] |
optional |
Check Number: Item #2024 |
|
|
PMT.8 |
Optional[XON] |
optional |
Payee Bank Identification: Item #2025 |
|
|
PMT.9 |
Optional[str] |
optional |
Payee Transit Number: Item #2026 |
|
|
PMT.10 |
Optional[CX] |
optional |
Payee Bank Account ID: Item #2027 |
|
|
PMT.11 |
required |
Payment Organization: Item #2028 |
||
|
PMT.12 |
Optional[str] |
optional |
ESR-Code-Line: Item #2029 |
- class hl7types.hl7.v2_8_2.segments.PR1.PR1
HL7 v2 PR1 segment.
PR1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PR1.1 |
str |
required |
Set ID - PR1: Item #391 |
|
|
PR1.3 |
required |
Procedure Code: Item #393 | Table HL70088 |
||
|
PR1.5 |
str |
required |
Procedure Date/Time: Item #395 |
|
|
PR1.6 |
Optional[CWE] |
optional |
Procedure Functional Type: Item #396 | Table HL70230 |
|
|
PR1.7 |
Optional[str] |
optional |
Procedure Minutes: Item #397 |
|
|
PR1.9 |
Optional[CWE] |
optional |
Anesthesia Code: Item #399 | Table HL70019 |
|
|
PR1.10 |
Optional[str] |
optional |
Anesthesia Minutes: Item #400 |
|
|
PR1.13 |
Optional[CWE] |
optional |
Consent Code: Item #403 | Table HL70059 |
|
|
PR1.14 |
Optional[str] |
optional |
Procedure Priority: Item #404 | Table HL70418 |
|
|
PR1.15 |
Optional[CWE] |
optional |
Associated Diagnosis Code: Item #772 | Table HL70051 |
|
|
PR1.16 |
Optional[List[CNE]] |
optional |
Procedure Code Modifier: Item #1316 | Table HL70340 |
|
|
PR1.17 |
Optional[CWE] |
optional |
Procedure DRG Type: Item #1501 | Table HL70416 |
|
|
PR1.18 |
Optional[List[CWE]] |
optional |
Tissue Type Code: Item #1502 | Table HL70417 |
|
|
PR1.19 |
Optional[EI] |
optional |
Procedure Identifier: Item #1848 |
|
|
PR1.20 |
Optional[str] |
optional |
Procedure Action Code: Item #1849 | Table HL70206 |
|
|
PR1.21 |
Optional[CWE] |
optional |
DRG Procedure Determination Status: Item #2177 | Table HL70761 |
|
|
PR1.22 |
Optional[CWE] |
optional |
DRG Procedure Relevance: Item #2178 | Table HL70763 |
|
|
PR1.23 |
Optional[List[PL]] |
optional |
Treating Organizational Unit: Item #2371 |
|
|
PR1.24 |
Optional[str] |
optional |
Respiratory Within Surgery: Item #2372 | Table HL70136 |
|
|
PR1.25 |
Optional[EI] |
optional |
Parent Procedure ID: Item #2373 |
- class hl7types.hl7.v2_8_2.segments.PRA.PRA
HL7 v2 PRA segment.
PRA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRA.1 |
Optional[CWE] |
optional |
Primary Key Value - PRA: Item #685 | Table HL79999 |
|
|
PRA.2 |
Optional[List[CWE]] |
optional |
Practitioner Group: Item #686 | Table HL70358 |
|
|
PRA.3 |
Optional[List[CWE]] |
optional |
Practitioner Category: Item #687 | Table HL70186 |
|
|
PRA.4 |
Optional[str] |
optional |
Provider Billing: Item #688 | Table HL70187 |
|
|
PRA.5 |
Optional[List[SPD]] |
optional |
Specialty: Item #689 | Table HL70337 |
|
|
PRA.6 |
Optional[List[PLN]] |
optional |
Practitioner ID Numbers: Item #690 | Table HL70338 |
|
|
PRA.7 |
Optional[List[PIP]] |
optional |
Privileges: Item #691 |
|
|
PRA.8 |
Optional[str] |
optional |
Date Entered Practice: Item #1296 |
|
|
PRA.9 |
Optional[CWE] |
optional |
Institution: Item #1613 | Table HL70537 |
|
|
PRA.10 |
Optional[str] |
optional |
Date Left Practice: Item #1348 |
|
|
PRA.11 |
Optional[List[CWE]] |
optional |
Government Reimbursement Billing Eligibility: Item #1388 | Table HL70401 |
|
|
PRA.12 |
Optional[str] |
optional |
Set ID - PRA: Item #1616 |
- class hl7types.hl7.v2_8_2.segments.PRB.PRB
HL7 v2 PRB segment.
PRB¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRB.1 |
str |
required |
Action Code: Item #816 | Table HL70206 |
|
|
PRB.2 |
str |
required |
Action Date/Time: Item #817 |
|
|
PRB.3 |
required |
Problem ID: Item #838 |
||
|
PRB.4 |
required |
Problem Instance ID: Item #839 |
||
|
PRB.5 |
Optional[EI] |
optional |
Episode of Care ID: Item #820 |
|
|
PRB.6 |
Optional[str] |
optional |
Problem List Priority: Item #841 |
|
|
PRB.7 |
Optional[str] |
optional |
Problem Established Date/Time: Item #842 |
|
|
PRB.8 |
Optional[str] |
optional |
Anticipated Problem Resolution Date/Time: Item #843 |
|
|
PRB.9 |
Optional[str] |
optional |
Actual Problem Resolution Date/Time: Item #844 |
|
|
PRB.10 |
Optional[CWE] |
optional |
Problem Classification: Item #845 |
|
|
PRB.11 |
Optional[List[CWE]] |
optional |
Problem Management Discipline: Item #846 |
|
|
PRB.12 |
Optional[CWE] |
optional |
Problem Persistence: Item #847 |
|
|
PRB.13 |
Optional[CWE] |
optional |
Problem Confirmation Status: Item #848 |
|
|
PRB.14 |
Optional[CWE] |
optional |
Problem Life Cycle Status: Item #849 |
|
|
PRB.15 |
Optional[str] |
optional |
Problem Life Cycle Status Date/Time: Item #850 |
|
|
PRB.16 |
Optional[str] |
optional |
Problem Date of Onset: Item #851 |
|
|
PRB.17 |
Optional[str] |
optional |
Problem Onset Text: Item #852 |
|
|
PRB.18 |
Optional[CWE] |
optional |
Problem Ranking: Item #853 |
|
|
PRB.19 |
Optional[CWE] |
optional |
Certainty of Problem: Item #854 |
|
|
PRB.20 |
Optional[str] |
optional |
Probability of Problem (0-1): Item #855 |
|
|
PRB.21 |
Optional[CWE] |
optional |
Individual Awareness of Problem: Item #856 |
|
|
PRB.22 |
Optional[CWE] |
optional |
Problem Prognosis: Item #857 |
|
|
PRB.23 |
Optional[CWE] |
optional |
Individual Awareness of Prognosis: Item #858 |
|
|
PRB.24 |
Optional[str] |
optional |
Family/Significant Other Awareness of Problem/Prognosis: Item #859 |
|
|
PRB.25 |
Optional[CWE] |
optional |
Security/Sensitivity: Item #823 |
|
|
PRB.26 |
Optional[CWE] |
optional |
Problem Severity: Item #2234 | Table HL70836 |
|
|
PRB.27 |
Optional[CWE] |
optional |
Problem Perspective: Item #2235 | Table HL70838 |
|
|
PRB.28 |
Optional[CNE] |
optional |
Mood Code: Item #2237 | Table HL70725 |
- class hl7types.hl7.v2_8_2.segments.PRC.PRC
HL7 v2 PRC segment.
PRC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRC.1 |
required |
Primary Key Value - PRC: Item #982 | Table HL70132 |
||
|
PRC.2 |
Optional[List[CWE]] |
optional |
Facility ID - PRC: Item #995 | Table HL70464 |
|
|
PRC.3 |
Optional[List[CWE]] |
optional |
Department: Item #676 | Table HL70184 |
|
|
PRC.4 |
Optional[List[CWE]] |
optional |
Valid Patient Classes: Item #967 | Table HL70004 |
|
|
PRC.5 |
Optional[List[CP]] |
optional |
Price: Item #998 |
|
|
PRC.6 |
Optional[List[str]] |
optional |
Formula: Item #999 |
|
|
PRC.7 |
Optional[str] |
optional |
Minimum Quantity: Item #1000 |
|
|
PRC.8 |
Optional[str] |
optional |
Maximum Quantity: Item #1001 |
|
|
PRC.9 |
Optional[MO] |
optional |
Minimum Price: Item #1002 |
|
|
PRC.10 |
Optional[MO] |
optional |
Maximum Price: Item #1003 |
|
|
PRC.11 |
Optional[str] |
optional |
Effective Start Date: Item #1004 |
|
|
PRC.12 |
Optional[str] |
optional |
Effective End Date: Item #1005 |
|
|
PRC.13 |
Optional[CWE] |
optional |
Price Override Flag: Item #1006 | Table HL70268 |
|
|
PRC.14 |
Optional[List[CWE]] |
optional |
Billing Category: Item #1007 | Table HL70293 |
|
|
PRC.15 |
Optional[str] |
optional |
Chargeable Flag: Item #1008 | Table HL70136 |
|
|
PRC.16 |
Optional[str] |
optional |
Active/Inactive Flag: Item #675 | Table HL70183 |
|
|
PRC.17 |
Optional[MO] |
optional |
Cost: Item #989 |
|
|
PRC.18 |
Optional[CWE] |
optional |
Charge on Indicator: Item #1009 | Table HL70269 |
- class hl7types.hl7.v2_8_2.segments.PRD.PRD
HL7 v2 PRD segment.
PRD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRD.1 |
Optional[List[CWE]] |
optional |
Provider Role: Item #1155 | Table HL70286 |
|
|
PRD.2 |
Optional[List[XPN]] |
optional |
Provider Name: Item #1156 |
|
|
PRD.3 |
Optional[List[XAD]] |
optional |
Provider Address: Item #1157 |
|
|
PRD.4 |
Optional[PL] |
optional |
Provider Location: Item #1158 |
|
|
PRD.5 |
Optional[List[XTN]] |
optional |
Provider Communication Information: Item #1159 |
|
|
PRD.6 |
Optional[CWE] |
optional |
Preferred Method of Contact: Item #684 | Table HL70185 |
|
|
PRD.7 |
Optional[List[PLN]] |
optional |
Provider Identifiers: Item #1162 | Table HL70338 |
|
|
PRD.8 |
Optional[str] |
optional |
Effective Start Date of Provider Role: Item #1163 |
|
|
PRD.9 |
Optional[List[str]] |
optional |
Effective End Date of Provider Role: Item #1164 |
|
|
PRD.10 |
Optional[XON] |
optional |
Provider Organization Name and Identifier: Item #2256 |
|
|
PRD.11 |
Optional[List[XAD]] |
optional |
Provider Organization Address: Item #2257 |
|
|
PRD.12 |
Optional[List[PL]] |
optional |
Provider Organization Location Information: Item #2258 |
|
|
PRD.13 |
Optional[List[XTN]] |
optional |
Provider Organization Communication Information: Item #2259 |
|
|
PRD.14 |
Optional[CWE] |
optional |
Provider Organization Method of Contact: Item #2260 | Table HL70185 |
- class hl7types.hl7.v2_8_2.segments.PRT.PRT
HL7 v2 PRT segment.
PRT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRT.1 |
Optional[EI] |
optional |
Participation Instance ID: Item #2379 |
|
|
PRT.2 |
str |
required |
Action Code: Item #816 | Table HL70206 |
|
|
PRT.3 |
Optional[CWE] |
optional |
Action Reason: Item #2380 |
|
|
PRT.4 |
required |
Participation: Item #2381 | Table HL70912 |
||
|
PRT.5 |
Optional[List[XCN]] |
optional |
Participation Person: Item #2382 |
|
|
PRT.6 |
Optional[CWE] |
optional |
Participation Person Provider Type: Item #2383 |
|
|
PRT.7 |
Optional[CWE] |
optional |
Participant Organization Unit Type: Item #2384 | Table HL70406 |
|
|
PRT.8 |
Optional[List[XON]] |
optional |
Participation Organization: Item #2385 |
|
|
PRT.9 |
Optional[List[PL]] |
optional |
Participant Location: Item #2386 |
|
|
PRT.10 |
Optional[List[EI]] |
optional |
Participation Device: Item #2348 |
|
|
PRT.11 |
Optional[str] |
optional |
Participation Begin Date/Time (arrival time): Item #2387 |
|
|
PRT.12 |
Optional[str] |
optional |
Participation End Date/Time (departure time): Item #2388 |
|
|
PRT.13 |
Optional[CWE] |
optional |
Participation Qualitative Duration: Item #2389 |
|
|
PRT.14 |
Optional[List[XAD]] |
optional |
Participation Address: Item #2390 |
|
|
PRT.15 |
Optional[List[XTN]] |
optional |
Participant Telecommunication Address: Item #2391 |
|
|
PRT.16 |
Optional[EI] |
optional |
Participant Device Identifier: Item #3476 |
|
|
PRT.17 |
Optional[str] |
optional |
Participant Device Manufacture Date: Item #3477 |
|
|
PRT.18 |
Optional[str] |
optional |
Participant Device Expiry Date: Item #3478 |
|
|
PRT.19 |
Optional[str] |
optional |
Participant Device Lot Number: Item #3479 |
|
|
PRT.20 |
Optional[str] |
optional |
Participant Device Serial Number: Item #3480 |
|
|
PRT.21 |
Optional[EI] |
optional |
Participant Device Donation Identification: Item #3481 |
|
|
PRT.22 |
Optional[CNE] |
optional |
Participation Device Type: Item #3483 |
- class hl7types.hl7.v2_8_2.segments.PSG.PSG
HL7 v2 PSG segment.
PSG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PSG.1 |
required |
Provider Product/Service Group Number: Item #1950 |
||
|
PSG.2 |
Optional[EI] |
optional |
Payer Product/Service Group Number: Item #1951 |
|
|
PSG.3 |
str |
required |
Product/Service Group Sequence Number: Item #1952 |
|
|
PSG.4 |
str |
required |
Adjudicate as Group: Item #1953 | Table HL70136 |
|
|
PSG.5 |
required |
Product/Service Group Billed Amount: Item #1954 |
||
|
PSG.6 |
str |
required |
Product/Service Group Description: Item #2044 |
- class hl7types.hl7.v2_8_2.segments.PSH.PSH
HL7 v2 PSH segment.
PSH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PSH.1 |
str |
required |
Report Type: Item #1233 |
|
|
PSH.2 |
Optional[str] |
optional |
Report Form Identifier: Item #1297 |
|
|
PSH.3 |
str |
required |
Report Date: Item #1235 |
|
|
PSH.4 |
Optional[str] |
optional |
Report Interval Start Date: Item #1236 |
|
|
PSH.5 |
Optional[str] |
optional |
Report Interval End Date: Item #1237 |
|
|
PSH.6 |
Optional[CQ] |
optional |
Quantity Manufactured: Item #1238 |
|
|
PSH.7 |
Optional[CQ] |
optional |
Quantity Distributed: Item #1239 |
|
|
PSH.8 |
Optional[str] |
optional |
Quantity Distributed Method: Item #1240 | Table HL70329 |
|
|
PSH.9 |
Optional[FT] |
optional |
Quantity Distributed Comment: Item #1241 |
|
|
PSH.10 |
Optional[CQ] |
optional |
Quantity in Use: Item #1242 |
|
|
PSH.11 |
Optional[str] |
optional |
Quantity in Use Method: Item #1243 | Table HL70329 |
|
|
PSH.12 |
Optional[FT] |
optional |
Quantity in Use Comment: Item #1244 |
|
|
PSH.13 |
Optional[List[str]] |
optional |
Number of Product Experience Reports Filed by Facility: Item #1245 |
|
|
PSH.14 |
Optional[List[str]] |
optional |
Number of Product Experience Reports Filed by Distributor: Item #1246 |
- class hl7types.hl7.v2_8_2.segments.PSL.PSL
HL7 v2 PSL segment.
PSL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PSL.1 |
required |
Provider Product/Service Line Item Number: Item #1955 |
||
|
PSL.2 |
Optional[EI] |
optional |
Payer Product/Service Line Item Number: Item #1956 |
|
|
PSL.3 |
str |
required |
Product/Service Line Item Sequence Number: Item #1957 |
|
|
PSL.4 |
Optional[EI] |
optional |
Provider Tracking ID: Item #1958 |
|
|
PSL.5 |
Optional[EI] |
optional |
Payer Tracking ID: Item #1959 |
|
|
PSL.6 |
required |
Product/Service Line Item Status: Item #1960 | Table HL70559 |
||
|
PSL.7 |
required |
Product/Service Code: Item #1961 | Table HL70879 |
||
|
PSL.8 |
Optional[List[CWE]] |
optional |
Product/Service Code Modifier: Item #1962 | Table HL70880 |
|
|
PSL.9 |
Optional[str] |
optional |
Product/Service Code Description: Item #1963 |
|
|
PSL.10 |
Optional[str] |
optional |
Product/Service Effective Date: Item #1964 |
|
|
PSL.11 |
Optional[str] |
optional |
Product/Service Expiration Date: Item #1965 |
|
|
PSL.12 |
Optional[CQ] |
optional |
Product/Service Quantity: Item #1966 | Table HL70560 |
|
|
PSL.13 |
Optional[CP] |
optional |
Product/Service Unit Cost: Item #1967 |
|
|
PSL.14 |
Optional[str] |
optional |
Number of Items per Unit: Item #1968 |
|
|
PSL.15 |
Optional[CP] |
optional |
Product/Service Gross Amount: Item #1969 |
|
|
PSL.16 |
Optional[CP] |
optional |
Product/Service Billed Amount: Item #1970 |
|
|
PSL.17 |
Optional[List[CWE]] |
optional |
Product/Service Clarification Code Type: Item #1971 | Table HL70561 |
|
|
PSL.18 |
Optional[List[str]] |
optional |
Product/Service Clarification Code Value: Item #1972 |
|
|
PSL.19 |
Optional[List[EI]] |
optional |
Health Document Reference Identifier: Item #1973 |
|
|
PSL.20 |
Optional[List[CWE]] |
optional |
Processing Consideration Code: Item #1974 | Table HL70562 |
|
|
PSL.21 |
str |
required |
Restricted Disclosure Indicator: Item #1975 | Table HL70532 |
|
|
PSL.22 |
Optional[CWE] |
optional |
Related Product/Service Code Indicator: Item #1976 | Table HL70879 |
|
|
PSL.23 |
Optional[CP] |
optional |
Product/Service Amount for Physician: Item #1977 |
|
|
PSL.24 |
Optional[str] |
optional |
Product/Service Cost Factor: Item #1978 |
|
|
PSL.25 |
Optional[CX] |
optional |
Cost Center: Item #1933 |
|
|
PSL.26 |
Optional[DR] |
optional |
Billing Period: Item #1980 |
|
|
PSL.27 |
Optional[str] |
optional |
Days without Billing: Item #1981 |
|
|
PSL.28 |
Optional[str] |
optional |
Session-No: Item #1982 |
|
|
PSL.29 |
Optional[XCN] |
optional |
Executing Physician ID: Item #1983 |
|
|
PSL.30 |
Optional[XCN] |
optional |
Responsible Physician ID: Item #1984 |
|
|
PSL.31 |
Optional[CWE] |
optional |
Role Executing Physician: Item #1985 | Table HL70881 |
|
|
PSL.32 |
Optional[CWE] |
optional |
Medical Role Executing Physician: Item #1986 | Table HL70882 |
|
|
PSL.33 |
Optional[CWE] |
optional |
Side of body: Item #1987 | Table HL70894 |
|
|
PSL.34 |
Optional[str] |
optional |
Number of TP’s PP: Item #1988 |
|
|
PSL.35 |
Optional[CP] |
optional |
TP-Value PP: Item #1989 |
|
|
PSL.36 |
Optional[str] |
optional |
Internal Scaling Factor PP: Item #1990 |
|
|
PSL.37 |
Optional[str] |
optional |
External Scaling Factor PP: Item #1991 |
|
|
PSL.38 |
Optional[CP] |
optional |
Amount PP: Item #1992 |
|
|
PSL.39 |
Optional[str] |
optional |
Number of TP’s Technical Part: Item #1993 |
|
|
PSL.40 |
Optional[CP] |
optional |
TP-Value Technical Part: Item #1994 |
|
|
PSL.41 |
Optional[str] |
optional |
Internal Scaling Factor Technical Part: Item #1995 |
|
|
PSL.42 |
Optional[str] |
optional |
External Scaling Factor Technical Part: Item #1996 |
|
|
PSL.43 |
Optional[CP] |
optional |
Amount Technical Part: Item #1997 |
|
|
PSL.44 |
Optional[CP] |
optional |
Total Amount Professional Part + Technical Part: Item #1998 |
|
|
PSL.45 |
Optional[str] |
optional |
VAT-Rate: Item #1999 |
|
|
PSL.46 |
Optional[str] |
optional |
Main-Service: Item #2000 |
|
|
PSL.47 |
Optional[str] |
optional |
Validation: Item #2001 | Table HL70136 |
|
|
PSL.48 |
Optional[str] |
optional |
Comment: Item #2002 |
- class hl7types.hl7.v2_8_2.segments.PSS.PSS
HL7 v2 PSS segment.
PSS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PSS.1 |
required |
Provider Product/Service Section Number: Item #1946 |
||
|
PSS.2 |
Optional[EI] |
optional |
Payer Product/Service Section Number: Item #1947 |
|
|
PSS.3 |
str |
required |
Product/Service Section Sequence Number: Item #1948 |
|
|
PSS.4 |
required |
Billed Amount: Item #1949 |
||
|
PSS.5 |
str |
required |
Section Description or Heading: Item #2043 |
- class hl7types.hl7.v2_8_2.segments.PTH.PTH
HL7 v2 PTH segment.
PTH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PTH.1 |
str |
required |
Action Code: Item #816 | Table HL70206 |
|
|
PTH.2 |
required |
Pathway ID: Item #1207 |
||
|
PTH.3 |
required |
Pathway Instance ID: Item #1208 |
||
|
PTH.4 |
str |
required |
Pathway Established Date/Time: Item #1209 |
|
|
PTH.5 |
Optional[CWE] |
optional |
Pathway Life Cycle Status: Item #1210 |
|
|
PTH.6 |
Optional[str] |
optional |
Change Pathway Life Cycle Status Date/Time: Item #1211 |
|
|
PTH.7 |
Optional[CNE] |
optional |
Mood Code: Item #2239 | Table HL70725 |
- class hl7types.hl7.v2_8_2.segments.PV1.PV1
HL7 v2 PV1 segment.
PV1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PV1.1 |
Optional[str] |
optional |
Set ID - PV1: Item #131 |
|
|
PV1.2 |
required |
Patient Class: Item #132 | Table HL70004 |
||
|
PV1.3 |
Optional[PL] |
optional |
Assigned Patient Location: Item #133 |
|
|
PV1.4 |
Optional[CWE] |
optional |
Admission Type: Item #134 | Table HL70007 |
|
|
PV1.5 |
Optional[CX] |
optional |
Preadmit Number: Item #135 |
|
|
PV1.6 |
Optional[PL] |
optional |
Prior Patient Location: Item #136 |
|
|
PV1.7 |
Optional[List[XCN]] |
optional |
Attending Doctor: Item #137 | Table HL70010 |
|
|
PV1.8 |
Optional[List[XCN]] |
optional |
Referring Doctor: Item #138 | Table HL70010 |
|
|
PV1.9 |
Optional[List[XCN]] |
optional |
Consulting Doctor: Item #139 |
|
|
PV1.10 |
Optional[CWE] |
optional |
Hospital Service: Item #140 | Table HL70069 |
|
|
PV1.11 |
Optional[PL] |
optional |
Temporary Location: Item #141 |
|
|
PV1.12 |
Optional[CWE] |
optional |
Preadmit Test Indicator: Item #142 | Table HL70087 |
|
|
PV1.13 |
Optional[CWE] |
optional |
Re-admission Indicator: Item #143 | Table HL70092 |
|
|
PV1.14 |
Optional[CWE] |
optional |
Admit Source: Item #144 | Table HL70023 |
|
|
PV1.15 |
Optional[List[CWE]] |
optional |
Ambulatory Status: Item #145 | Table HL70009 |
|
|
PV1.16 |
Optional[CWE] |
optional |
VIP Indicator: Item #146 | Table HL70099 |
|
|
PV1.17 |
Optional[List[XCN]] |
optional |
Admitting Doctor: Item #147 | Table HL70010 |
|
|
PV1.18 |
Optional[CWE] |
optional |
Patient Type: Item #148 | Table HL70018 |
|
|
PV1.19 |
Optional[CX] |
optional |
Visit Number: Item #149 |
|
|
PV1.20 |
Optional[List[FC]] |
optional |
Financial Class: Item #150 | Table HL70064 |
|
|
PV1.21 |
Optional[CWE] |
optional |
Charge Price Indicator: Item #151 | Table HL70032 |
|
|
PV1.22 |
Optional[CWE] |
optional |
Courtesy Code: Item #152 | Table HL70045 |
|
|
PV1.23 |
Optional[CWE] |
optional |
Credit Rating: Item #153 | Table HL70046 |
|
|
PV1.24 |
Optional[List[CWE]] |
optional |
Contract Code: Item #154 | Table HL70044 |
|
|
PV1.25 |
Optional[List[str]] |
optional |
Contract Effective Date: Item #155 |
|
|
PV1.26 |
Optional[List[str]] |
optional |
Contract Amount: Item #156 |
|
|
PV1.27 |
Optional[List[str]] |
optional |
Contract Period: Item #157 |
|
|
PV1.28 |
Optional[CWE] |
optional |
Interest Code: Item #158 | Table HL70073 |
|
|
PV1.29 |
Optional[CWE] |
optional |
Transfer to Bad Debt Code: Item #159 | Table HL70110 |
|
|
PV1.30 |
Optional[str] |
optional |
Transfer to Bad Debt Date: Item #160 |
|
|
PV1.31 |
Optional[CWE] |
optional |
Bad Debt Agency Code: Item #161 | Table HL70021 |
|
|
PV1.32 |
Optional[str] |
optional |
Bad Debt Transfer Amount: Item #162 |
|
|
PV1.33 |
Optional[str] |
optional |
Bad Debt Recovery Amount: Item #163 |
|
|
PV1.34 |
Optional[CWE] |
optional |
Delete Account Indicator: Item #164 | Table HL70111 |
|
|
PV1.35 |
Optional[str] |
optional |
Delete Account Date: Item #165 |
|
|
PV1.36 |
Optional[CWE] |
optional |
Discharge Disposition: Item #166 | Table HL70112 |
|
|
PV1.37 |
Optional[DLD] |
optional |
Discharged to Location: Item #167 | Table HL70113 |
|
|
PV1.38 |
Optional[CWE] |
optional |
Diet Type: Item #168 | Table HL70114 |
|
|
PV1.39 |
Optional[CWE] |
optional |
Servicing Facility: Item #169 | Table HL70115 |
|
|
PV1.41 |
Optional[CWE] |
optional |
Account Status: Item #171 | Table HL70117 |
|
|
PV1.42 |
Optional[PL] |
optional |
Pending Location: Item #172 |
|
|
PV1.43 |
Optional[PL] |
optional |
Prior Temporary Location: Item #173 |
|
|
PV1.44 |
Optional[str] |
optional |
Admit Date/Time: Item #174 |
|
|
PV1.45 |
Optional[str] |
optional |
Discharge Date/Time: Item #175 |
|
|
PV1.46 |
Optional[str] |
optional |
Current Patient Balance: Item #176 |
|
|
PV1.47 |
Optional[str] |
optional |
Total Charges: Item #177 |
|
|
PV1.48 |
Optional[str] |
optional |
Total Adjustments: Item #178 |
|
|
PV1.49 |
Optional[str] |
optional |
Total Payments: Item #179 |
|
|
PV1.50 |
Optional[List[CX]] |
optional |
Alternate Visit ID: Item #180 | Table HL70203 |
|
|
PV1.51 |
Optional[CWE] |
optional |
Visit Indicator: Item #1226 | Table HL70326 |
|
|
PV1.53 |
Optional[str] |
optional |
Service Episode Description: Item #2290 |
|
|
PV1.54 |
Optional[CX] |
optional |
Service Episode Identifier: Item #2291 |
- class hl7types.hl7.v2_8_2.segments.PV2.PV2
HL7 v2 PV2 segment.
PV2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PV2.1 |
Optional[PL] |
optional |
Prior Pending Location: Item #181 |
|
|
PV2.2 |
Optional[CWE] |
optional |
Accommodation Code: Item #182 | Table HL70129 |
|
|
PV2.3 |
Optional[CWE] |
optional |
Admit Reason: Item #183 |
|
|
PV2.4 |
Optional[CWE] |
optional |
Transfer Reason: Item #184 |
|
|
PV2.5 |
Optional[List[str]] |
optional |
Patient Valuables: Item #185 |
|
|
PV2.6 |
Optional[str] |
optional |
Patient Valuables Location: Item #186 |
|
|
PV2.7 |
Optional[List[CWE]] |
optional |
Visit User Code: Item #187 | Table HL70130 |
|
|
PV2.8 |
Optional[str] |
optional |
Expected Admit Date/Time: Item #188 |
|
|
PV2.9 |
Optional[str] |
optional |
Expected Discharge Date/Time: Item #189 |
|
|
PV2.10 |
Optional[str] |
optional |
Estimated Length of Inpatient Stay: Item #711 |
|
|
PV2.11 |
Optional[str] |
optional |
Actual Length of Inpatient Stay: Item #712 |
|
|
PV2.12 |
Optional[str] |
optional |
Visit Description: Item #713 |
|
|
PV2.13 |
Optional[List[XCN]] |
optional |
Referral Source Code: Item #714 |
|
|
PV2.14 |
Optional[str] |
optional |
Previous Service Date: Item #715 |
|
|
PV2.15 |
Optional[str] |
optional |
Employment Illness Related Indicator: Item #716 | Table HL70136 |
|
|
PV2.16 |
Optional[CWE] |
optional |
Purge Status Code: Item #717 | Table HL70213 |
|
|
PV2.17 |
Optional[str] |
optional |
Purge Status Date: Item #718 |
|
|
PV2.18 |
Optional[CWE] |
optional |
Special Program Code: Item #719 | Table HL70214 |
|
|
PV2.19 |
Optional[str] |
optional |
Retention Indicator: Item #720 | Table HL70136 |
|
|
PV2.20 |
Optional[str] |
optional |
Expected Number of Insurance Plans: Item #721 |
|
|
PV2.21 |
Optional[CWE] |
optional |
Visit Publicity Code: Item #722 | Table HL70215 |
|
|
PV2.22 |
Optional[str] |
optional |
Visit Protection Indicator: Item #723 | Table HL70136 |
|
|
PV2.23 |
Optional[List[XON]] |
optional |
Clinic Organization Name: Item #724 |
|
|
PV2.24 |
Optional[CWE] |
optional |
Patient Status Code: Item #725 | Table HL70216 |
|
|
PV2.25 |
Optional[CWE] |
optional |
Visit Priority Code: Item #726 | Table HL70217 |
|
|
PV2.26 |
Optional[str] |
optional |
Previous Treatment Date: Item #727 |
|
|
PV2.27 |
Optional[CWE] |
optional |
Expected Discharge Disposition: Item #728 | Table HL70112 |
|
|
PV2.28 |
Optional[str] |
optional |
Signature on File Date: Item #729 |
|
|
PV2.29 |
Optional[str] |
optional |
First Similar Illness Date: Item #730 |
|
|
PV2.30 |
Optional[CWE] |
optional |
Patient Charge Adjustment Code: Item #731 | Table HL70218 |
|
|
PV2.31 |
Optional[CWE] |
optional |
Recurring Service Code: Item #732 | Table HL70219 |
|
|
PV2.32 |
Optional[str] |
optional |
Billing Media Code: Item #733 | Table HL70136 |
|
|
PV2.33 |
Optional[str] |
optional |
Expected Surgery Date and Time: Item #734 |
|
|
PV2.34 |
Optional[str] |
optional |
Military Partnership Code: Item #735 | Table HL70136 |
|
|
PV2.35 |
Optional[str] |
optional |
Military Non-Availability Code: Item #736 | Table HL70136 |
|
|
PV2.36 |
Optional[str] |
optional |
Newborn Baby Indicator: Item #737 | Table HL70136 |
|
|
PV2.37 |
Optional[str] |
optional |
Baby Detained Indicator: Item #738 | Table HL70136 |
|
|
PV2.38 |
Optional[CWE] |
optional |
Mode of Arrival Code: Item #1543 | Table HL70430 |
|
|
PV2.39 |
Optional[List[CWE]] |
optional |
Recreational Drug Use Code: Item #1544 | Table HL70431 |
|
|
PV2.40 |
Optional[CWE] |
optional |
Admission Level of Care Code: Item #1545 | Table HL70432 |
|
|
PV2.41 |
Optional[List[CWE]] |
optional |
Precaution Code: Item #1546 | Table HL70433 |
|
|
PV2.42 |
Optional[CWE] |
optional |
Patient Condition Code: Item #1547 | Table HL70434 |
|
|
PV2.43 |
Optional[CWE] |
optional |
Living Will Code: Item #759 | Table HL70315 |
|
|
PV2.44 |
Optional[CWE] |
optional |
Organ Donor Code: Item #760 | Table HL70316 |
|
|
PV2.45 |
Optional[List[CWE]] |
optional |
Advance Directive Code: Item #1548 | Table HL70435 |
|
|
PV2.46 |
Optional[str] |
optional |
Patient Status Effective Date: Item #1549 |
|
|
PV2.47 |
Optional[str] |
optional |
Expected LOA Return Date/Time: Item #1550 |
|
|
PV2.48 |
Optional[str] |
optional |
Expected Pre-admission Testing Date/Time: Item #1841 |
|
|
PV2.49 |
Optional[List[CWE]] |
optional |
Notify Clergy Code: Item #1842 | Table HL70534 |
|
|
PV2.50 |
Optional[str] |
optional |
Advance Directive Last Verified Date: Item #2141 |
- class hl7types.hl7.v2_8_2.segments.PYE.PYE
HL7 v2 PYE segment.
PYE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PYE.1 |
str |
required |
Set ID - PYE: Item #1939 |
|
|
PYE.2 |
required |
Payee Type: Item #1940 | Table HL70557 |
||
|
PYE.3 |
Optional[CWE] |
optional |
Payee Relationship to Invoice (Patient): Item #1941 | Table HL70558 |
|
|
PYE.4 |
Optional[List[XON]] |
optional |
Payee Identification List: Item #1942 |
|
|
PYE.5 |
Optional[List[XPN]] |
optional |
Payee Person Name: Item #1943 |
|
|
PYE.6 |
Optional[List[XAD]] |
optional |
Payee Address: Item #1944 |
|
|
PYE.7 |
Optional[CWE] |
optional |
Payment Method: Item #1945 | Table HL70570 |
- class hl7types.hl7.v2_8_2.segments.QAK.QAK
HL7 v2 QAK segment.
QAK¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QAK.1 |
Optional[str] |
optional |
Query Tag: Item #696 |
|
|
QAK.2 |
Optional[str] |
optional |
Query Response Status: Item #708 | Table HL70208 |
|
|
QAK.3 |
Optional[CWE] |
optional |
Message Query Name: Item #1375 | Table HL70471 |
|
|
QAK.4 |
Optional[str] |
optional |
Hit Count Total: Item #1434 |
|
|
QAK.5 |
Optional[str] |
optional |
This payload: Item #1622 |
|
|
QAK.6 |
Optional[str] |
optional |
Hits remaining: Item #1623 |
- class hl7types.hl7.v2_8_2.segments.QID.QID
HL7 v2 QID segment.
QID¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QID.1 |
str |
required |
Query Tag: Item #696 |
|
|
QID.2 |
required |
Message Query Name: Item #1375 | Table HL70471 |
- class hl7types.hl7.v2_8_2.segments.QPD.QPD
HL7 v2 QPD segment.
QPD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QPD.1 |
required |
Message Query Name: Item #1375 | Table HL70471 |
||
|
QPD.2 |
Optional[str] |
optional |
Query Tag: Item #696 |
|
|
QPD.3 |
Optional[varies] |
optional |
User Parameters (in successive fields): Item #1435 |
- class hl7types.hl7.v2_8_2.segments.QRI.QRI
HL7 v2 QRI segment.
QRI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QRI.1 |
Optional[str] |
optional |
Candidate Confidence: Item #1436 |
|
|
QRI.2 |
Optional[List[CWE]] |
optional |
Match Reason Code: Item #1437 | Table HL70392 |
|
|
QRI.3 |
Optional[CWE] |
optional |
Algorithm Descriptor: Item #1438 | Table HL70393 |
- class hl7types.hl7.v2_8_2.segments.RCP.RCP
HL7 v2 RCP segment.
RCP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RCP.1 |
Optional[str] |
optional |
Query Priority: Item #27 | Table HL70091 |
|
|
RCP.2 |
Optional[CQ] |
optional |
Quantity Limited Request: Item #31 | Table HL70126 |
|
|
RCP.3 |
Optional[CNE] |
optional |
Response Modality: Item #1440 | Table HL70394 |
|
|
RCP.4 |
Optional[str] |
optional |
Execution and Delivery Time: Item #1441 |
|
|
RCP.5 |
Optional[str] |
optional |
Modify Indicator: Item #1443 | Table HL70395 |
|
|
RCP.6 |
Optional[List[SRT]] |
optional |
Sort-by Field: Item #1624 |
|
|
RCP.7 |
Optional[List[str]] |
optional |
Segment group inclusion: Item #1594 | Table HL70391 |
- class hl7types.hl7.v2_8_2.segments.RDF.RDF
HL7 v2 RDF segment.
RDF¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RDF.1 |
str |
required |
Number of Columns per Row: Item #701 |
|
|
RDF.2 |
Optional[List[RCD]] |
optional |
Column Description: Item #702 | Table HL70440 |
- class hl7types.hl7.v2_8_2.segments.RDT.RDT
HL7 v2 RDT segment.
RDT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RDT.1 |
varies |
required |
Column Value: Item #703 |
- class hl7types.hl7.v2_8_2.segments.REL.REL
HL7 v2 REL segment.
REL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
REL.1 |
Optional[str] |
optional |
Set ID -REL: Item #2240 |
|
|
REL.2 |
required |
Relationship Type: Item #2241 |
||
|
REL.3 |
required |
This Relationship Instance Identifier: Item #2242 |
||
|
REL.4 |
required |
Source Information Instance Identifier: Item #2243 |
||
|
REL.5 |
required |
Target Information Instance Identifier: Item #2244 |
||
|
REL.6 |
Optional[EI] |
optional |
Asserting Entity Instance ID: Item #2245 |
|
|
REL.7 |
Optional[XCN] |
optional |
Asserting Person: Item #2246 |
|
|
REL.8 |
Optional[XON] |
optional |
Asserting Organization: Item #2247 |
|
|
REL.9 |
Optional[XAD] |
optional |
Assertor Address: Item #2248 |
|
|
REL.10 |
Optional[XTN] |
optional |
Assertor Contact: Item #2249 |
|
|
REL.11 |
Optional[DR] |
optional |
Assertion Date Range: Item #2250 |
|
|
REL.12 |
Optional[str] |
optional |
Negation Indicator: Item #2251 | Table HL70136 |
|
|
REL.13 |
Optional[CWE] |
optional |
Certainty of Relationship: Item #2252 |
|
|
REL.14 |
Optional[str] |
optional |
Priority No: Item #2253 |
|
|
REL.15 |
Optional[str] |
optional |
Priority Sequence No (rel preference for consideration): Item #2254 |
|
|
REL.16 |
Optional[str] |
optional |
Separability Indicator: Item #2255 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.RF1.RF1
HL7 v2 RF1 segment.
RF1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RF1.1 |
Optional[CWE] |
optional |
Referral Status: Item #1137 | Table HL70283 |
|
|
RF1.2 |
Optional[CWE] |
optional |
Referral Priority: Item #1138 | Table HL70280 |
|
|
RF1.3 |
Optional[CWE] |
optional |
Referral Type: Item #1139 | Table HL70281 |
|
|
RF1.4 |
Optional[List[CWE]] |
optional |
Referral Disposition: Item #1140 | Table HL70282 |
|
|
RF1.5 |
Optional[CWE] |
optional |
Referral Category: Item #1141 | Table HL70284 |
|
|
RF1.6 |
required |
Originating Referral Identifier: Item #1142 |
||
|
RF1.7 |
Optional[str] |
optional |
Effective Date: Item #1143 |
|
|
RF1.8 |
Optional[str] |
optional |
Expiration Date: Item #1144 |
|
|
RF1.9 |
Optional[str] |
optional |
Process Date: Item #1145 |
|
|
RF1.10 |
Optional[List[CWE]] |
optional |
Referral Reason: Item #1228 | Table HL70336 |
|
|
RF1.11 |
Optional[List[EI]] |
optional |
External Referral Identifier: Item #1300 |
|
|
RF1.12 |
Optional[CWE] |
optional |
Referral Documentation Completion Status: Item #2262 | Table HL70865 |
|
|
RF1.13 |
Optional[str] |
optional |
Planned Treatment Stop Date: Item #3400 |
|
|
RF1.14 |
Optional[str] |
optional |
Referral Reason Text: Item #3401 |
|
|
RF1.15 |
Optional[CQ] |
optional |
Number of Authorized Treatments/Units: Item #3402 |
|
|
RF1.16 |
Optional[CQ] |
optional |
Number of Used Treatments/Units: Item #3403 |
|
|
RF1.17 |
Optional[CQ] |
optional |
Number of Schedule Treatments/Units: Item #3404 |
|
|
RF1.18 |
Optional[MO] |
optional |
Remaining Benefit Amount: Item #3405 |
|
|
RF1.19 |
Optional[XON] |
optional |
Authorized Provider: Item #3406 |
|
|
RF1.20 |
Optional[XCN] |
optional |
Authorized Health Professional: Item #3407 |
|
|
RF1.21 |
Optional[str] |
optional |
Source Text: Item #3408 |
|
|
RF1.22 |
Optional[str] |
optional |
Source Date: Item #3409 |
|
|
RF1.23 |
Optional[XTN] |
optional |
Source Phone: Item #3410 |
|
|
RF1.24 |
Optional[str] |
optional |
Comment: Item #3411 |
|
|
RF1.25 |
Optional[str] |
optional |
Action Code: Item #3412 | Table HL70206 |
- class hl7types.hl7.v2_8_2.segments.RFI.RFI
HL7 v2 RFI segment.
RFI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RFI.1 |
str |
required |
Request Date: Item #1910 |
|
|
RFI.2 |
str |
required |
Response Due Date: Item #1911 |
|
|
RFI.3 |
Optional[str] |
optional |
Patient Consent: Item #1912 | Table HL70136 |
|
|
RFI.4 |
Optional[str] |
optional |
Date Additional Information Was Submitted: Item #1913 |
- class hl7types.hl7.v2_8_2.segments.RGS.RGS
HL7 v2 RGS segment.
RGS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RGS.1 |
str |
required |
Set ID - RGS: Item #1203 |
|
|
RGS.2 |
Optional[str] |
optional |
Segment Action Code: Item #763 | Table HL70206 |
|
|
RGS.3 |
Optional[CWE] |
optional |
Resource Group ID: Item #1204 |
- class hl7types.hl7.v2_8_2.segments.RMI.RMI
HL7 v2 RMI segment.
RMI¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RMI.1 |
Optional[CWE] |
optional |
Risk Management Incident Code: Item #1530 | Table HL70427 |
|
|
RMI.2 |
Optional[str] |
optional |
Date/Time Incident: Item #1531 |
|
|
RMI.3 |
Optional[CWE] |
optional |
Incident Type Code: Item #1533 | Table HL70428 |
- class hl7types.hl7.v2_8_2.segments.ROL.ROL
HL7 v2 ROL segment.
ROL¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ROL.1 |
Optional[EI] |
optional |
Role Instance ID: Item #1206 |
|
|
ROL.2 |
str |
required |
Action Code: Item #816 | Table HL70206 |
|
|
ROL.3 |
required |
Role-ROL: Item #1197 | Table HL70443 |
||
|
ROL.4 |
Optional[List[XCN]] |
optional |
Role Person: Item #1198 |
|
|
ROL.5 |
Optional[str] |
optional |
Role Begin Date/Time: Item #1199 |
|
|
ROL.6 |
Optional[str] |
optional |
Role End Date/Time: Item #1200 |
|
|
ROL.7 |
Optional[CWE] |
optional |
Role Duration: Item #1201 |
|
|
ROL.8 |
Optional[CWE] |
optional |
Role Action Reason: Item #1205 |
|
|
ROL.9 |
Optional[List[CWE]] |
optional |
Provider Type: Item #1510 |
|
|
ROL.10 |
Optional[CWE] |
optional |
Organization Unit Type: Item #1461 | Table HL70406 |
|
|
ROL.11 |
Optional[List[XAD]] |
optional |
Office/Home Address/Birthplace: Item #679 |
|
|
ROL.12 |
Optional[List[XTN]] |
optional |
Phone: Item #678 |
|
|
ROL.13 |
Optional[PL] |
optional |
Person’s Location: Item #2183 |
|
|
ROL.14 |
Optional[XON] |
optional |
Organization: Item #2377 |
- class hl7types.hl7.v2_8_2.segments.RQ1.RQ1
HL7 v2 RQ1 segment.
RQ1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RQ1.1 |
Optional[str] |
optional |
Anticipated Price: Item #285 |
|
|
RQ1.2 |
Optional[CWE] |
optional |
Manufacturer Identifier: Item #286 | Table HL70385 |
|
|
RQ1.3 |
Optional[str] |
optional |
Manufacturer’s Catalog: Item #287 |
|
|
RQ1.4 |
Optional[CWE] |
optional |
Vendor ID: Item #288 | Table HL79999 |
|
|
RQ1.5 |
Optional[str] |
optional |
Vendor Catalog: Item #289 |
|
|
RQ1.6 |
Optional[str] |
optional |
Taxable: Item #290 | Table HL70136 |
|
|
RQ1.7 |
Optional[str] |
optional |
Substitute Allowed: Item #291 | Table HL70136 |
- class hl7types.hl7.v2_8_2.segments.RQD.RQD
HL7 v2 RQD segment.
RQD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RQD.1 |
Optional[str] |
optional |
Requisition Line Number: Item #275 |
|
|
RQD.2 |
Optional[CWE] |
optional |
Item Code - Internal: Item #276 | Table HL79999 |
|
|
RQD.3 |
Optional[CWE] |
optional |
Item Code - External: Item #277 | Table HL79999 |
|
|
RQD.4 |
Optional[CWE] |
optional |
Hospital Item Code: Item #278 | Table HL79999 |
|
|
RQD.5 |
Optional[str] |
optional |
Requisition Quantity: Item #279 |
|
|
RQD.6 |
Optional[CWE] |
optional |
Requisition Unit of Measure: Item #280 | Table HL79999 |
|
|
RQD.7 |
Optional[CX] |
optional |
Cost Center Account Number: Item #281 | Table HL70319 |
|
|
RQD.8 |
Optional[CWE] |
optional |
Item Natural Account Code: Item #282 | Table HL70320 |
|
|
RQD.9 |
Optional[CWE] |
optional |
Deliver To ID: Item #283 | Table HL79999 |
|
|
RQD.10 |
Optional[str] |
optional |
Date Needed: Item #284 |
- class hl7types.hl7.v2_8_2.segments.RXA.RXA
HL7 v2 RXA segment.
RXA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXA.1 |
str |
required |
Give Sub-ID Counter: Item #342 |
|
|
RXA.2 |
str |
required |
Administration Sub-ID Counter: Item #344 |
|
|
RXA.3 |
str |
required |
Date/Time Start of Administration: Item #345 |
|
|
RXA.4 |
str |
required |
Date/Time End of Administration: Item #346 |
|
|
RXA.5 |
required |
Administered Code: Item #347 | Table HL70292 |
||
|
RXA.6 |
str |
required |
Administered Amount: Item #348 |
|
|
RXA.7 |
Optional[CWE] |
optional |
Administered Units: Item #349 | Table HL79999 |
|
|
RXA.8 |
Optional[CWE] |
optional |
Administered Dosage Form: Item #350 | Table HL79999 |
|
|
RXA.9 |
Optional[List[CWE]] |
optional |
Administration Notes: Item #351 | Table HL79999 |
|
|
RXA.10 |
Optional[List[XCN]] |
optional |
Administering Provider: Item #352 |
|
|
RXA.12 |
Optional[str] |
optional |
Administered Per (Time Unit): Item #354 |
|
|
RXA.13 |
Optional[str] |
optional |
Administered Strength: Item #1134 |
|
|
RXA.14 |
Optional[CWE] |
optional |
Administered Strength Units: Item #1135 | Table HL79999 |
|
|
RXA.15 |
Optional[List[str]] |
optional |
Substance Lot Number: Item #1129 |
|
|
RXA.16 |
Optional[List[str]] |
optional |
Substance Expiration Date: Item #1130 |
|
|
RXA.17 |
Optional[List[CWE]] |
optional |
Substance Manufacturer Name: Item #1131 |
|
|
RXA.18 |
Optional[List[CWE]] |
optional |
Substance/Treatment Refusal Reason: Item #1136 | Table HL79999 |
|
|
RXA.19 |
Optional[List[CWE]] |
optional |
Indication: Item #1123 | Table HL79999 |
|
|
RXA.20 |
Optional[str] |
optional |
Completion Status: Item #1223 | Table HL70322 |
|
|
RXA.21 |
Optional[str] |
optional |
Action Code - RXA: Item #1224 | Table HL70206 |
|
|
RXA.22 |
Optional[str] |
optional |
System Entry Date/Time: Item #1225 |
|
|
RXA.23 |
Optional[str] |
optional |
Administered Drug Strength Volume: Item #1696 |
|
|
RXA.24 |
Optional[CWE] |
optional |
Administered Drug Strength Volume Units: Item #1697 | Table HL79999 |
|
|
RXA.25 |
Optional[CWE] |
optional |
Administered Barcode Identifier: Item #1698 | Table HL79999 |
|
|
RXA.26 |
Optional[str] |
optional |
Pharmacy Order Type: Item #1699 | Table HL70480 |
|
|
RXA.27 |
Optional[PL] |
optional |
Administer-at: Item #2264 |
|
|
RXA.28 |
Optional[XAD] |
optional |
Administered-at Address: Item #2265 |
|
|
RXA.29 |
Optional[List[EI]] |
optional |
Administered Tag Identifier: Item #3396 |
- class hl7types.hl7.v2_8_2.segments.RXC.RXC
HL7 v2 RXC segment.
RXC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXC.1 |
str |
required |
RX Component Type: Item #313 | Table HL70166 |
|
|
RXC.2 |
required |
Component Code: Item #314 | Table HL79999 |
||
|
RXC.3 |
str |
required |
Component Amount: Item #315 |
|
|
RXC.4 |
required |
Component Units: Item #316 | Table HL79999 |
||
|
RXC.5 |
Optional[str] |
optional |
Component Strength: Item #1124 |
|
|
RXC.6 |
Optional[CWE] |
optional |
Component Strength Units: Item #1125 | Table HL79999 |
|
|
RXC.7 |
Optional[List[CWE]] |
optional |
Supplementary Code: Item #1476 | Table HL79999 |
|
|
RXC.8 |
Optional[str] |
optional |
Component Drug Strength Volume: Item #1671 |
|
|
RXC.9 |
Optional[CWE] |
optional |
Component Drug Strength Volume Units: Item #1672 | Table HL79999 |
|
|
RXC.10 |
Optional[str] |
optional |
Dispense Amount: Item #3314 |
|
|
RXC.11 |
Optional[CWE] |
optional |
Dispense Units: Item #3315 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.RXD.RXD
HL7 v2 RXD segment.
RXD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXD.1 |
str |
required |
Dispense Sub-ID Counter: Item #334 |
|
|
RXD.2 |
required |
Dispense/Give Code: Item #335 | Table HL70292 |
||
|
RXD.3 |
str |
required |
Date/Time Dispensed: Item #336 |
|
|
RXD.4 |
str |
required |
Actual Dispense Amount: Item #337 |
|
|
RXD.5 |
Optional[CWE] |
optional |
Actual Dispense Units: Item #338 | Table HL79999 |
|
|
RXD.6 |
Optional[CWE] |
optional |
Actual Dosage Form: Item #339 | Table HL79999 |
|
|
RXD.7 |
str |
required |
Prescription Number: Item #325 |
|
|
RXD.8 |
Optional[str] |
optional |
Number of Refills Remaining: Item #326 |
|
|
RXD.9 |
Optional[List[str]] |
optional |
Dispense Notes: Item #340 |
|
|
RXD.10 |
Optional[List[XCN]] |
optional |
Dispensing Provider: Item #341 |
|
|
RXD.11 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXD.12 |
Optional[CQ] |
optional |
Total Daily Dose: Item #329 |
|
|
RXD.14 |
Optional[str] |
optional |
Needs Human Review: Item #307 | Table HL70136 |
|
|
RXD.15 |
Optional[List[CWE]] |
optional |
Special Dispensing Instructions: Item #330 | Table HL79999 |
|
|
RXD.16 |
Optional[str] |
optional |
Actual Strength: Item #1132 |
|
|
RXD.17 |
Optional[CWE] |
optional |
Actual Strength Unit: Item #1133 | Table HL79999 |
|
|
RXD.18 |
Optional[List[str]] |
optional |
Substance Lot Number: Item #1129 |
|
|
RXD.19 |
Optional[List[str]] |
optional |
Substance Expiration Date: Item #1130 |
|
|
RXD.20 |
Optional[List[CWE]] |
optional |
Substance Manufacturer Name: Item #1131 |
|
|
RXD.21 |
Optional[List[CWE]] |
optional |
Indication: Item #1123 | Table HL79999 |
|
|
RXD.22 |
Optional[str] |
optional |
Dispense Package Size: Item #1220 |
|
|
RXD.23 |
Optional[CWE] |
optional |
Dispense Package Size Unit: Item #1221 | Table HL79999 |
|
|
RXD.24 |
Optional[str] |
optional |
Dispense Package Method: Item #1222 | Table HL70321 |
|
|
RXD.25 |
Optional[List[CWE]] |
optional |
Supplementary Code: Item #1476 | Table HL79999 |
|
|
RXD.26 |
Optional[CWE] |
optional |
Initiating Location: Item #1477 | Table HL79999 |
|
|
RXD.27 |
Optional[CWE] |
optional |
Packaging/Assembly Location: Item #1478 | Table HL79999 |
|
|
RXD.28 |
Optional[str] |
optional |
Actual Drug Strength Volume: Item #1686 |
|
|
RXD.29 |
Optional[CWE] |
optional |
Actual Drug Strength Volume Units: Item #1687 | Table HL79999 |
|
|
RXD.30 |
Optional[CWE] |
optional |
Dispense to Pharmacy: Item #1688 | Table HL79999 |
|
|
RXD.31 |
Optional[XAD] |
optional |
Dispense to Pharmacy Address: Item #1689 |
|
|
RXD.32 |
Optional[str] |
optional |
Pharmacy Order Type: Item #1690 | Table HL70480 |
|
|
RXD.33 |
Optional[CWE] |
optional |
Dispense Type: Item #1691 | Table HL70484 |
|
|
RXD.34 |
Optional[List[XTN]] |
optional |
Pharmacy Phone Number: Item #2311 |
|
|
RXD.35 |
Optional[List[EI]] |
optional |
Dispense Tag Identifier: Item #3392 |
- class hl7types.hl7.v2_8_2.segments.RXE.RXE
HL7 v2 RXE segment.
RXE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXE.2 |
required |
Give Code: Item #317 | Table HL70292 |
||
|
RXE.3 |
str |
required |
Give Amount - Minimum: Item #318 |
|
|
RXE.4 |
Optional[str] |
optional |
Give Amount - Maximum: Item #319 |
|
|
RXE.5 |
required |
Give Units: Item #320 | Table HL79999 |
||
|
RXE.6 |
Optional[CWE] |
optional |
Give Dosage Form: Item #321 | Table HL79999 |
|
|
RXE.7 |
Optional[List[CWE]] |
optional |
Provider’s Administration Instructions: Item #298 | Table HL79999 |
|
|
RXE.9 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXE.10 |
Optional[str] |
optional |
Dispense Amount: Item #323 |
|
|
RXE.11 |
Optional[CWE] |
optional |
Dispense Units: Item #324 | Table HL79999 |
|
|
RXE.12 |
Optional[str] |
optional |
Number Of Refills: Item #304 |
|
|
RXE.13 |
Optional[List[XCN]] |
optional |
Ordering Provider’s DEA Number: Item #305 |
|
|
RXE.14 |
Optional[List[XCN]] |
optional |
Pharmacist/Treatment Supplier’s Verifier ID: Item #306 |
|
|
RXE.15 |
Optional[str] |
optional |
Prescription Number: Item #325 |
|
|
RXE.16 |
Optional[str] |
optional |
Number of Refills Remaining: Item #326 |
|
|
RXE.17 |
Optional[str] |
optional |
Number of Refills/Doses Dispensed: Item #327 |
|
|
RXE.18 |
Optional[str] |
optional |
D/T of Most Recent Refill or Dose Dispensed: Item #328 |
|
|
RXE.19 |
Optional[CQ] |
optional |
Total Daily Dose: Item #329 |
|
|
RXE.20 |
Optional[str] |
optional |
Needs Human Review: Item #307 | Table HL70136 |
|
|
RXE.21 |
Optional[List[CWE]] |
optional |
Special Dispensing Instructions: Item #330 | Table HL79999 |
|
|
RXE.22 |
Optional[str] |
optional |
Give Per (Time Unit): Item #331 |
|
|
RXE.23 |
Optional[str] |
optional |
Give Rate Amount: Item #332 |
|
|
RXE.24 |
Optional[CWE] |
optional |
Give Rate Units: Item #333 | Table HL79999 |
|
|
RXE.25 |
Optional[str] |
optional |
Give Strength: Item #1126 |
|
|
RXE.26 |
Optional[CWE] |
optional |
Give Strength Units: Item #1127 | Table HL79999 |
|
|
RXE.27 |
Optional[List[CWE]] |
optional |
Give Indication: Item #1128 | Table HL79999 |
|
|
RXE.28 |
Optional[str] |
optional |
Dispense Package Size: Item #1220 |
|
|
RXE.29 |
Optional[CWE] |
optional |
Dispense Package Size Unit: Item #1221 | Table HL79999 |
|
|
RXE.30 |
Optional[str] |
optional |
Dispense Package Method: Item #1222 | Table HL70321 |
|
|
RXE.31 |
Optional[List[CWE]] |
optional |
Supplementary Code: Item #1476 | Table HL79999 |
|
|
RXE.32 |
Optional[str] |
optional |
Original Order Date/Time: Item #1673 |
|
|
RXE.33 |
Optional[str] |
optional |
Give Drug Strength Volume: Item #1674 |
|
|
RXE.34 |
Optional[CWE] |
optional |
Give Drug Strength Volume Units: Item #1675 | Table HL79999 |
|
|
RXE.35 |
Optional[CWE] |
optional |
Controlled Substance Schedule: Item #1676 | Table HL70477 |
|
|
RXE.36 |
Optional[str] |
optional |
Formulary Status: Item #1677 | Table HL70478 |
|
|
RXE.37 |
Optional[List[CWE]] |
optional |
Pharmaceutical Substance Alternative: Item #1678 | Table HL79999 |
|
|
RXE.38 |
Optional[CWE] |
optional |
Pharmacy of Most Recent Fill: Item #1679 | Table HL79999 |
|
|
RXE.39 |
Optional[str] |
optional |
Initial Dispense Amount: Item #1680 |
|
|
RXE.40 |
Optional[CWE] |
optional |
Dispensing Pharmacy: Item #1681 | Table HL79999 |
|
|
RXE.41 |
Optional[XAD] |
optional |
Dispensing Pharmacy Address: Item #1682 |
|
|
RXE.42 |
Optional[PL] |
optional |
Deliver-to Patient Location: Item #1683 |
|
|
RXE.43 |
Optional[XAD] |
optional |
Deliver-to Address: Item #1684 |
|
|
RXE.44 |
Optional[str] |
optional |
Pharmacy Order Type: Item #1685 | Table HL70480 |
|
|
RXE.45 |
Optional[List[XTN]] |
optional |
Pharmacy Phone Number: Item #2310 |
- class hl7types.hl7.v2_8_2.segments.RXG.RXG
HL7 v2 RXG segment.
RXG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXG.1 |
str |
required |
Give Sub-ID Counter: Item #342 |
|
|
RXG.2 |
Optional[str] |
optional |
Dispense Sub-ID Counter: Item #334 |
|
|
RXG.4 |
required |
Give Code: Item #317 | Table HL70292 |
||
|
RXG.5 |
str |
required |
Give Amount - Minimum: Item #318 |
|
|
RXG.6 |
Optional[str] |
optional |
Give Amount - Maximum: Item #319 |
|
|
RXG.7 |
required |
Give Units: Item #320 | Table HL79999 |
||
|
RXG.8 |
Optional[CWE] |
optional |
Give Dosage Form: Item #321 | Table HL79999 |
|
|
RXG.9 |
Optional[List[CWE]] |
optional |
Administration Notes: Item #351 | Table HL79999 |
|
|
RXG.10 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXG.12 |
Optional[str] |
optional |
Needs Human Review: Item #307 | Table HL70136 |
|
|
RXG.13 |
Optional[List[CWE]] |
optional |
Special Administration Instructions: Item #343 | Table HL79999 |
|
|
RXG.14 |
Optional[str] |
optional |
Give Per (Time Unit): Item #331 |
|
|
RXG.15 |
Optional[str] |
optional |
Give Rate Amount: Item #332 |
|
|
RXG.16 |
Optional[CWE] |
optional |
Give Rate Units: Item #333 | Table HL79999 |
|
|
RXG.17 |
Optional[str] |
optional |
Give Strength: Item #1126 |
|
|
RXG.18 |
Optional[CWE] |
optional |
Give Strength Units: Item #1127 | Table HL79999 |
|
|
RXG.19 |
Optional[List[str]] |
optional |
Substance Lot Number: Item #1129 |
|
|
RXG.20 |
Optional[List[str]] |
optional |
Substance Expiration Date: Item #1130 |
|
|
RXG.21 |
Optional[List[CWE]] |
optional |
Substance Manufacturer Name: Item #1131 |
|
|
RXG.22 |
Optional[List[CWE]] |
optional |
Indication: Item #1123 | Table HL79999 |
|
|
RXG.23 |
Optional[str] |
optional |
Give Drug Strength Volume: Item #1692 |
|
|
RXG.24 |
Optional[CWE] |
optional |
Give Drug Strength Volume Units: Item #1693 | Table HL79999 |
|
|
RXG.25 |
Optional[CWE] |
optional |
Give Barcode Identifier: Item #1694 | Table HL79999 |
|
|
RXG.26 |
Optional[str] |
optional |
Pharmacy Order Type: Item #1695 | Table HL70480 |
|
|
RXG.27 |
Optional[CWE] |
optional |
Dispense to Pharmacy: Item #1688 | Table HL79999 |
|
|
RXG.28 |
Optional[XAD] |
optional |
Dispense to Pharmacy Address: Item #1689 |
|
|
RXG.29 |
Optional[PL] |
optional |
Deliver-to Patient Location: Item #1683 |
|
|
RXG.30 |
Optional[XAD] |
optional |
Deliver-to Address: Item #1684 |
|
|
RXG.31 |
Optional[List[EI]] |
optional |
Give Tag Identifier: Item #3393 |
|
|
RXG.32 |
Optional[str] |
optional |
Dispense Amount: Item #3316 |
|
|
RXG.33 |
Optional[CWE] |
optional |
Dispense Units: Item #3317 | Table HL79999 |
- class hl7types.hl7.v2_8_2.segments.RXO.RXO
HL7 v2 RXO segment.
RXO¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXO.1 |
Optional[CWE] |
optional |
Requested Give Code: Item #292 | Table HL79999 |
|
|
RXO.2 |
Optional[str] |
optional |
Requested Give Amount - Minimum: Item #293 |
|
|
RXO.3 |
Optional[str] |
optional |
Requested Give Amount - Maximum: Item #294 |
|
|
RXO.4 |
Optional[CWE] |
optional |
Requested Give Units: Item #295 | Table HL79999 |
|
|
RXO.5 |
Optional[CWE] |
optional |
Requested Dosage Form: Item #296 | Table HL79999 |
|
|
RXO.6 |
Optional[List[CWE]] |
optional |
Provider’s Pharmacy/Treatment Instructions: Item #297 | Table HL79999 |
|
|
RXO.7 |
Optional[List[CWE]] |
optional |
Provider’s Administration Instructions: Item #298 | Table HL79999 |
|
|
RXO.9 |
Optional[str] |
optional |
Allow Substitutions: Item #300 | Table HL70161 |
|
|
RXO.10 |
Optional[CWE] |
optional |
Requested Dispense Code: Item #301 | Table HL79999 |
|
|
RXO.11 |
Optional[str] |
optional |
Requested Dispense Amount: Item #302 |
|
|
RXO.12 |
Optional[CWE] |
optional |
Requested Dispense Units: Item #303 | Table HL79999 |
|
|
RXO.13 |
Optional[str] |
optional |
Number Of Refills: Item #304 |
|
|
RXO.14 |
Optional[List[XCN]] |
optional |
Ordering Provider’s DEA Number: Item #305 |
|
|
RXO.15 |
Optional[List[XCN]] |
optional |
Pharmacist/Treatment Supplier’s Verifier ID: Item #306 |
|
|
RXO.16 |
Optional[str] |
optional |
Needs Human Review: Item #307 | Table HL70136 |
|
|
RXO.17 |
Optional[str] |
optional |
Requested Give Per (Time Unit): Item #308 |
|
|
RXO.18 |
Optional[str] |
optional |
Requested Give Strength: Item #1121 |
|
|
RXO.19 |
Optional[CWE] |
optional |
Requested Give Strength Units: Item #1122 | Table HL79999 |
|
|
RXO.20 |
Optional[List[CWE]] |
optional |
Indication: Item #1123 | Table HL79999 |
|
|
RXO.21 |
Optional[str] |
optional |
Requested Give Rate Amount: Item #1218 |
|
|
RXO.22 |
Optional[CWE] |
optional |
Requested Give Rate Units: Item #1219 | Table HL79999 |
|
|
RXO.23 |
Optional[CQ] |
optional |
Total Daily Dose: Item #329 |
|
|
RXO.24 |
Optional[List[CWE]] |
optional |
Supplementary Code: Item #1476 | Table HL79999 |
|
|
RXO.25 |
Optional[str] |
optional |
Requested Drug Strength Volume: Item #1666 |
|
|
RXO.26 |
Optional[CWE] |
optional |
Requested Drug Strength Volume Units: Item #1667 | Table HL79999 |
|
|
RXO.27 |
Optional[str] |
optional |
Pharmacy Order Type: Item #1668 | Table HL70480 |
|
|
RXO.28 |
Optional[str] |
optional |
Dispensing Interval: Item #1669 |
|
|
RXO.29 |
Optional[EI] |
optional |
Medication Instance Identifier: Item #2149 |
|
|
RXO.30 |
Optional[EI] |
optional |
Segment Instance Identifier: Item #2150 |
|
|
RXO.31 |
Optional[CNE] |
optional |
Mood Code: Item #2151 | Table HL70725 |
|
|
RXO.32 |
Optional[CWE] |
optional |
Dispensing Pharmacy: Item #1681 | Table HL79999 |
|
|
RXO.33 |
Optional[XAD] |
optional |
Dispensing Pharmacy Address: Item #1682 |
|
|
RXO.34 |
Optional[PL] |
optional |
Deliver-to Patient Location: Item #1683 |
|
|
RXO.35 |
Optional[XAD] |
optional |
Deliver-to Address: Item #1684 |
|
|
RXO.36 |
Optional[List[XTN]] |
optional |
Pharmacy Phone Number: Item #2309 |
- class hl7types.hl7.v2_8_2.segments.RXR.RXR
HL7 v2 RXR segment.
RXR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXR.1 |
required |
Route: Item #309 | Table HL70162 |
||
|
RXR.2 |
Optional[CWE] |
optional |
Administration Site: Item #310 | Table HL70550 |
|
|
RXR.3 |
Optional[CWE] |
optional |
Administration Device: Item #311 | Table HL70164 |
|
|
RXR.4 |
Optional[CWE] |
optional |
Administration Method: Item #312 | Table HL70165 |
|
|
RXR.5 |
Optional[CWE] |
optional |
Routing Instruction: Item #1315 | Table HL79999 |
|
|
RXR.6 |
Optional[CWE] |
optional |
Administration Site Modifier: Item #1670 | Table HL70495 |
- class hl7types.hl7.v2_8_2.segments.RXV.RXV
HL7 v2 RXV segment.
RXV¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXV.1 |
Optional[str] |
optional |
Set ID - RXV: Item #3318 |
|
|
RXV.2 |
str |
required |
Bolus Type: Item #3319 | Table HL70917 |
|
|
RXV.3 |
Optional[str] |
optional |
Bolus Dose Amount: Item #3320 |
|
|
RXV.4 |
Optional[CWE] |
optional |
Bolus Dose Amount Units: Item #3321 | Table HL79999 |
|
|
RXV.5 |
Optional[str] |
optional |
Bolus Dose Volume: Item #3322 |
|
|
RXV.6 |
Optional[CWE] |
optional |
Bolus Dose Volume Units: Item #3323 | Table HL79999 |
|
|
RXV.7 |
str |
required |
PCA Type: Item #3324 | Table HL70918 |
|
|
RXV.8 |
Optional[str] |
optional |
PCA Dose Amount: Item #3325 |
|
|
RXV.9 |
Optional[CWE] |
optional |
PCA Dose Amount Units: Item #3326 | Table HL79999 |
|
|
RXV.10 |
Optional[str] |
optional |
PCA Dose Amount Volume: Item #3327 |
|
|
RXV.11 |
Optional[CWE] |
optional |
PCA Dose Amount Volume Units: Item #3328 | Table HL79999 |
|
|
RXV.12 |
Optional[str] |
optional |
Max Dose Amount: Item #3329 |
|
|
RXV.13 |
Optional[CWE] |
optional |
Max Dose Amount Units: Item #3330 | Table HL79999 |
|
|
RXV.14 |
Optional[str] |
optional |
Max Dose Amount Volume: Item #3331 |
|
|
RXV.15 |
Optional[CWE] |
optional |
Max Dose Amount Volume Units: Item #3332 | Table HL79999 |
|
|
RXV.16 |
required |
Max Dose per Time: Item #3333 |
||
|
RXV.17 |
Optional[CQ] |
optional |
Lockout Interval: Item #3334 |
|
|
RXV.18 |
Optional[CWE] |
optional |
Syringe Manufacturer: Item #3339 |
|
|
RXV.19 |
Optional[CWE] |
optional |
Syringe Model Number: Item #3385 |
|
|
RXV.20 |
Optional[str] |
optional |
Syringe Size: Item #3386 |
|
|
RXV.21 |
Optional[CWE] |
optional |
Syringe Size Units: Item #3431 |
|
|
RXV.22 |
Optional[str] |
optional |
Action Code: Item #816 | Table HL70206 |
- class hl7types.hl7.v2_8_2.segments.SAC.SAC
HL7 v2 SAC segment.
SAC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SAC.1 |
Optional[EI] |
optional |
External Accession Identifier: Item #1329 |
|
|
SAC.2 |
Optional[EI] |
optional |
Accession Identifier: Item #1330 |
|
|
SAC.3 |
Optional[EI] |
optional |
Container Identifier: Item #1331 |
|
|
SAC.4 |
Optional[EI] |
optional |
Primary (Parent) Container Identifier: Item #1332 |
|
|
SAC.5 |
Optional[EI] |
optional |
Equipment Container Identifier: Item #1333 |
|
|
SAC.7 |
Optional[str] |
optional |
Registration Date/Time: Item #1334 |
|
|
SAC.8 |
Optional[CWE] |
optional |
Container Status: Item #1335 | Table HL70370 |
|
|
SAC.9 |
Optional[CWE] |
optional |
Carrier Type: Item #1336 | Table HL70378 |
|
|
SAC.10 |
Optional[EI] |
optional |
Carrier Identifier: Item #1337 |
|
|
SAC.11 |
Optional[NA] |
optional |
Position in Carrier: Item #1338 |
|
|
SAC.12 |
Optional[CWE] |
optional |
Tray Type - SAC: Item #1339 | Table HL70379 |
|
|
SAC.13 |
Optional[EI] |
optional |
Tray Identifier: Item #1340 |
|
|
SAC.14 |
Optional[NA] |
optional |
Position in Tray: Item #1341 |
|
|
SAC.15 |
Optional[List[CWE]] |
optional |
Location: Item #1342 | Table HL79999 |
|
|
SAC.16 |
Optional[str] |
optional |
Container Height: Item #1343 |
|
|
SAC.17 |
Optional[str] |
optional |
Container Diameter: Item #1344 |
|
|
SAC.18 |
Optional[str] |
optional |
Barrier Delta: Item #1345 |
|
|
SAC.19 |
Optional[str] |
optional |
Bottom Delta: Item #1346 |
|
|
SAC.20 |
Optional[CWE] |
optional |
Container Height/Diameter/Delta Units: Item #1347 | Table HL79999 |
|
|
SAC.21 |
Optional[str] |
optional |
Container Volume: Item #644 |
|
|
SAC.22 |
Optional[str] |
optional |
Available Specimen Volume: Item #1349 |
|
|
SAC.23 |
Optional[str] |
optional |
Initial Specimen Volume: Item #1350 |
|
|
SAC.24 |
Optional[CWE] |
optional |
Volume Units: Item #1351 | Table HL79999 |
|
|
SAC.25 |
Optional[CWE] |
optional |
Separator Type: Item #1352 | Table HL70380 |
|
|
SAC.26 |
Optional[CWE] |
optional |
Cap Type: Item #1353 | Table HL70381 |
|
|
SAC.27 |
Optional[List[CWE]] |
optional |
Additive: Item #647 | Table HL70371 |
|
|
SAC.28 |
Optional[CWE] |
optional |
Specimen Component: Item #1355 | Table HL70372 |
|
|
SAC.29 |
Optional[SN] |
optional |
Dilution Factor: Item #1356 |
|
|
SAC.30 |
Optional[CWE] |
optional |
Treatment: Item #1357 | Table HL70373 |
|
|
SAC.31 |
Optional[SN] |
optional |
Temperature: Item #1358 |
|
|
SAC.32 |
Optional[str] |
optional |
Hemolysis Index: Item #1359 |
|
|
SAC.33 |
Optional[CWE] |
optional |
Hemolysis Index Units: Item #1360 | Table HL79999 |
|
|
SAC.34 |
Optional[str] |
optional |
Lipemia Index: Item #1361 |
|
|
SAC.35 |
Optional[CWE] |
optional |
Lipemia Index Units: Item #1362 | Table HL79999 |
|
|
SAC.36 |
Optional[str] |
optional |
Icterus Index: Item #1363 |
|
|
SAC.37 |
Optional[CWE] |
optional |
Icterus Index Units: Item #1364 | Table HL79999 |
|
|
SAC.38 |
Optional[str] |
optional |
Fibrin Index: Item #1365 |
|
|
SAC.39 |
Optional[CWE] |
optional |
Fibrin Index Units: Item #1366 | Table HL79999 |
|
|
SAC.40 |
Optional[List[CWE]] |
optional |
System Induced Contaminants: Item #1367 | Table HL70374 |
|
|
SAC.41 |
Optional[List[CWE]] |
optional |
Drug Interference: Item #1368 | Table HL70382 |
|
|
SAC.42 |
Optional[CWE] |
optional |
Artificial Blood: Item #1369 | Table HL70375 |
|
|
SAC.43 |
Optional[List[CWE]] |
optional |
Special Handling Code: Item #1370 | Table HL70376 |
|
|
SAC.44 |
Optional[List[CWE]] |
optional |
Other Environmental Factors: Item #1371 | Table HL70377 |
- class hl7types.hl7.v2_8_2.segments.SCD.SCD
HL7 v2 SCD segment.
SCD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SCD.1 |
Optional[str] |
optional |
Cycle Start Time: Item #2104 |
|
|
SCD.2 |
Optional[str] |
optional |
Cycle Count: Item #2105 |
|
|
SCD.3 |
Optional[CQ] |
optional |
Temp Max: Item #2106 |
|
|
SCD.4 |
Optional[CQ] |
optional |
Temp Min: Item #2107 |
|
|
SCD.5 |
Optional[str] |
optional |
Load Number: Item #2108 |
|
|
SCD.6 |
Optional[CQ] |
optional |
Condition Time: Item #2109 |
|
|
SCD.7 |
Optional[CQ] |
optional |
Sterilize Time: Item #2110 |
|
|
SCD.8 |
Optional[CQ] |
optional |
Exhaust Time: Item #2111 |
|
|
SCD.9 |
Optional[CQ] |
optional |
Total Cycle Time: Item #2112 |
|
|
SCD.10 |
Optional[CWE] |
optional |
Device Status: Item #2113 | Table HL70682 |
|
|
SCD.11 |
Optional[str] |
optional |
Cycle Start Date/Time: Item #2114 |
|
|
SCD.12 |
Optional[CQ] |
optional |
Dry Time: Item #2115 |
|
|
SCD.13 |
Optional[CQ] |
optional |
Leak Rate: Item #2116 |
|
|
SCD.14 |
Optional[CQ] |
optional |
Control Temperature: Item #2117 |
|
|
SCD.15 |
Optional[CQ] |
optional |
Sterilizer Temperature: Item #2118 |
|
|
SCD.16 |
Optional[str] |
optional |
Cycle Complete Time: Item #2119 |
|
|
SCD.17 |
Optional[CQ] |
optional |
Under Temperature: Item #2120 |
|
|
SCD.18 |
Optional[CQ] |
optional |
Over Temperature: Item #2121 |
|
|
SCD.19 |
Optional[CNE] |
optional |
Abort Cycle: Item #2122 | Table HL70532 |
|
|
SCD.20 |
Optional[CNE] |
optional |
Alarm: Item #2123 | Table HL70532 |
|
|
SCD.21 |
Optional[CNE] |
optional |
Long in Charge Phase: Item #2124 | Table HL70532 |
|
|
SCD.22 |
Optional[CNE] |
optional |
Long in Exhaust Phase: Item #2125 | Table HL70532 |
|
|
SCD.23 |
Optional[CNE] |
optional |
Long in Fast Exhaust Phase: Item #2126 | Table HL70532 |
|
|
SCD.24 |
Optional[CNE] |
optional |
Reset: Item #2127 | Table HL70532 |
|
|
SCD.25 |
Optional[XCN] |
optional |
Operator - Unload: Item #2128 |
|
|
SCD.26 |
Optional[CNE] |
optional |
Door Open: Item #2129 | Table HL70532 |
|
|
SCD.27 |
Optional[CNE] |
optional |
Reading Failure: Item #2130 | Table HL70532 |
|
|
SCD.28 |
Optional[CWE] |
optional |
Cycle Type: Item #2131 | Table HL70702 |
|
|
SCD.29 |
Optional[CQ] |
optional |
Thermal Rinse Time: Item #2132 |
|
|
SCD.30 |
Optional[CQ] |
optional |
Wash Time: Item #2133 |
|
|
SCD.31 |
Optional[CQ] |
optional |
Injection Rate: Item #2134 |
|
|
SCD.32 |
Optional[CNE] |
optional |
Procedure Code: Item #393 | Table HL70088 |
|
|
SCD.33 |
Optional[List[CX]] |
optional |
Patient Identifier List: Item #106 |
|
|
SCD.34 |
Optional[XCN] |
optional |
Attending Doctor: Item #137 | Table HL70010 |
|
|
SCD.35 |
Optional[SN] |
optional |
Dilution Factor: Item #1356 |
|
|
SCD.36 |
Optional[CQ] |
optional |
Fill Time: Item #2139 |
|
|
SCD.37 |
Optional[CQ] |
optional |
Inlet Temperature: Item #2140 |
- class hl7types.hl7.v2_8_2.segments.SCH.SCH
HL7 v2 SCH segment.
SCH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SCH.1 |
Optional[EI] |
optional |
Placer Appointment ID: Item #860 |
|
|
SCH.2 |
Optional[EI] |
optional |
Filler Appointment ID: Item #861 |
|
|
SCH.3 |
Optional[str] |
optional |
Occurrence Number: Item #862 |
|
|
SCH.4 |
Optional[EIP] |
optional |
Placer Group Number: Item #218 |
|
|
SCH.5 |
Optional[CWE] |
optional |
Schedule ID: Item #864 |
|
|
SCH.6 |
required |
Event Reason: Item #883 |
||
|
SCH.7 |
Optional[CWE] |
optional |
Appointment Reason: Item #866 | Table HL70276 |
|
|
SCH.8 |
Optional[CWE] |
optional |
Appointment Type: Item #867 | Table HL70277 |
|
|
SCH.10 |
Optional[CNE] |
optional |
Appointment Duration Units: Item #869 |
|
|
SCH.12 |
Optional[List[XCN]] |
optional |
Placer Contact Person: Item #874 |
|
|
SCH.13 |
Optional[XTN] |
optional |
Placer Contact Phone Number: Item #875 |
|
|
SCH.14 |
Optional[List[XAD]] |
optional |
Placer Contact Address: Item #876 |
|
|
SCH.15 |
Optional[PL] |
optional |
Placer Contact Location: Item #877 |
|
|
SCH.16 |
Optional[List[XCN]] |
optional |
Filler Contact Person: Item #885 |
|
|
SCH.17 |
Optional[XTN] |
optional |
Filler Contact Phone Number: Item #886 |
|
|
SCH.18 |
Optional[List[XAD]] |
optional |
Filler Contact Address: Item #887 |
|
|
SCH.19 |
Optional[PL] |
optional |
Filler Contact Location: Item #888 |
|
|
SCH.20 |
Optional[List[XCN]] |
optional |
Entered By Person: Item #878 |
|
|
SCH.21 |
Optional[List[XTN]] |
optional |
Entered By Phone Number: Item #879 |
|
|
SCH.22 |
Optional[PL] |
optional |
Entered By Location: Item #880 |
|
|
SCH.23 |
Optional[EI] |
optional |
Parent Placer Appointment ID: Item #881 |
|
|
SCH.24 |
Optional[EI] |
optional |
Parent Filler Appointment ID: Item #882 |
|
|
SCH.25 |
Optional[CWE] |
optional |
Filler Status Code: Item #889 | Table HL70278 |
|
|
SCH.26 |
Optional[List[EI]] |
optional |
Placer Order Number: Item #216 |
|
|
SCH.27 |
Optional[List[EI]] |
optional |
Filler Order Number: Item #217 |
- class hl7types.hl7.v2_8_2.segments.SCP.SCP
HL7 v2 SCP segment.
SCP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SCP.1 |
Optional[str] |
optional |
Number Of Decontamination/Sterilization Devices: Item #2087 |
|
|
SCP.2 |
Optional[CWE] |
optional |
Labor Calculation Type: Item #2088 | Table HL70651 |
|
|
SCP.3 |
Optional[CWE] |
optional |
Date Format: Item #2089 | Table HL70653 |
|
|
SCP.4 |
Optional[EI] |
optional |
Device Number: Item #2090 |
|
|
SCP.5 |
Optional[str] |
optional |
Device Name: Item #2279 |
|
|
SCP.6 |
Optional[str] |
optional |
Device Model Name: Item #2091 |
|
|
SCP.7 |
Optional[CWE] |
optional |
Device Type: Item #2092 | Table HL70657 |
|
|
SCP.8 |
Optional[CWE] |
optional |
Lot Control: Item #2093 | Table HL70659 |
- class hl7types.hl7.v2_8_2.segments.SDD.SDD
HL7 v2 SDD segment.
SDD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SDD.1 |
Optional[EI] |
optional |
Lot Number: Item #2098 |
|
|
SDD.2 |
Optional[EI] |
optional |
Device Number: Item #2099 |
|
|
SDD.3 |
Optional[str] |
optional |
Device Name: Item #2281 |
|
|
SDD.4 |
Optional[CWE] |
optional |
Device Data State: Item #2100 | Table HL70667 |
|
|
SDD.5 |
Optional[CWE] |
optional |
Load Status: Item #2101 | Table HL70669 |
|
|
SDD.6 |
Optional[str] |
optional |
Control Code: Item #2102 |
|
|
SDD.7 |
Optional[str] |
optional |
Operator Name: Item #2103 |
- class hl7types.hl7.v2_8_2.segments.SFT.SFT
HL7 v2 SFT segment.
SFT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SFT.1 |
required |
Software Vendor Organization: Item #1834 |
||
|
SFT.2 |
str |
required |
Software Certified Version or Release Number: Item #1835 |
|
|
SFT.3 |
str |
required |
Software Product Name: Item #1836 |
|
|
SFT.4 |
str |
required |
Software Binary ID: Item #1837 |
|
|
SFT.5 |
Optional[TX] |
optional |
Software Product Information: Item #1838 |
|
|
SFT.6 |
Optional[str] |
optional |
Software Install Date: Item #1839 |
- class hl7types.hl7.v2_8_2.segments.SGH.SGH
HL7 v2 SGH segment.
SGH¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SGH.1 |
str |
required |
Set ID - SGH: Item #3389 |
|
|
SGH.2 |
Optional[str] |
optional |
Segment Group Name: Item #3390 |
- class hl7types.hl7.v2_8_2.segments.SGT.SGT
HL7 v2 SGT segment.
SGT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SGT.1 |
str |
required |
Set ID - SGT: Item #3394 |
|
|
SGT.2 |
Optional[str] |
optional |
Segment Group Name: Item #3395 |
- class hl7types.hl7.v2_8_2.segments.SHP.SHP
HL7 v2 SHP segment.
SHP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SHP.1 |
required |
Shipment ID: Item #2317 |
||
|
SHP.2 |
Optional[List[EI]] |
optional |
Internal Shipment ID: Item #2318 |
|
|
SHP.3 |
Optional[CWE] |
optional |
Shipment Status: Item #2319 | Table HL70905 |
|
|
SHP.4 |
str |
required |
Shipment Status Date/Time: Item #2320 |
|
|
SHP.5 |
Optional[TX] |
optional |
Shipment Status Reason: Item #2321 |
|
|
SHP.6 |
Optional[CWE] |
optional |
Shipment Priority: Item #2322 | Table HL70906 |
|
|
SHP.7 |
Optional[List[CWE]] |
optional |
Shipment Confidentiality: Item #2323 | Table HL70907 |
|
|
SHP.8 |
Optional[str] |
optional |
Number of Packages in Shipment: Item #2324 |
|
|
SHP.9 |
Optional[List[CWE]] |
optional |
Shipment Condition: Item #2325 | Table HL70544 |
|
|
SHP.10 |
Optional[List[CWE]] |
optional |
Shipment Handling Code: Item #2326 | Table HL70376 |
|
|
SHP.11 |
Optional[List[CWE]] |
optional |
Shipment Risk Code: Item #2327 | Table HL70489 |
- class hl7types.hl7.v2_8_2.segments.SID.SID
HL7 v2 SID segment.
SID¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SID.1 |
Optional[CWE] |
optional |
Application/Method Identifier: Item #1426 | Table HL79999 |
|
|
SID.2 |
Optional[str] |
optional |
Substance Lot Number: Item #1129 |
|
|
SID.3 |
Optional[str] |
optional |
Substance Container Identifier: Item #1428 |
|
|
SID.4 |
Optional[CWE] |
optional |
Substance Manufacturer Identifier: Item #1429 | Table HL70385 |
- class hl7types.hl7.v2_8_2.segments.SLT.SLT
HL7 v2 SLT segment.
SLT¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SLT.1 |
Optional[EI] |
optional |
Device Number: Item #2094 |
|
|
SLT.2 |
Optional[str] |
optional |
Device Name: Item #2280 |
|
|
SLT.3 |
Optional[EI] |
optional |
Lot Number: Item #2095 |
|
|
SLT.4 |
Optional[EI] |
optional |
Item Identifier: Item #2096 |
|
|
SLT.5 |
Optional[str] |
optional |
Bar Code: Item #2097 |
- class hl7types.hl7.v2_8_2.segments.SPM.SPM
HL7 v2 SPM segment.
SPM¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
SPM.1 |
Optional[str] |
optional |
Set ID - SPM: Item #1754 |
|
|
SPM.2 |
Optional[EIP] |
optional |
Specimen ID: Item #1755 |
|
|
SPM.3 |
Optional[List[EIP]] |
optional |
Specimen Parent IDs: Item #1756 |
|
|
SPM.4 |
required |
Specimen Type: Item #1900 | Table HL70487 |
||
|
SPM.5 |
Optional[List[CWE]] |
optional |
Specimen Type Modifier: Item #1757 | Table HL70541 |
|
|
SPM.6 |
Optional[List[CWE]] |
optional |
Specimen Additives: Item #1758 | Table HL70371 |
|
|
SPM.7 |
Optional[CWE] |
optional |
Specimen Collection Method: Item #1759 | Table HL70488 |
|
|
SPM.8 |
Optional[CWE] |
optional |
Specimen Source Site: Item #1901 | Table HL79999 |
|
|
SPM.9 |
Optional[List[CWE]] |
optional |
Specimen Source Site Modifier: Item #1760 | Table HL70542 |
|
|
SPM.10 |
Optional[CWE] |
optional |
Specimen Collection Site: Item #1761 | Table HL70543 |
|
|
SPM.11 |
Optional[List[CWE]] |
optional |
Specimen Role: Item #1762 | Table HL70369 |
|
|
SPM.12 |
Optional[CQ] |
optional |
Specimen Collection Amount: Item #1902 |
|
|
SPM.13 |
Optional[str] |
optional |
Grouped Specimen Count: Item #1763 |
|
|
SPM.14 |
Optional[List[str]] |
optional |
Specimen Description: Item #1764 |
|
|
SPM.15 |
Optional[List[CWE]] |
optional |
Specimen Handling Code: Item #1908 | Table HL70376 |
|
|
SPM.16 |
Optional[List[CWE]] |
optional |
Specimen Risk Code: Item #1903 | Table HL70489 |
|
|
SPM.17 |
Optional[DR] |
optional |
Specimen Collection Date/Time: Item #1765 |
|
|
SPM.18 |
Optional[str] |
optional |
Specimen Received Date/Time *: Item #248 |
|
|
SPM.19 |
Optional[str] |
optional |
Specimen Expiration Date/Time: Item #1904 |
|
|
SPM.20 |
Optional[str] |
optional |
Specimen Availability: Item #1766 | Table HL70136 |
|
|
SPM.21 |
Optional[List[CWE]] |
optional |
Specimen Reject Reason: Item #1767 | Table HL70490 |
|
|
SPM.22 |
Optional[CWE] |
optional |
Specimen Quality: Item #1768 | Table HL70491 |
|
|
SPM.23 |
Optional[CWE] |
optional |
Specimen Appropriateness: Item #1769 | Table HL70492 |
|
|
SPM.24 |
Optional[List[CWE]] |
optional |
Specimen Condition: Item #1770 | Table HL70493 |
|
|
SPM.25 |
Optional[CQ] |
optional |
Specimen Current Quantity: Item #1771 |
|
|
SPM.26 |
Optional[str] |
optional |
Number of Specimen Containers: Item #1772 |
|
|
SPM.27 |
Optional[CWE] |
optional |
Container Type: Item #1773 | Table HL79999 |
|
|
SPM.28 |
Optional[CWE] |
optional |
Container Condition: Item #1774 | Table HL70544 |
|
|
SPM.29 |
Optional[CWE] |
optional |
Specimen Child Role: Item #1775 | Table HL70494 |
|
|
SPM.30 |
Optional[List[CX]] |
optional |
Accession ID: Item #2314 |
|
|
SPM.31 |
Optional[List[CX]] |
optional |
Other Specimen ID: Item #2315 |
|
|
SPM.32 |
Optional[EI] |
optional |
Shipment ID: Item #2316 |
- class hl7types.hl7.v2_8_2.segments.STF.STF
HL7 v2 STF segment.
STF¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
STF.1 |
Optional[CWE] |
optional |
Primary Key Value - STF: Item #671 | Table HL79999 |
|
|
STF.2 |
Optional[List[CX]] |
optional |
Staff Identifier List: Item #672 | Table HL70061 |
|
|
STF.3 |
Optional[List[XPN]] |
optional |
Staff Name: Item #673 |
|
|
STF.4 |
Optional[List[CWE]] |
optional |
Staff Type: Item #674 | Table HL70182 |
|
|
STF.5 |
Optional[CWE] |
optional |
Administrative Sex: Item #111 | Table HL70001 |
|
|
STF.6 |
Optional[str] |
optional |
Date/Time of Birth: Item #110 |
|
|
STF.7 |
Optional[str] |
optional |
Active/Inactive Flag: Item #675 | Table HL70183 |
|
|
STF.8 |
Optional[List[CWE]] |
optional |
Department: Item #676 | Table HL70184 |
|
|
STF.9 |
Optional[List[CWE]] |
optional |
Hospital Service - STF: Item #677 | Table HL70069 |
|
|
STF.10 |
Optional[List[XTN]] |
optional |
Phone: Item #678 |
|
|
STF.11 |
Optional[List[XAD]] |
optional |
Office/Home Address/Birthplace: Item #679 |
|
|
STF.12 |
Optional[List[DIN]] |
optional |
Institution Activation Date: Item #680 | Table HL70537 |
|
|
STF.13 |
Optional[List[DIN]] |
optional |
Institution Inactivation Date: Item #681 | Table HL70537 |
|
|
STF.14 |
Optional[List[CWE]] |
optional |
Backup Person ID: Item #682 |
|
|
STF.15 |
Optional[List[str]] |
optional |
E-Mail Address: Item #683 |
|
|
STF.16 |
Optional[CWE] |
optional |
Preferred Method of Contact: Item #684 | Table HL70185 |
|
|
STF.17 |
Optional[CWE] |
optional |
Marital Status: Item #119 | Table HL70002 |
|
|
STF.18 |
Optional[str] |
optional |
Job Title: Item #785 |
|
|
STF.19 |
Optional[JCC] |
optional |
Job Code/Class: Item #786 |
|
|
STF.20 |
Optional[CWE] |
optional |
Employment Status Code: Item #1276 | Table HL70066 |
|
|
STF.21 |
Optional[str] |
optional |
Additional Insured on Auto: Item #1275 | Table HL70136 |
|
|
STF.22 |
Optional[DLN] |
optional |
Driver’s License Number - Staff: Item #1302 |
|
|
STF.23 |
Optional[str] |
optional |
Copy Auto Ins: Item #1229 | Table HL70136 |
|
|
STF.24 |
Optional[str] |
optional |
Auto Ins Expires: Item #1232 |
|
|
STF.25 |
Optional[str] |
optional |
Date Last DMV Review: Item #1298 |
|
|
STF.26 |
Optional[str] |
optional |
Date Next DMV Review: Item #1234 |
|
|
STF.27 |
Optional[CWE] |
optional |
Race: Item #113 | Table HL70005 |
|
|
STF.28 |
Optional[CWE] |
optional |
Ethnic Group: Item #125 | Table HL70189 |
|
|
STF.29 |
Optional[str] |
optional |
Re-activation Approval Indicator: Item #1596 | Table HL70136 |
|
|
STF.30 |
Optional[List[CWE]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
STF.31 |
Optional[str] |
optional |
Date/Time of Death: Item #1886 |
|
|
STF.32 |
Optional[str] |
optional |
Death Indicator: Item #1887 | Table HL70136 |
|
|
STF.33 |
Optional[CWE] |
optional |
Institution Relationship Type Code: Item #1888 | Table HL70538 |
|
|
STF.34 |
Optional[DR] |
optional |
Institution Relationship Period: Item #1889 |
|
|
STF.35 |
Optional[str] |
optional |
Expected Return Date: Item #1890 |
|
|
STF.36 |
Optional[List[CWE]] |
optional |
Cost Center Code: Item #1891 | Table HL70539 |
|
|
STF.37 |
Optional[str] |
optional |
Generic Classification Indicator: Item #1892 | Table HL70136 |
|
|
STF.38 |
Optional[CWE] |
optional |
Inactive Reason Code: Item #1893 | Table HL70540 |
|
|
STF.39 |
Optional[List[CWE]] |
optional |
Generic resource type or category: Item #2184 | Table HL70771 |
|
|
STF.40 |
Optional[CWE] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
STF.41 |
Optional[ED] |
optional |
Signature: Item #1861 |
- class hl7types.hl7.v2_8_2.segments.STZ.STZ
HL7 v2 STZ segment.
STZ¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
STZ.1 |
Optional[CWE] |
optional |
Sterilization Type: Item #2213 | Table HL70806 |
|
|
STZ.2 |
Optional[CWE] |
optional |
Sterilization Cycle: Item #2214 | Table HL70702 |
|
|
STZ.3 |
Optional[CWE] |
optional |
Maintenance Cycle: Item #2215 | Table HL70809 |
|
|
STZ.4 |
Optional[CWE] |
optional |
Maintenance Type: Item #2216 | Table HL70811 |
- class hl7types.hl7.v2_8_2.segments.TCC.TCC
HL7 v2 TCC segment.
TCC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
TCC.1 |
required |
Universal Service Identifier: Item #238 |
||
|
TCC.2 |
required |
Equipment Test Application Identifier: Item #1408 |
||
|
TCC.4 |
Optional[SN] |
optional |
Auto-Dilution Factor Default: Item #1410 |
|
|
TCC.5 |
Optional[SN] |
optional |
Rerun Dilution Factor Default: Item #1411 |
|
|
TCC.6 |
Optional[SN] |
optional |
Pre-Dilution Factor Default: Item #1412 |
|
|
TCC.7 |
Optional[SN] |
optional |
Endogenous Content of Pre-Dilution Diluent: Item #1413 |
|
|
TCC.8 |
Optional[str] |
optional |
Inventory Limits Warning Level: Item #1414 |
|
|
TCC.9 |
Optional[str] |
optional |
Automatic Rerun Allowed: Item #1415 | Table HL70136 |
|
|
TCC.10 |
Optional[str] |
optional |
Automatic Repeat Allowed: Item #1416 | Table HL70136 |
|
|
TCC.11 |
Optional[str] |
optional |
Automatic Reflex Allowed: Item #1417 | Table HL70136 |
|
|
TCC.12 |
Optional[SN] |
optional |
Equipment Dynamic Range: Item #1418 |
|
|
TCC.13 |
Optional[CWE] |
optional |
Units: Item #574 | Table HL79999 |
|
|
TCC.14 |
Optional[CWE] |
optional |
Processing Type: Item #1419 | Table HL70388 |
|
|
TCC.15 |
Optional[CWE] |
optional |
Test Criticality: Item #3313 |
- class hl7types.hl7.v2_8_2.segments.TCD.TCD
HL7 v2 TCD segment.
TCD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
TCD.1 |
required |
Universal Service Identifier: Item #238 |
||
|
TCD.2 |
Optional[SN] |
optional |
Auto-Dilution Factor: Item #1420 |
|
|
TCD.3 |
Optional[SN] |
optional |
Rerun Dilution Factor: Item #1421 |
|
|
TCD.4 |
Optional[SN] |
optional |
Pre-Dilution Factor: Item #1422 |
|
|
TCD.5 |
Optional[SN] |
optional |
Endogenous Content of Pre-Dilution Diluent: Item #1413 |
|
|
TCD.6 |
Optional[str] |
optional |
Automatic Repeat Allowed: Item #1416 | Table HL70136 |
|
|
TCD.7 |
Optional[str] |
optional |
Reflex Allowed: Item #1424 | Table HL70136 |
|
|
TCD.8 |
Optional[CWE] |
optional |
Analyte Repeat Status: Item #1425 | Table HL70389 |
- class hl7types.hl7.v2_8_2.segments.TQ1.TQ1
HL7 v2 TQ1 segment.
TQ1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
TQ1.1 |
Optional[str] |
optional |
Set ID - TQ1: Item #1627 |
|
|
TQ1.2 |
Optional[CQ] |
optional |
Quantity: Item #1628 |
|
|
TQ1.3 |
Optional[List[RPT]] |
optional |
Repeat Pattern: Item #1629 |
|
|
TQ1.4 |
Optional[List[str]] |
optional |
Explicit Time: Item #1630 |
|
|
TQ1.5 |
Optional[List[CQ]] |
optional |
Relative Time and Units: Item #1631 |
|
|
TQ1.6 |
Optional[CQ] |
optional |
Service Duration: Item #1632 |
|
|
TQ1.7 |
Optional[str] |
optional |
Start date/time: Item #1633 |
|
|
TQ1.8 |
Optional[str] |
optional |
End date/time: Item #1634 |
|
|
TQ1.9 |
Optional[List[CWE]] |
optional |
Priority: Item #1635 | Table HL70485 |
|
|
TQ1.10 |
Optional[TX] |
optional |
Condition text: Item #1636 |
|
|
TQ1.11 |
Optional[TX] |
optional |
Text instruction: Item #1637 |
|
|
TQ1.12 |
Optional[str] |
optional |
Conjunction: Item #1638 | Table HL70472 |
|
|
TQ1.13 |
Optional[CQ] |
optional |
Occurrence duration: Item #1639 |
|
|
TQ1.14 |
Optional[str] |
optional |
Total occurrences: Item #1640 |
- class hl7types.hl7.v2_8_2.segments.TQ2.TQ2
HL7 v2 TQ2 segment.
TQ2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
TQ2.1 |
Optional[str] |
optional |
Set ID - TQ2: Item #1648 |
|
|
TQ2.2 |
Optional[str] |
optional |
Sequence/Results Flag: Item #1649 | Table HL70503 |
|
|
TQ2.3 |
Optional[List[EI]] |
optional |
Related Placer Number: Item #1650 |
|
|
TQ2.4 |
Optional[List[EI]] |
optional |
Related Filler Number: Item #1651 |
|
|
TQ2.5 |
Optional[List[EI]] |
optional |
Related Placer Group Number: Item #1652 |
|
|
TQ2.6 |
Optional[str] |
optional |
Sequence Condition Code: Item #1653 | Table HL70504 |
|
|
TQ2.7 |
Optional[str] |
optional |
Cyclic Entry/Exit Indicator: Item #1654 | Table HL70505 |
|
|
TQ2.8 |
Optional[CQ] |
optional |
Sequence Condition Time Interval: Item #1655 |
|
|
TQ2.9 |
Optional[str] |
optional |
Cyclic Group Maximum Number of Repeats: Item #1656 |
|
|
TQ2.10 |
Optional[str] |
optional |
Special Service Request Relationship: Item #1657 | Table HL70506 |
- class hl7types.hl7.v2_8_2.segments.TXA.TXA
HL7 v2 TXA segment.
TXA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
TXA.1 |
str |
required |
Set ID- TXA: Item #914 |
|
|
TXA.2 |
required |
Document Type: Item #915 | Table HL70270 |
||
|
TXA.3 |
Optional[str] |
optional |
Document Content Presentation: Item #916 | Table HL70191 |
|
|
TXA.4 |
Optional[str] |
optional |
Activity Date/Time: Item #917 |
|
|
TXA.5 |
Optional[List[XCN]] |
optional |
Primary Activity Provider Code/Name: Item #918 |
|
|
TXA.6 |
Optional[str] |
optional |
Origination Date/Time: Item #919 |
|
|
TXA.7 |
Optional[str] |
optional |
Transcription Date/Time: Item #920 |
|
|
TXA.8 |
Optional[List[str]] |
optional |
Edit Date/Time: Item #921 |
|
|
TXA.9 |
Optional[List[XCN]] |
optional |
Originator Code/Name: Item #922 |
|
|
TXA.10 |
Optional[List[XCN]] |
optional |
Assigned Document Authenticator: Item #923 |
|
|
TXA.11 |
Optional[List[XCN]] |
optional |
Transcriptionist Code/Name: Item #924 |
|
|
TXA.12 |
required |
Unique Document Number: Item #925 |
||
|
TXA.13 |
Optional[EI] |
optional |
Parent Document Number: Item #926 |
|
|
TXA.14 |
Optional[List[EI]] |
optional |
Placer Order Number: Item #216 |
|
|
TXA.15 |
Optional[EI] |
optional |
Filler Order Number: Item #217 |
|
|
TXA.16 |
Optional[str] |
optional |
Unique Document File Name: Item #927 |
|
|
TXA.17 |
str |
required |
Document Completion Status: Item #928 | Table HL70271 |
|
|
TXA.18 |
Optional[str] |
optional |
Document Confidentiality Status: Item #929 | Table HL70272 |
|
|
TXA.19 |
Optional[str] |
optional |
Document Availability Status: Item #930 | Table HL70273 |
|
|
TXA.20 |
Optional[str] |
optional |
Document Storage Status: Item #932 | Table HL70275 |
|
|
TXA.21 |
Optional[str] |
optional |
Document Change Reason: Item #933 |
|
|
TXA.22 |
Optional[List[PPN]] |
optional |
Authentication Person, Time Stamp (set): Item #934 |
|
|
TXA.23 |
Optional[List[XCN]] |
optional |
Distributed Copies (Code and Name of Recipient(s) ): Item #935 |
|
|
TXA.24 |
Optional[List[CWE]] |
optional |
Folder Assignment: Item #2378 |
|
|
TXA.25 |
Optional[List[str]] |
optional |
Document Title: Item #3301 |
|
|
TXA.26 |
Optional[str] |
optional |
Agreed Due Date/Time: Item #3302 |
- class hl7types.hl7.v2_8_2.segments.UAC.UAC
HL7 v2 UAC segment.
UAC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
UAC.1 |
required |
User Authentication Credential Type Code: Item #2267 | Table HL70615 |
||
|
UAC.2 |
required |
User Authentication Credential: Item #2268 |
- class hl7types.hl7.v2_8_2.segments.UB2.UB2
HL7 v2 UB2 segment.
UB2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
UB2.1 |
Optional[str] |
optional |
Set ID - UB2: Item #553 |
|
|
UB2.2 |
Optional[str] |
optional |
Co-Insurance Days (9): Item #554 |
|
|
UB2.3 |
Optional[List[CWE]] |
optional |
Condition Code (24-30): Item #555 | Table HL70043 |
|
|
UB2.4 |
Optional[str] |
optional |
Covered Days (7): Item #556 |
|
|
UB2.5 |
Optional[str] |
optional |
Non-Covered Days (8): Item #557 |
|
|
UB2.6 |
Optional[List[UVC]] |
optional |
Value Amount & Code (39-41): Item #558 |
|
|
UB2.7 |
Optional[List[OCD]] |
optional |
Occurrence Code & Date (32-35): Item #559 |
|
|
UB2.8 |
Optional[List[OSP]] |
optional |
Occurrence Span Code/Dates (36): Item #560 |
|
|
UB2.9 |
Optional[List[str]] |
optional |
Uniform Billing Locator 2 (state): Item #561 |
|
|
UB2.10 |
Optional[List[str]] |
optional |
Uniform Billing Locator 11 (state): Item #562 |
|
|
UB2.11 |
Optional[str] |
optional |
Uniform Billing Locator 31 (national): Item #563 |
|
|
UB2.12 |
Optional[List[str]] |
optional |
Document Control Number: Item #564 |
|
|
UB2.13 |
Optional[List[str]] |
optional |
Uniform Billing Locator 49 (national): Item #565 |
|
|
UB2.14 |
Optional[List[str]] |
optional |
Uniform Billing Locator 56 (state): Item #566 |
|
|
UB2.15 |
Optional[str] |
optional |
Uniform Billing Locator 57 (sational): Item #567 |
|
|
UB2.16 |
Optional[List[str]] |
optional |
Uniform Billing Locator 78 (state): Item #568 |
|
|
UB2.17 |
Optional[str] |
optional |
Special Visit Count: Item #815 |
- class hl7types.hl7.v2_8_2.segments.VAR.VAR
HL7 v2 VAR segment.
VAR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
VAR.1 |
required |
Variance Instance ID: Item #1212 |
||
|
VAR.2 |
str |
required |
Documented Date/Time: Item #1213 |
|
|
VAR.3 |
Optional[str] |
optional |
Stated Variance Date/Time: Item #1214 |
|
|
VAR.4 |
Optional[List[XCN]] |
optional |
Variance Originator: Item #1215 |
|
|
VAR.5 |
Optional[CWE] |
optional |
Variance Classification: Item #1216 |
|
|
VAR.6 |
Optional[List[str]] |
optional |
Variance Description: Item #1217 |
- class hl7types.hl7.v2_8_2.segments.VND.VND
HL7 v2 VND segment.
VND¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
VND.1 |
str |
required |
Set Id - VND: Item #2217 |
|
|
VND.2 |
required |
Vendor Identifier: Item #2218 |
||
|
VND.3 |
Optional[str] |
optional |
Vendor Name: Item #2276 |
|
|
VND.4 |
Optional[EI] |
optional |
Vendor Catalog Number: Item #2219 |
|
|
VND.5 |
Optional[CNE] |
optional |
Primary Vendor Indicator: Item #2220 | Table HL70532 |