v2.2 Segments¶
- class hl7types.hl7.v2_2.segments.ACC.ACC
HL7 v2 ACC segment.
ACC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ACC.1 |
Optional[TS] |
optional |
Accident date / time: Item #527 |
|
|
ACC.2 |
Optional[str] |
optional |
Accident code: Item #528 | Table HL70050 |
|
|
ACC.3 |
Optional[str] |
optional |
Accident location: Item #529 |
- class hl7types.hl7.v2_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_2.segments.AL1.AL1
HL7 v2 AL1 segment.
AL1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
AL1.1 |
str |
required |
Set ID - Allergy: Item #203 |
|
|
AL1.2 |
Optional[str] |
optional |
Allergy Type: Item #204 | Table HL70127 |
|
|
AL1.3 |
required |
Allergy code / mnemonic / description: Item #205 |
||
|
AL1.4 |
Optional[str] |
optional |
Allergy Severity: Item #206 | Table HL70128 |
|
|
AL1.5 |
Optional[str] |
optional |
Allergy Reaction: Item #207 |
|
|
AL1.6 |
Optional[str] |
optional |
Identification Date: Item #208 |
- class hl7types.hl7.v2_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[str] |
optional |
Batch Sending Application: Item #83 |
|
|
BHS.4 |
Optional[str] |
optional |
Batch Sending Facility: Item #84 |
|
|
BHS.5 |
Optional[str] |
optional |
Batch Receiving Application: Item #85 |
|
|
BHS.6 |
Optional[str] |
optional |
Batch Receiving Facility: Item #86 |
|
|
BHS.7 |
Optional[TS] |
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 |
- class hl7types.hl7.v2_2.segments.BLG.BLG
HL7 v2 BLG segment.
BLG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
BLG.1 |
Optional[str] |
optional |
When to Charge: Item #234 | Table HL70100 |
|
|
BLG.2 |
Optional[str] |
optional |
Charge Type: Item #235 | Table HL70122 |
|
|
BLG.3 |
Optional[str] |
optional |
Account ID: Item #236 |
- class hl7types.hl7.v2_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 #94 |
|
|
BTS.3 |
Optional[List[str]] |
optional |
Batch Totals: Item #95 |
- class hl7types.hl7.v2_2.segments.DG1.DG1
HL7 v2 DG1 segment.
DG1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DG1.1 |
str |
required |
Set ID - diagnosis: Item #375 |
|
|
DG1.2 |
str |
required |
Diagnosis coding method: Item #376 | Table HL70053 |
|
|
DG1.3 |
Optional[str] |
optional |
Diagnosis code: Item #377 | Table HL70051 |
|
|
DG1.4 |
Optional[str] |
optional |
Diagnosis description: Item #378 |
|
|
DG1.5 |
Optional[TS] |
optional |
Diagnosis date / time: Item #379 |
|
|
DG1.6 |
str |
required |
Diagnosis / DRG type: Item #380 | Table HL70052 |
|
|
DG1.7 |
Optional[CE] |
optional |
Major diagnostic category: Item #381 | Table HL70118 |
|
|
DG1.8 |
Optional[str] |
optional |
Diagnostic related group: Item #382 | Table HL70055 |
|
|
DG1.9 |
Optional[str] |
optional |
DRG approval indicator: Item #383 |
|
|
DG1.10 |
Optional[str] |
optional |
DRG grouper review code: Item #384 | Table HL70056 |
|
|
DG1.11 |
Optional[str] |
optional |
Outlier type: Item #385 | Table HL70083 |
|
|
DG1.12 |
Optional[str] |
optional |
Outlier days: Item #386 |
|
|
DG1.13 |
Optional[str] |
optional |
Outlier cost: Item #387 |
|
|
DG1.14 |
Optional[str] |
optional |
Grouper version and type: Item #388 |
|
|
DG1.15 |
Optional[str] |
optional |
Diagnosis / DRG priority: Item #389 |
|
|
DG1.16 |
Optional[str] |
optional |
Diagnosing clinician: Item #390 |
- class hl7types.hl7.v2_2.segments.DSC.DSC
HL7 v2 DSC segment.
DSC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DSC.1 |
Optional[str] |
optional |
Continuation Pointer: Item #60 |
- class hl7types.hl7.v2_2.segments.DSP.DSP
HL7 v2 DSP segment.
DSP¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
DSP.1 |
Optional[str] |
optional |
Set ID - Display Data: 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_2.segments.ERR.ERR
HL7 v2 ERR segment.
ERR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
ERR.1 |
List[str] |
required |
Error Code and Location: Item #24 | Table HL70060 |
- class hl7types.hl7.v2_2.segments.EVN.EVN
HL7 v2 EVN segment.
EVN¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
EVN.1 |
str |
required |
Event Type Code: Item #99 | Table HL70003 |
|
|
EVN.2 |
required |
Date / time of event: Item #100 |
||
|
EVN.3 |
Optional[TS] |
optional |
Date / time planned event: Item #101 |
|
|
EVN.4 |
Optional[str] |
optional |
Event Reason Code: Item #102 | Table HL70062 |
|
|
EVN.5 |
Optional[str] |
optional |
Operator ID: Item #103 | Table HL70188 |
- class hl7types.hl7.v2_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[str] |
optional |
File Sending Application: Item #69 |
|
|
FHS.4 |
Optional[str] |
optional |
File Sending Facility: Item #70 |
|
|
FHS.5 |
Optional[str] |
optional |
File Receiving Application: Item #71 |
|
|
FHS.6 |
Optional[str] |
optional |
File Receiving Facility: Item #72 |
|
|
FHS.7 |
Optional[TS] |
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 |
- class hl7types.hl7.v2_2.segments.FT1.FT1
HL7 v2 FT1 segment.
FT1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
FT1.1 |
Optional[str] |
optional |
Set ID - financial transaction: Item #355 |
|
|
FT1.2 |
Optional[str] |
optional |
Transaction ID: Item #356 |
|
|
FT1.3 |
Optional[str] |
optional |
Transaction batch ID: Item #357 |
|
|
FT1.4 |
str |
required |
Transaction date: Item #358 |
|
|
FT1.5 |
Optional[str] |
optional |
Transaction posting date: Item #359 |
|
|
FT1.6 |
str |
required |
Transaction type: Item #360 | Table HL70017 |
|
|
FT1.7 |
required |
Transaction code: Item #361 | Table HL70132 |
||
|
FT1.8 |
Optional[str] |
optional |
Transaction description: Item #362 |
|
|
FT1.9 |
Optional[str] |
optional |
Transaction description - alternate: Item #363 |
|
|
FT1.10 |
Optional[str] |
optional |
Transaction quantity: Item #364 |
|
|
FT1.11 |
Optional[str] |
optional |
Transaction amount - extended: Item #365 |
|
|
FT1.12 |
Optional[str] |
optional |
Transaction amount - unit: Item #366 |
|
|
FT1.13 |
Optional[CE] |
optional |
Department code: Item #367 | Table HL70049 |
|
|
FT1.14 |
str |
required |
Insurance plan ID: Item #368 | Table HL70072 |
|
|
FT1.15 |
Optional[str] |
optional |
Insurance amount: Item #369 |
|
|
FT1.16 |
Optional[str] |
optional |
Assigned Patient Location: Item #133 | Table HL70079 |
|
|
FT1.17 |
Optional[str] |
optional |
Fee schedule: Item #370 | Table HL70024 |
|
|
FT1.18 |
Optional[str] |
optional |
Patient type: Item #148 | Table HL70018 |
|
|
FT1.19 |
Optional[List[CE]] |
optional |
Diagnosis code: Item #371 | Table HL70051 |
|
|
FT1.20 |
Optional[str] |
optional |
Performed by code: Item #372 | Table HL70084 |
|
|
FT1.21 |
Optional[str] |
optional |
Ordered by code: Item #373 |
|
|
FT1.22 |
Optional[str] |
optional |
Unit cost: Item #374 |
|
|
FT1.23 |
Optional[str] |
optional |
Filler Order Number: Item #217 |
- class hl7types.hl7.v2_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_2.segments.GT1.GT1
HL7 v2 GT1 segment.
GT1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
GT1.1 |
str |
required |
Set ID - guarantor: Item #405 |
|
|
GT1.2 |
Optional[str] |
optional |
Guarantor number: Item #406 |
|
|
GT1.3 |
required |
Guarantor name: Item #407 |
||
|
GT1.4 |
Optional[PN] |
optional |
Guarantor spouse name: Item #408 |
|
|
GT1.5 |
Optional[AD] |
optional |
Guarantor address: Item #409 |
|
|
GT1.6 |
Optional[List[str]] |
optional |
Guarantor phone number - home: Item #410 |
|
|
GT1.7 |
Optional[List[str]] |
optional |
Guarantor phone number - business: Item #411 |
|
|
GT1.8 |
Optional[str] |
optional |
Guarantor date of birth: Item #412 |
|
|
GT1.9 |
Optional[str] |
optional |
Guarantor sex: Item #413 | Table HL70001 |
|
|
GT1.10 |
Optional[str] |
optional |
Guarantor type: Item #414 | Table HL70068 |
|
|
GT1.11 |
Optional[str] |
optional |
Guarantor relationship: Item #415 | Table HL70063 |
|
|
GT1.12 |
Optional[str] |
optional |
Guarantor social security number: 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[str] |
optional |
Guarantor employer name: Item #420 |
|
|
GT1.17 |
Optional[AD] |
optional |
Guarantor employer address: Item #421 |
|
|
GT1.18 |
Optional[List[str]] |
optional |
Guarantor employ phone number: Item #422 |
|
|
GT1.19 |
Optional[str] |
optional |
Guarantor employee ID number: Item #423 |
|
|
GT1.20 |
Optional[str] |
optional |
Guarantor employment status: Item #424 | Table HL70066 |
|
|
GT1.21 |
Optional[str] |
optional |
Guarantor organization: Item #425 |
- class hl7types.hl7.v2_2.segments.IN1.IN1
HL7 v2 IN1 segment.
IN1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN1.1 |
str |
required |
Set ID - insurance: Item #426 |
|
|
IN1.2 |
str |
required |
Insurance plan ID: Item #368 | Table HL70072 |
|
|
IN1.3 |
str |
required |
Insurance company ID: Item #428 |
|
|
IN1.4 |
Optional[str] |
optional |
Insurance company name: Item #429 |
|
|
IN1.5 |
Optional[AD] |
optional |
Insurance company address: Item #430 |
|
|
IN1.6 |
Optional[PN] |
optional |
Insurance company contact pers: Item #431 |
|
|
IN1.7 |
Optional[List[str]] |
optional |
Insurance company phone number: Item #432 |
|
|
IN1.8 |
Optional[str] |
optional |
Group number: Item #433 |
|
|
IN1.9 |
Optional[str] |
optional |
Group name: Item #434 |
|
|
IN1.10 |
Optional[str] |
optional |
Insured’s group employer ID: Item #435 |
|
|
IN1.11 |
Optional[str] |
optional |
Insured’s group employer 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[str] |
optional |
Authorization information: Item #439 |
|
|
IN1.15 |
Optional[str] |
optional |
Plan type: Item #440 | Table HL70086 |
|
|
IN1.16 |
Optional[PN] |
optional |
Name of insured: Item #441 |
|
|
IN1.17 |
Optional[str] |
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[AD] |
optional |
Insured’s address: Item #444 |
|
|
IN1.20 |
Optional[str] |
optional |
Assignment of benefits: Item #445 | Table HL70135 |
|
|
IN1.21 |
Optional[str] |
optional |
Coordination of benefits: Item #446 | Table HL70173 |
|
|
IN1.22 |
Optional[str] |
optional |
Coordination of benefits - priority: Item #447 |
|
|
IN1.23 |
Optional[str] |
optional |
Notice of admission code: Item #448 | Table HL70136 |
|
|
IN1.24 |
Optional[str] |
optional |
Notice of admission date: Item #449 |
|
|
IN1.25 |
Optional[str] |
optional |
Report of eligibility code: Item #450 |
|
|
IN1.26 |
Optional[str] |
optional |
Report of eligibility date: Item #451 |
|
|
IN1.27 |
Optional[str] |
optional |
Release information code: Item #452 | Table HL70093 |
|
|
IN1.28 |
Optional[str] |
optional |
Pre-admit certification (PAC): Item #453 |
|
|
IN1.29 |
Optional[TS] |
optional |
Verification date / time: Item #454 |
|
|
IN1.30 |
Optional[str] |
optional |
Verification by: Item #455 |
|
|
IN1.31 |
Optional[str] |
optional |
Type of agreement code: Item #456 | Table HL70098 |
|
|
IN1.32 |
Optional[str] |
optional |
Billing status: Item #457 | Table HL70022 |
|
|
IN1.33 |
Optional[str] |
optional |
Lifetime reserve days: Item #458 |
|
|
IN1.34 |
Optional[str] |
optional |
Delay before lifetime reserve days: Item #459 |
|
|
IN1.35 |
Optional[str] |
optional |
Company plan code: Item #460 | Table HL70042 |
|
|
IN1.36 |
Optional[str] |
optional |
Policy number: Item #461 |
|
|
IN1.37 |
Optional[str] |
optional |
Policy deductible: Item #462 |
|
|
IN1.38 |
Optional[str] |
optional |
Policy limit - amount: Item #463 |
|
|
IN1.39 |
Optional[str] |
optional |
Policy limit - days: Item #464 |
|
|
IN1.40 |
Optional[str] |
optional |
Room rate - semi-private: Item #465 |
|
|
IN1.41 |
Optional[str] |
optional |
Room rate - private: Item #466 |
|
|
IN1.42 |
Optional[CE] |
optional |
Insured’s employment status: Item #467 | Table HL70066 |
|
|
IN1.43 |
Optional[str] |
optional |
Insured’s sex: Item #468 | Table HL70001 |
|
|
IN1.44 |
Optional[AD] |
optional |
Insured’s employer address: Item #469 |
|
|
IN1.45 |
Optional[str] |
optional |
Verification status: Item #470 |
|
|
IN1.46 |
Optional[str] |
optional |
Prior insurance plan ID: Item #471 | Table HL70072 |
- class hl7types.hl7.v2_2.segments.IN2.IN2
HL7 v2 IN2 segment.
IN2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN2.1 |
Optional[str] |
optional |
Insured’s employee ID: Item #472 |
|
|
IN2.2 |
Optional[str] |
optional |
Insured’s social security number: Item #473 |
|
|
IN2.3 |
Optional[str] |
optional |
Insured’s employer name: Item #474 |
|
|
IN2.4 |
Optional[str] |
optional |
Employer information data: Item #475 | Table HL70139 |
|
|
IN2.5 |
Optional[str] |
optional |
Mail claim party: Item #476 | Table HL70137 |
|
|
IN2.6 |
Optional[str] |
optional |
Medicare health insurance card number: Item #477 |
|
|
IN2.7 |
Optional[PN] |
optional |
Medicaid case name: Item #478 |
|
|
IN2.8 |
Optional[str] |
optional |
Medicaid case number: Item #479 |
|
|
IN2.9 |
Optional[PN] |
optional |
Champus sponsor name: Item #480 |
|
|
IN2.10 |
Optional[str] |
optional |
Champus ID number: Item #481 |
|
|
IN2.11 |
Optional[str] |
optional |
Dependent of champus recipient: Item #482 |
|
|
IN2.12 |
Optional[str] |
optional |
Champus organization: Item #483 |
|
|
IN2.13 |
Optional[str] |
optional |
Champus station: Item #484 |
|
|
IN2.14 |
Optional[str] |
optional |
Champus service: Item #485 | Table HL70140 |
|
|
IN2.15 |
Optional[str] |
optional |
Champus rank / grade: Item #486 | Table HL70141 |
|
|
IN2.16 |
Optional[str] |
optional |
Champus status: Item #487 | Table HL70142 |
|
|
IN2.17 |
Optional[str] |
optional |
Champus retire date: Item #488 |
|
|
IN2.18 |
Optional[str] |
optional |
Champus non-availability certification 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 #531 |
|
|
IN2.22 |
Optional[PN] |
optional |
Special coverage approval name: Item #493 |
|
|
IN2.23 |
Optional[str] |
optional |
Special coverage approval title: Item #494 |
|
|
IN2.24 |
Optional[List[str]] |
optional |
Non-covered insurance code: Item #495 | Table HL70143 |
|
|
IN2.25 |
Optional[str] |
optional |
Payor ID: Item #496 |
|
|
IN2.26 |
Optional[str] |
optional |
Payor subscriber ID: Item #497 |
|
|
IN2.27 |
Optional[str] |
optional |
Eligibility source: Item #498 | Table HL70144 |
|
|
IN2.28 |
Optional[List[str]] |
optional |
Room coverage type / amount: Item #499 | Table HL70145 |
|
|
IN2.29 |
Optional[List[str]] |
optional |
Policy type / amount: Item #500 | Table HL70147 |
|
|
IN2.30 |
Optional[str] |
optional |
Daily deductible: Item #501 |
- class hl7types.hl7.v2_2.segments.IN3.IN3
HL7 v2 IN3 segment.
IN3¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
IN3.1 |
str |
required |
Set ID - insurance certification: Item #502 |
|
|
IN3.2 |
Optional[str] |
optional |
Certification number: Item #503 |
|
|
IN3.3 |
Optional[str] |
optional |
Certified by: Item #504 |
|
|
IN3.4 |
Optional[str] |
optional |
Certification required: Item #505 | Table HL70136 |
|
|
IN3.5 |
Optional[str] |
optional |
Penalty: Item #506 | Table HL70148 |
|
|
IN3.6 |
Optional[TS] |
optional |
Certification date / time: Item #507 |
|
|
IN3.7 |
Optional[TS] |
optional |
Certification modify date / time: Item #508 |
|
|
IN3.8 |
Optional[str] |
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[str] |
optional |
Days: Item #512 | Table HL70149 |
|
|
IN3.12 |
Optional[CE] |
optional |
Non-concur code / description: Item #513 |
|
|
IN3.13 |
Optional[TS] |
optional |
Non-concur effective date / time: Item #514 |
|
|
IN3.14 |
Optional[str] |
optional |
Physician reviewer: Item #515 |
|
|
IN3.15 |
Optional[str] |
optional |
Certification contact: Item #516 |
|
|
IN3.16 |
Optional[List[str]] |
optional |
Certification contact phone number: Item #517 |
|
|
IN3.17 |
Optional[CE] |
optional |
Appeal reason: Item #518 |
|
|
IN3.18 |
Optional[CE] |
optional |
Certification agency: Item #519 |
|
|
IN3.19 |
Optional[List[str]] |
optional |
Certification agency phone number: Item #520 |
|
|
IN3.20 |
Optional[List[str]] |
optional |
Pre-certification required / window: Item #521 | Table HL70150 |
|
|
IN3.21 |
Optional[str] |
optional |
Case manager: Item #522 |
|
|
IN3.22 |
Optional[str] |
optional |
Second opinion date: Item #523 |
|
|
IN3.23 |
Optional[str] |
optional |
Second opinion status: Item #524 | Table HL70151 |
|
|
IN3.24 |
Optional[str] |
optional |
Second opinion documentation received: Item #525 | Table HL70152 |
|
|
IN3.25 |
Optional[str] |
optional |
Second opinion practitioner: Item #526 |
- class hl7types.hl7.v2_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[TS] |
optional |
Event completion date / time: Item #668 |
|
|
MFA.4 |
required |
Error return code and/or text: Item #669 | Table HL70181 |
||
|
MFA.5 |
Optional[List[CE]] |
optional |
Primary key value: Item #667 |
- class hl7types.hl7.v2_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[TS] |
optional |
Effective date / time: Item #662 |
|
|
MFE.4 |
Optional[List[CE]] |
optional |
Primary key value: Item #667 |
- class hl7types.hl7.v2_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[str] |
optional |
Master file application identifier: Item #659 | Table HL70176 |
|
|
MFI.3 |
str |
required |
File-level event code: Item #660 | Table HL70178 |
|
|
MFI.4 |
Optional[TS] |
optional |
Entered date / time: Item #661 |
|
|
MFI.5 |
Optional[TS] |
optional |
Effective date / time: Item #662 |
|
|
MFI.6 |
str |
required |
Response level code: Item #663 | Table HL70179 |
- class hl7types.hl7.v2_2.segments.MRG.MRG
HL7 v2 MRG segment.
MRG¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MRG.1 |
str |
required |
Prior Patient ID - Internal: Item #211 |
|
|
MRG.2 |
Optional[str] |
optional |
Prior Alternate Patient ID: Item #212 |
|
|
MRG.3 |
Optional[str] |
optional |
Prior Patient Account Number: Item #213 |
|
|
MRG.4 |
Optional[str] |
optional |
Prior Patient ID - External: Item #214 |
- class hl7types.hl7.v2_2.segments.MSA.MSA
HL7 v2 MSA segment.
MSA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
MSA.1 |
str |
required |
Acknowledgement code: Item #18 | Table HL70008 |
|
|
MSA.2 |
str |
required |
Message Control ID: Item #10 |
|
|
MSA.3 |
Optional[str] |
optional |
Text Message: Item #20 |
|
|
MSA.4 |
Optional[str] |
optional |
Expected Sequence Number: Item #21 |
|
|
MSA.5 |
Optional[str] |
optional |
Delayed Acknowledgement type: Item #22 | Table HL70102 |
|
|
MSA.6 |
Optional[CE] |
optional |
Error Condition: Item #23 |
- class hl7types.hl7.v2_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[str] |
optional |
Sending application: Item #3 |
|
|
MSH.4 |
Optional[str] |
optional |
Sending facility: Item #4 |
|
|
MSH.5 |
Optional[str] |
optional |
Receiving application: Item #5 |
|
|
MSH.6 |
Optional[str] |
optional |
Receiving facility: Item #6 |
|
|
MSH.7 |
Optional[TS] |
optional |
Date / Time of message: Item #7 |
|
|
MSH.8 |
Optional[str] |
optional |
Security: Item #8 |
|
|
MSH.9 |
str |
required |
Message type: Item #9 | Table HL70076 |
|
|
MSH.10 |
str |
required |
Message Control ID: Item #10 |
|
|
MSH.11 |
str |
required |
Processing ID: Item #11 | Table HL70103 |
|
|
MSH.12 |
str |
required |
Version ID: Item #12 | Table HL70104 |
|
|
MSH.13 |
Optional[str] |
optional |
Sequence number: Item #13 |
|
|
MSH.14 |
Optional[str] |
optional |
Continuation pointer: Item #14 |
|
|
MSH.15 |
Optional[str] |
optional |
Accept acknowledgement type: Item #15 | Table HL70155 |
|
|
MSH.16 |
Optional[str] |
optional |
Application acknowledgement type: Item #16 | Table HL70155 |
|
|
MSH.17 |
Optional[str] |
optional |
Country code: Item #17 |
- class hl7types.hl7.v2_2.segments.NCK.NCK
HL7 v2 NCK segment.
NCK¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NCK.1 |
required |
System Date/Time: Item #742 |
- class hl7types.hl7.v2_2.segments.NK1.NK1
HL7 v2 NK1 segment.
NK1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NK1.1 |
str |
required |
Set ID - Next of Kin: Item #190 |
|
|
NK1.2 |
Optional[PN] |
optional |
Name: Item #191 |
|
|
NK1.3 |
Optional[CE] |
optional |
Relationship: Item #192 | Table HL70063 |
|
|
NK1.4 |
Optional[AD] |
optional |
Address: Item #193 |
|
|
NK1.5 |
Optional[List[str]] |
optional |
Phone Number: Item #194 |
|
|
NK1.6 |
Optional[str] |
optional |
Business Phone Number: Item #195 |
|
|
NK1.7 |
Optional[CE] |
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: Item #199 |
|
|
NK1.11 |
Optional[str] |
optional |
Next of kin job code / class: Item #200 |
|
|
NK1.12 |
Optional[str] |
optional |
Next of Kin Employee Number: Item #201 |
|
|
NK1.13 |
Optional[str] |
optional |
Organization Name: Item #202 |
- class hl7types.hl7.v2_2.segments.NPU.NPU
HL7 v2 NPU segment.
NPU¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NPU.1 |
str |
required |
Bed Location: Item #209 | Table HL70079 |
|
|
NPU.2 |
Optional[str] |
optional |
Bed Status: Item #170 | Table HL70116 |
- class hl7types.hl7.v2_2.segments.NSC.NSC
HL7 v2 NSC segment.
NSC¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NSC.1 |
str |
required |
Network Change Type: Item #758 |
|
|
NSC.2 |
Optional[str] |
optional |
Current CPU: Item #759 |
|
|
NSC.3 |
Optional[str] |
optional |
Current Fileserver: Item #760 |
|
|
NSC.4 |
Optional[str] |
optional |
Current Application: Item #761 |
|
|
NSC.5 |
Optional[str] |
optional |
Current Facility: Item #762 |
|
|
NSC.6 |
Optional[str] |
optional |
New CPU: Item #763 |
|
|
NSC.7 |
Optional[str] |
optional |
New Fileserver: Item #764 |
|
|
NSC.8 |
Optional[str] |
optional |
New Application: Item #765 |
|
|
NSC.9 |
Optional[str] |
optional |
New Facility: Item #766 |
- class hl7types.hl7.v2_2.segments.NST.NST
HL7 v2 NST segment.
NST¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NST.1 |
str |
required |
Statistics Available: Item #743 | Table HL70136 |
|
|
NST.2 |
Optional[str] |
optional |
Source Identifier: Item #744 |
|
|
NST.3 |
Optional[str] |
optional |
Source Type: Item #745 |
|
|
NST.4 |
Optional[TS] |
optional |
Statistics Start: Item #746 |
|
|
NST.5 |
Optional[TS] |
optional |
Statistics End: Item #747 |
|
|
NST.6 |
Optional[str] |
optional |
Receive Character Count: Item #748 |
|
|
NST.7 |
Optional[str] |
optional |
Send Character Count: Item #749 |
|
|
NST.8 |
Optional[str] |
optional |
Message Received: Item #750 |
|
|
NST.9 |
Optional[str] |
optional |
Message Sent: Item #751 |
|
|
NST.10 |
Optional[str] |
optional |
Checksum Errors Received: Item #752 |
|
|
NST.11 |
Optional[str] |
optional |
Length Errors Received: Item #753 |
|
|
NST.12 |
Optional[str] |
optional |
Other Errors Received: Item #754 |
|
|
NST.13 |
Optional[str] |
optional |
Connect Timeouts: Item #755 |
|
|
NST.14 |
Optional[str] |
optional |
Receive Timeouts: Item #756 |
|
|
NST.15 |
Optional[str] |
optional |
Network Errors: Item #757 |
- class hl7types.hl7.v2_2.segments.NTE.NTE
HL7 v2 NTE segment.
NTE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
NTE.1 |
Optional[str] |
optional |
Set ID - Notes and Comments: Item #96 |
|
|
NTE.2 |
Optional[str] |
optional |
Source of Comment: Item #97 | Table HL70105 |
|
|
NTE.3 |
Optional[List[FT]] |
optional |
Comment: Item #98 |
- class hl7types.hl7.v2_2.segments.OBR.OBR
HL7 v2 OBR segment.
OBR¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OBR.1 |
Optional[str] |
optional |
Set ID - Observation Request: Item #237 |
|
|
OBR.2 |
Optional[str] |
optional |
Placer Order Number: Item #216 |
|
|
OBR.3 |
Optional[str] |
optional |
Filler Order Number: Item #217 |
|
|
OBR.4 |
required |
Universal Service ID: Item #238 |
||
|
OBR.5 |
Optional[str] |
optional |
Priority (not used): Item #239 |
|
|
OBR.6 |
Optional[TS] |
optional |
Requested date / time (not used): Item #240 |
|
|
OBR.7 |
Optional[TS] |
optional |
Observation date / time: Item #241 |
|
|
OBR.8 |
Optional[TS] |
optional |
Observation end date / time: Item #242 |
|
|
OBR.9 |
Optional[str] |
optional |
Collection Volume: Item #243 |
|
|
OBR.10 |
Optional[List[str]] |
optional |
Collector Identifier: Item #244 |
|
|
OBR.11 |
Optional[str] |
optional |
Specimen action code: Item #245 | Table HL70065 |
|
|
OBR.12 |
Optional[CE] |
optional |
Danger Code: Item #246 |
|
|
OBR.13 |
Optional[str] |
optional |
Relevant clinical information: Item #247 |
|
|
OBR.14 |
Optional[TS] |
optional |
Specimen received date / time: Item #248 |
|
|
OBR.15 |
Optional[str] |
optional |
Specimen source: Item #249 | Table HL70070 |
|
|
OBR.16 |
Optional[str] |
optional |
Ordering Provider: Item #226 |
|
|
OBR.17 |
Optional[List[str]] |
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[TS] |
optional |
Results report / status change - date / time: Item #255 |
|
|
OBR.23 |
Optional[str] |
optional |
Charge to Practice: Item #256 |
|
|
OBR.24 |
Optional[str] |
optional |
Diagnostic service section ID: Item #257 | Table HL70074 |
|
|
OBR.25 |
Optional[str] |
optional |
Result Status: Item #258 | Table HL70123 |
|
|
OBR.26 |
Optional[str] |
optional |
Parent Result: Item #259 |
|
|
OBR.27 |
Optional[List[TQ]] |
optional |
Quantity / timing: Item #221 |
|
|
OBR.28 |
Optional[List[str]] |
optional |
Result Copies To: Item #260 |
|
|
OBR.29 |
Optional[str] |
optional |
Parent Number: Item #261 |
|
|
OBR.30 |
Optional[str] |
optional |
Transportation Mode: Item #262 | Table HL70124 |
|
|
OBR.31 |
Optional[List[CE]] |
optional |
Reason for Study: Item #263 |
|
|
OBR.32 |
Optional[str] |
optional |
Principal Result Interpreter: Item #264 |
|
|
OBR.33 |
Optional[List[str]] |
optional |
Assistant Result Interpreter: Item #265 |
|
|
OBR.34 |
Optional[List[str]] |
optional |
Technician: Item #266 |
|
|
OBR.35 |
Optional[List[str]] |
optional |
Transcriptionist: Item #267 |
|
|
OBR.36 |
Optional[TS] |
optional |
Scheduled date / time: Item #268 |
- class hl7types.hl7.v2_2.segments.OBX.OBX
HL7 v2 OBX segment.
OBX¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OBX.1 |
Optional[str] |
optional |
Set ID - Observational Simple: Item #569 |
|
|
OBX.2 |
str |
required |
Value Type: Item #570 | Table HL70125 |
|
|
OBX.3 |
required |
Observation Identifier: Item #571 |
||
|
OBX.4 |
Optional[str] |
optional |
Observation Sub-ID: Item #572 |
|
|
OBX.5 |
Optional[str] |
optional |
Observation Value: Item #573 |
|
|
OBX.6 |
Optional[CE] |
optional |
Units: Item #574 |
|
|
OBX.7 |
Optional[str] |
optional |
References Range: Item #575 |
|
|
OBX.8 |
Optional[List[str]] |
optional |
Abnormal Flags: Item #576 | Table HL70078 |
|
|
OBX.9 |
Optional[str] |
optional |
Probability: Item #577 |
|
|
OBX.10 |
Optional[str] |
optional |
Nature of Abnormal Test: Item #578 | Table HL70080 |
|
|
OBX.11 |
str |
required |
Observation result status: Item #579 | Table HL70085 |
|
|
OBX.12 |
Optional[TS] |
optional |
Effective date last observation normal values: Item #580 |
|
|
OBX.13 |
Optional[str] |
optional |
User Defined Access Checks: Item #581 |
|
|
OBX.14 |
Optional[TS] |
optional |
Date / time of the observation: Item #582 |
|
|
OBX.15 |
Optional[CE] |
optional |
Producer’s ID: Item #583 |
|
|
OBX.16 |
Optional[str] |
optional |
Responsible Observer: Item #584 |
- class hl7types.hl7.v2_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[CE]] |
optional |
Service Period: Item #270 |
|
|
ODS.3 |
Optional[List[CE]] |
optional |
Diet, Supplement, or Preference Code: Item #271 |
|
|
ODS.4 |
Optional[List[str]] |
optional |
Text Instruction: Item #272 |
- class hl7types.hl7.v2_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[CE]] |
optional |
Service Period: Item #270 |
|
|
ODT.3 |
Optional[List[str]] |
optional |
Text Instruction: Item #272 |
- class hl7types.hl7.v2_2.segments.OM1.OM1
HL7 v2 OM1 segment.
OM1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM1.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM1.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM1.3 |
required |
Producer’s test / observation ID: Item #587 |
||
|
OM1.4 |
Optional[List[str]] |
optional |
Permitted Data Types: Item #588 | Table HL70125 |
|
|
OM1.5 |
str |
required |
Specimen Required: Item #589 | Table HL70136 |
|
|
OM1.6 |
required |
Producer ID: Item #590 |
||
|
OM1.7 |
Optional[TX] |
optional |
Observation Description: Item #591 |
|
|
OM1.8 |
Optional[CE] |
optional |
Other test / observation IDs for the observation: Item #592 |
|
|
OM1.9 |
List[str] |
required |
Other Names: Item #593 |
|
|
OM1.10 |
Optional[str] |
optional |
Preferred Report Name for the Observation: Item #594 |
|
|
OM1.11 |
Optional[str] |
optional |
Preferred Short Name or Mnemonic for Observation: Item #595 |
|
|
OM1.12 |
Optional[str] |
optional |
Preferred Long Name for the Observation: Item #596 |
|
|
OM1.13 |
Optional[str] |
optional |
Orderability: Item #597 | Table HL70136 |
|
|
OM1.14 |
Optional[List[CE]] |
optional |
Identity of instrument used to perform this study: Item #598 |
|
|
OM1.15 |
Optional[List[CE]] |
optional |
Coded Representation of Method: Item #599 |
|
|
OM1.16 |
Optional[str] |
optional |
Portable: Item #600 | Table HL70136 |
|
|
OM1.17 |
Optional[List[str]] |
optional |
Observation producing department / section: Item #601 |
|
|
OM1.18 |
Optional[str] |
optional |
Telephone Number of Section: Item #602 |
|
|
OM1.19 |
str |
required |
Nature of test / observation: Item #603 | Table HL70174 |
|
|
OM1.20 |
Optional[CE] |
optional |
Report Subheader: Item #604 |
|
|
OM1.21 |
Optional[str] |
optional |
Report Display Order: Item #605 |
|
|
OM1.22 |
required |
Date / time stamp for any change in definition for obs: Item #606 |
||
|
OM1.23 |
Optional[TS] |
optional |
Effective date / time of change: Item #607 |
|
|
OM1.24 |
Optional[str] |
optional |
Typical Turn-around Time: Item #608 |
|
|
OM1.25 |
Optional[str] |
optional |
Processing Time: Item #609 |
|
|
OM1.26 |
Optional[List[str]] |
optional |
Processing Priority: Item #610 | Table HL70168 |
|
|
OM1.27 |
Optional[str] |
optional |
Reporting Priority: Item #611 | Table HL70169 |
|
|
OM1.28 |
Optional[List[CE]] |
optional |
Outside Site(s) Where Observation may be Performed: Item #612 |
|
|
OM1.29 |
Optional[List[AD]] |
optional |
Address of Outside Site(s): Item #613 |
|
|
OM1.30 |
Optional[List[str]] |
optional |
Phone Number of Outside Site: Item #614 |
|
|
OM1.31 |
Optional[str] |
optional |
Confidentiality Code: Item #615 | Table HL70177 |
|
|
OM1.32 |
Optional[List[CE]] |
optional |
Observations required to interpret the observation: Item #616 |
|
|
OM1.33 |
Optional[TX] |
optional |
Interpretation of Observations: Item #617 |
|
|
OM1.34 |
Optional[List[CE]] |
optional |
Contraindications to Observations: Item #618 |
|
|
OM1.35 |
Optional[List[CE]] |
optional |
Reflex tests / observations: Item #619 |
|
|
OM1.36 |
Optional[str] |
optional |
Rules that Trigger Reflex Testing: Item #620 |
|
|
OM1.37 |
Optional[List[CE]] |
optional |
Fixed Canned Message: Item #621 |
|
|
OM1.38 |
Optional[TX] |
optional |
Patient Preparation: Item #622 |
|
|
OM1.39 |
Optional[CE] |
optional |
Procedure Medication: Item #623 |
|
|
OM1.40 |
Optional[TX] |
optional |
Factors that may affect the observation: Item #624 |
|
|
OM1.41 |
Optional[List[str]] |
optional |
Test / observation performance schedule: Item #625 |
|
|
OM1.42 |
Optional[TX] |
optional |
Description of Test Methods: Item #626 |
- class hl7types.hl7.v2_2.segments.OM2.OM2
HL7 v2 OM2 segment.
OM2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM2.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM2.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM2.3 |
Optional[CE] |
optional |
Units of Measure: Item #627 |
|
|
OM2.4 |
Optional[str] |
optional |
Range of Decimal Precision: Item #628 |
|
|
OM2.5 |
Optional[CE] |
optional |
Corresponding SI Units of Measure: Item #629 |
|
|
OM2.6 |
Optional[List[TX]] |
optional |
SI Conversion Factor: Item #630 |
|
|
OM2.7 |
Optional[List[str]] |
optional |
Reference (normal) range - ordinal & continuous observations: Item #631 |
|
|
OM2.8 |
Optional[str] |
optional |
Critical range for ordinal and continuous observations: Item #632 |
|
|
OM2.9 |
Optional[str] |
optional |
Absolute range for ordinal and continuous observations: Item #633 |
|
|
OM2.10 |
Optional[List[str]] |
optional |
Delta Check Criteria: Item #634 |
|
|
OM2.11 |
Optional[str] |
optional |
Minimum Meaningful Increments: Item #635 |
- class hl7types.hl7.v2_2.segments.OM3.OM3
HL7 v2 OM3 segment.
OM3¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM3.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM3.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM3.3 |
Optional[str] |
optional |
Preferred Coding System: Item #636 |
|
|
OM3.4 |
Optional[List[CE]] |
optional |
Valid coded answers: Item #637 |
|
|
OM3.5 |
Optional[List[CE]] |
optional |
Normal test codes for categorical observations: Item #638 |
|
|
OM3.6 |
Optional[CE] |
optional |
Abnormal test codes for categorical observations: Item #639 |
|
|
OM3.7 |
Optional[CE] |
optional |
Critical test codes for categorical observations: Item #640 |
|
|
OM3.8 |
Optional[str] |
optional |
Data Type: Item #641 |
- class hl7types.hl7.v2_2.segments.OM4.OM4
HL7 v2 OM4 segment.
OM4¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM4.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM4.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM4.3 |
Optional[str] |
optional |
Derived Specimen: Item #642 | Table HL70170 |
|
|
OM4.4 |
Optional[TX] |
optional |
Container Description: Item #643 |
|
|
OM4.5 |
Optional[str] |
optional |
Container Volume: Item #644 |
|
|
OM4.6 |
Optional[CE] |
optional |
Container Units: Item #645 |
|
|
OM4.7 |
Optional[CE] |
optional |
Specimen: Item #646 |
|
|
OM4.8 |
Optional[CE] |
optional |
Additive: Item #647 |
|
|
OM4.9 |
Optional[TX] |
optional |
Preparation: Item #648 |
|
|
OM4.10 |
Optional[TX] |
optional |
Special Handling Requirements: Item #649 |
|
|
OM4.11 |
Optional[str] |
optional |
Normal Collection Volume: Item #650 |
|
|
OM4.12 |
Optional[str] |
optional |
Minimum Collection Volume: Item #651 |
|
|
OM4.13 |
Optional[TX] |
optional |
Specimen Requirements: Item #652 |
|
|
OM4.14 |
Optional[List[str]] |
optional |
Specimen Priorities: Item #653 | Table HL70027 |
|
|
OM4.15 |
Optional[str] |
optional |
Specimen Retention Time: Item #654 |
- class hl7types.hl7.v2_2.segments.OM5.OM5
HL7 v2 OM5 segment.
OM5¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM5.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM5.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM5.3 |
Optional[List[CE]] |
optional |
Tests / observations included within an ordered test battery: Item #655 |
|
|
OM5.4 |
Optional[str] |
optional |
Observation ID Suffixes: Item #656 |
- class hl7types.hl7.v2_2.segments.OM6.OM6
HL7 v2 OM6 segment.
OM6¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
OM6.1 |
Optional[str] |
optional |
Segment Type ID: Item #585 |
|
|
OM6.2 |
Optional[str] |
optional |
Sequence Number - Test/ Observation Master File: Item #586 |
|
|
OM6.3 |
Optional[TX] |
optional |
Derivation Rule: Item #657 |
- class hl7types.hl7.v2_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[str] |
optional |
Placer Order Number: Item #216 |
|
|
ORC.3 |
Optional[str] |
optional |
Filler Order Number: Item #217 |
|
|
ORC.4 |
Optional[str] |
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.7 |
Optional[List[TQ]] |
optional |
Quantity / timing: Item #221 |
|
|
ORC.8 |
Optional[str] |
optional |
Parent: Item #222 |
|
|
ORC.9 |
Optional[TS] |
optional |
Date / time of transaction: Item #223 |
|
|
ORC.10 |
Optional[str] |
optional |
Entered By: Item #224 |
|
|
ORC.11 |
Optional[str] |
optional |
Verified By: Item #225 |
|
|
ORC.12 |
Optional[str] |
optional |
Ordering Provider: Item #226 |
|
|
ORC.13 |
Optional[str] |
optional |
Enterer’s Location: Item #227 |
|
|
ORC.14 |
Optional[List[str]] |
optional |
Call Back Phone Number: Item #228 |
|
|
ORC.15 |
Optional[TS] |
optional |
Order effective date / time: Item #229 |
|
|
ORC.16 |
Optional[CE] |
optional |
Order Control Code Reason: Item #230 |
|
|
ORC.17 |
Optional[CE] |
optional |
Entering Organization: Item #231 |
|
|
ORC.18 |
Optional[CE] |
optional |
Entering Device: Item #232 |
|
|
ORC.19 |
Optional[str] |
optional |
Action by: Item #233 |
- class hl7types.hl7.v2_2.segments.PID.PID
HL7 v2 PID segment.
PID¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PID.1 |
Optional[str] |
optional |
Set ID - Patient ID: Item #104 |
|
|
PID.2 |
Optional[str] |
optional |
Patient ID (External ID): Item #105 |
|
|
PID.3 |
List[str] |
required |
Patient ID (Internal ID): Item #106 |
|
|
PID.4 |
Optional[str] |
optional |
Alternate Patient ID: Item #107 |
|
|
PID.5 |
required |
Patient Name: Item #108 |
||
|
PID.6 |
Optional[str] |
optional |
Mother’s Maiden Name: Item #109 |
|
|
PID.7 |
Optional[TS] |
optional |
Date of Birth: Item #110 |
|
|
PID.8 |
Optional[str] |
optional |
Sex: Item #111 | Table HL70001 |
|
|
PID.9 |
Optional[List[PN]] |
optional |
Patient Alias: Item #112 |
|
|
PID.10 |
Optional[str] |
optional |
Race: Item #113 | Table HL70005 |
|
|
PID.11 |
Optional[List[AD]] |
optional |
Patient Address: Item #114 |
|
|
PID.12 |
Optional[str] |
optional |
County code: Item #115 |
|
|
PID.13 |
Optional[List[str]] |
optional |
Phone Number - Home: Item #116 |
|
|
PID.14 |
Optional[List[str]] |
optional |
Phone Number - Business: Item #117 |
|
|
PID.15 |
Optional[str] |
optional |
Language - Patient: Item #118 |
|
|
PID.16 |
Optional[str] |
optional |
Marital Status: Item #119 | Table HL70002 |
|
|
PID.17 |
Optional[str] |
optional |
Religion: Item #120 | Table HL70006 |
|
|
PID.18 |
Optional[str] |
optional |
Patient Account Number: Item #121 |
|
|
PID.19 |
Optional[str] |
optional |
Social security number - patient: Item #122 |
|
|
PID.20 |
Optional[str] |
optional |
Driver’s license number - patient: Item #123 |
|
|
PID.21 |
Optional[str] |
optional |
Mother’s Identifier: Item #124 |
|
|
PID.22 |
Optional[str] |
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 |
|
|
PID.25 |
Optional[str] |
optional |
Birth Order: Item #128 |
|
|
PID.26 |
Optional[List[str]] |
optional |
Citizenship: Item #129 | Table HL70171 |
|
|
PID.27 |
Optional[str] |
optional |
Veterans Military Status: Item #130 |
- class hl7types.hl7.v2_2.segments.PR1.PR1
HL7 v2 PR1 segment.
PR1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PR1.1 |
str |
required |
Set ID - procedure: Item #391 |
|
|
PR1.2 |
List[str] |
required |
Procedure coding method: Item #392 | Table HL70089 |
|
|
PR1.3 |
List[str] |
required |
Procedure code: Item #393 | Table HL70088 |
|
|
PR1.4 |
Optional[List[str]] |
optional |
Procedure description: Item #394 |
|
|
PR1.5 |
required |
Procedure date / time: Item #395 |
||
|
PR1.6 |
str |
required |
Procedure type: Item #396 | Table HL70090 |
|
|
PR1.7 |
Optional[str] |
optional |
Procedure minutes: Item #397 |
|
|
PR1.8 |
Optional[str] |
optional |
Anesthesiologist: Item #398 | Table HL70010 |
|
|
PR1.9 |
Optional[str] |
optional |
Anesthesia code: Item #399 | Table HL70019 |
|
|
PR1.10 |
Optional[str] |
optional |
Anesthesia minutes: Item #400 |
|
|
PR1.11 |
Optional[str] |
optional |
Surgeon: Item #401 | Table HL70010 |
|
|
PR1.12 |
Optional[List[str]] |
optional |
Procedure Practitioner: Item #402 | Table HL70010 |
|
|
PR1.13 |
Optional[str] |
optional |
Consent code: Item #403 | Table HL70059 |
|
|
PR1.14 |
Optional[str] |
optional |
Procedure priority: Item #404 |
- class hl7types.hl7.v2_2.segments.PRA.PRA
HL7 v2 PRA segment.
PRA¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PRA.1 |
str |
required |
PRA - primary key value: Item #685 |
|
|
PRA.2 |
Optional[List[CE]] |
optional |
Practitioner group: Item #686 |
|
|
PRA.3 |
Optional[List[str]] |
optional |
Practitioner Category: Item #687 | Table HL70186 |
|
|
PRA.4 |
Optional[str] |
optional |
Provider Billing: Item #688 | Table HL70187 |
|
|
PRA.5 |
Optional[List[str]] |
optional |
Specialty: Item #689 |
|
|
PRA.6 |
Optional[List[str]] |
optional |
Practitioner ID Numbers: Item #690 |
|
|
PRA.7 |
Optional[List[str]] |
optional |
Privileges: Item #691 |
- class hl7types.hl7.v2_2.segments.PV1.PV1
HL7 v2 PV1 segment.
PV1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PV1.1 |
Optional[str] |
optional |
Set ID - Patient Visit: Item #131 |
|
|
PV1.2 |
str |
required |
Patient Class: Item #132 | Table HL70004 |
|
|
PV1.3 |
Optional[str] |
optional |
Assigned Patient Location: Item #133 | Table HL70079 |
|
|
PV1.4 |
Optional[str] |
optional |
Admission Type: Item #134 | Table HL70007 |
|
|
PV1.5 |
Optional[str] |
optional |
Preadmit Number: Item #135 |
|
|
PV1.6 |
Optional[str] |
optional |
Prior Patient Location: Item #136 |
|
|
PV1.7 |
Optional[str] |
optional |
Attending Doctor: Item #137 | Table HL70010 |
|
|
PV1.8 |
Optional[str] |
optional |
Referring Doctor: Item #138 | Table HL70010 |
|
|
PV1.9 |
Optional[List[str]] |
optional |
Consulting Doctor: Item #139 | Table HL70010 |
|
|
PV1.10 |
Optional[str] |
optional |
Hospital Service: Item #140 | Table HL70069 |
|
|
PV1.11 |
Optional[str] |
optional |
Temporary Location: Item #141 | Table HL70079 |
|
|
PV1.12 |
Optional[str] |
optional |
Preadmit Test Indicator: Item #142 | Table HL70087 |
|
|
PV1.13 |
Optional[str] |
optional |
Readmission indicator: Item #143 | Table HL70092 |
|
|
PV1.14 |
Optional[str] |
optional |
Admit Source: Item #144 | Table HL70023 |
|
|
PV1.15 |
Optional[List[str]] |
optional |
Ambulatory Status: Item #145 | Table HL70009 |
|
|
PV1.16 |
Optional[str] |
optional |
VIP Indicator: Item #146 | Table HL70099 |
|
|
PV1.17 |
Optional[str] |
optional |
Admitting Doctor: Item #147 | Table HL70010 |
|
|
PV1.18 |
Optional[str] |
optional |
Patient type: Item #148 | Table HL70018 |
|
|
PV1.19 |
Optional[str] |
optional |
Visit Number: Item #149 |
|
|
PV1.20 |
Optional[List[str]] |
optional |
Financial Class: Item #150 | Table HL70064 |
|
|
PV1.21 |
Optional[str] |
optional |
Charge Price Indicator: Item #151 | Table HL70032 |
|
|
PV1.22 |
Optional[str] |
optional |
Courtesy Code: Item #152 | Table HL70045 |
|
|
PV1.23 |
Optional[str] |
optional |
Credit Rating: Item #153 | Table HL70046 |
|
|
PV1.24 |
Optional[List[str]] |
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[str] |
optional |
Interest Code: Item #158 | Table HL70073 |
|
|
PV1.29 |
Optional[str] |
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[str] |
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[str] |
optional |
Delete Account Indicator: Item #164 | Table HL70111 |
|
|
PV1.35 |
Optional[str] |
optional |
Delete Account Date: Item #165 |
|
|
PV1.36 |
Optional[str] |
optional |
Discharge Disposition: Item #166 | Table HL70112 |
|
|
PV1.37 |
Optional[str] |
optional |
Discharged to Location: Item #167 | Table HL70113 |
|
|
PV1.38 |
Optional[str] |
optional |
Diet Type: Item #168 | Table HL70114 |
|
|
PV1.39 |
Optional[str] |
optional |
Servicing Facility: Item #169 | Table HL70115 |
|
|
PV1.40 |
Optional[str] |
optional |
Bed Status: Item #170 | Table HL70116 |
|
|
PV1.41 |
Optional[str] |
optional |
Account Status: Item #171 | Table HL70117 |
|
|
PV1.42 |
Optional[str] |
optional |
Pending Location: Item #172 |
|
|
PV1.43 |
Optional[str] |
optional |
Prior Temporary Location: Item #173 |
|
|
PV1.44 |
Optional[TS] |
optional |
Admit date / time: Item #174 |
|
|
PV1.45 |
Optional[TS] |
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[str] |
optional |
Alternate Visit ID: Item #180 |
- class hl7types.hl7.v2_2.segments.PV2.PV2
HL7 v2 PV2 segment.
PV2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
PV2.1 |
Optional[str] |
optional |
Prior Pending Location: Item #181 |
|
|
PV2.2 |
Optional[CE] |
optional |
Accommodation Code: Item #182 | Table HL70129 |
|
|
PV2.3 |
Optional[CE] |
optional |
Admit Reason: Item #183 |
|
|
PV2.4 |
Optional[CE] |
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[str] |
optional |
Visit User Code: Item #187 | Table HL70130 |
|
|
PV2.8 |
Optional[str] |
optional |
Expected Admit Date: Item #188 |
|
|
PV2.9 |
Optional[str] |
optional |
Expected Discharge Date: Item #189 |
- class hl7types.hl7.v2_2.segments.QRD.QRD
HL7 v2 QRD segment.
QRD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QRD.1 |
required |
Query date / time: Item #25 |
||
|
QRD.2 |
str |
required |
Query Format Code: Item #26 | Table HL70106 |
|
|
QRD.3 |
str |
required |
Query Priority: Item #27 | Table HL70091 |
|
|
QRD.4 |
str |
required |
Query ID: Item #28 |
|
|
QRD.5 |
Optional[str] |
optional |
Deferred Response Type: Item #29 | Table HL70107 |
|
|
QRD.6 |
Optional[TS] |
optional |
Deferred response date / time: Item #30 |
|
|
QRD.7 |
str |
required |
Quantity Limited Request: Item #31 | Table HL70126 |
|
|
QRD.8 |
List[str] |
required |
Who Subject Filter: Item #32 |
|
|
QRD.9 |
List[str] |
required |
What Subject Filter: Item #33 | Table HL70048 |
|
|
QRD.10 |
List[str] |
required |
What Department Data Code: Item #34 |
|
|
QRD.11 |
Optional[List[str]] |
optional |
What data code value qualifier: Item #35 |
|
|
QRD.12 |
Optional[str] |
optional |
Query Results Level: Item #36 | Table HL70108 |
- class hl7types.hl7.v2_2.segments.QRF.QRF
HL7 v2 QRF segment.
QRF¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
QRF.1 |
List[str] |
required |
Where Subject Filter: Item #37 |
|
|
QRF.2 |
Optional[TS] |
optional |
When data start date / time: Item #38 |
|
|
QRF.3 |
Optional[TS] |
optional |
When data end date / time: Item #39 |
|
|
QRF.4 |
Optional[List[str]] |
optional |
What User Qualifier: Item #40 |
|
|
QRF.5 |
Optional[List[str]] |
optional |
Other QRY Subject Filter: Item #41 |
|
|
QRF.6 |
Optional[List[str]] |
optional |
Which date / time qualifier: Item #42 | Table HL70156 |
|
|
QRF.7 |
Optional[List[str]] |
optional |
Which date / time status qualifier: Item #43 | Table HL70157 |
|
|
QRF.8 |
Optional[List[str]] |
optional |
Date / time selection qualifier: Item #44 | Table HL70158 |
- class hl7types.hl7.v2_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[CE] |
optional |
Manufacturer ID: Item #286 |
|
|
RQ1.3 |
Optional[str] |
optional |
Manufacturer’s Catalog: Item #287 |
|
|
RQ1.4 |
Optional[CE] |
optional |
Vendor ID: Item #288 |
|
|
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_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[CE] |
optional |
Item Code - Internal: Item #276 |
|
|
RQD.3 |
Optional[CE] |
optional |
Item Code - External: Item #277 |
|
|
RQD.4 |
Optional[CE] |
optional |
Hospital Item Code: Item #278 |
|
|
RQD.5 |
Optional[str] |
optional |
Requisition Quantity: Item #279 |
|
|
RQD.6 |
Optional[CE] |
optional |
Requisition Unit of measure: Item #280 |
|
|
RQD.7 |
Optional[str] |
optional |
Department cost center: Item #281 |
|
|
RQD.8 |
Optional[str] |
optional |
Item Natural Account Code: Item #282 |
|
|
RQD.9 |
Optional[CE] |
optional |
Deliver-to ID: Item #283 |
|
|
RQD.10 |
Optional[str] |
optional |
Date Needed: Item #284 |
- class hl7types.hl7.v2_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 |
required |
Date / time start of administration: Item #345 |
||
|
RXA.4 |
required |
Date / time end of administration: Item #346 |
||
|
RXA.5 |
required |
Administered Code: Item #347 |
||
|
RXA.6 |
str |
required |
Administered Amount: Item #348 |
|
|
RXA.7 |
Optional[CE] |
optional |
Administered Units: Item #349 |
|
|
RXA.8 |
Optional[CE] |
optional |
Administered Dosage Form: Item #350 |
|
|
RXA.9 |
Optional[str] |
optional |
Administration Notes: Item #351 |
|
|
RXA.10 |
Optional[str] |
optional |
Administering Provider: Item #352 |
|
|
RXA.11 |
Optional[str] |
optional |
Administered-at Location: Item #353 |
|
|
RXA.12 |
Optional[str] |
optional |
Administered Per (Time Unit): Item #354 |
- class hl7types.hl7.v2_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 |
||
|
RXC.3 |
str |
required |
Component Amount: Item #315 |
|
|
RXC.4 |
required |
Component Units: Item #316 |
- class hl7types.hl7.v2_2.segments.RXD.RXD
HL7 v2 RXD segment.
RXD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXD.1 |
Optional[str] |
optional |
Dispense Sub-ID Counter: Item #334 |
|
|
RXD.2 |
required |
Dispense / give code: Item #335 |
||
|
RXD.3 |
Optional[TS] |
optional |
Date / time dispensed: Item #336 |
|
|
RXD.4 |
str |
required |
Actual Dispense Amount: Item #337 |
|
|
RXD.5 |
Optional[CE] |
optional |
Actual Dispense Units: Item #338 |
|
|
RXD.6 |
Optional[CE] |
optional |
Actual Dosage Form: Item #339 |
|
|
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[str] |
optional |
Dispensing Provider: Item #341 |
|
|
RXD.11 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXD.12 |
Optional[str] |
optional |
Total Daily Dose: Item #329 |
|
|
RXD.13 |
Optional[str] |
optional |
Deliver-to location: Item #299 |
|
|
RXD.14 |
Optional[str] |
optional |
Needs Human Review: Item #307 |
|
|
RXD.15 |
Optional[CE] |
optional |
Pharmacy Special Dispensing Instructions: Item #330 |
- class hl7types.hl7.v2_2.segments.RXE.RXE
HL7 v2 RXE segment.
RXE¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXE.1 |
Optional[List[TQ]] |
optional |
Quantity / timing: Item #221 |
|
|
RXE.2 |
required |
Give Code: Item #317 |
||
|
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 |
||
|
RXE.6 |
Optional[CE] |
optional |
Give Dosage Form: Item #321 |
|
|
RXE.7 |
Optional[List[CE]] |
optional |
Provider’s Administration Instructions: Item #298 |
|
|
RXE.8 |
Optional[str] |
optional |
Deliver-to location: Item #299 |
|
|
RXE.9 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXE.10 |
Optional[str] |
optional |
Dispense Amount: Item #323 |
|
|
RXE.11 |
Optional[CE] |
optional |
Dispense Units: Item #324 |
|
|
RXE.12 |
Optional[str] |
optional |
Number of Refills: Item #304 |
|
|
RXE.13 |
Optional[str] |
optional |
Ordering Provider’s DEA Number: Item #305 |
|
|
RXE.14 |
Optional[str] |
optional |
Pharmacist Verifier ID: Item #306 |
|
|
RXE.15 |
str |
required |
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[TS] |
optional |
Date / time of most recent refill or dose dispensed: Item #328 |
|
|
RXE.19 |
Optional[str] |
optional |
Total Daily Dose: Item #329 |
|
|
RXE.20 |
Optional[str] |
optional |
Needs Human Review: Item #307 |
|
|
RXE.21 |
Optional[CE] |
optional |
Pharmacy Special Dispensing Instructions: Item #330 |
|
|
RXE.22 |
Optional[str] |
optional |
Give Per (Time Unit): Item #331 |
|
|
RXE.23 |
Optional[CE] |
optional |
Give Rate Amount: Item #332 |
|
|
RXE.24 |
Optional[CE] |
optional |
Give Rate Units: Item #333 |
- class hl7types.hl7.v2_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.3 |
Optional[List[TQ]] |
optional |
Quantity / timing: Item #221 |
|
|
RXG.4 |
required |
Give Code: Item #317 |
||
|
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 |
||
|
RXG.8 |
Optional[CE] |
optional |
Give Dosage Form: Item #321 |
|
|
RXG.9 |
Optional[str] |
optional |
Administration Notes: Item #351 |
|
|
RXG.10 |
Optional[str] |
optional |
Substitution Status: Item #322 | Table HL70167 |
|
|
RXG.11 |
Optional[str] |
optional |
Deliver-to location: Item #299 |
|
|
RXG.12 |
Optional[str] |
optional |
Needs Human Review: Item #307 |
|
|
RXG.13 |
Optional[List[CE]] |
optional |
Pharmacy Special Administration Instructions: Item #343 |
|
|
RXG.14 |
Optional[str] |
optional |
Give Per (Time Unit): Item #331 |
|
|
RXG.15 |
Optional[CE] |
optional |
Give Rate Amount: Item #332 |
|
|
RXG.16 |
Optional[CE] |
optional |
Give Rate Units: Item #333 |
- class hl7types.hl7.v2_2.segments.RXO.RXO
HL7 v2 RXO segment.
RXO¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
RXO.1 |
required |
Requested Give Code: Item #292 |
||
|
RXO.2 |
str |
required |
Requested Give Amount - Minimum: Item #293 |
|
|
RXO.3 |
Optional[str] |
optional |
Requested Give Amount - Maximum: Item #294 |
|
|
RXO.4 |
required |
Requested Give Units: Item #295 |
||
|
RXO.5 |
Optional[CE] |
optional |
Requested Dosage Form: Item #296 |
|
|
RXO.6 |
Optional[List[CE]] |
optional |
Provider’s Pharmacy Instructions: Item #297 |
|
|
RXO.7 |
Optional[List[CE]] |
optional |
Provider’s Administration Instructions: Item #298 |
|
|
RXO.8 |
Optional[str] |
optional |
Deliver-to location: Item #299 |
|
|
RXO.9 |
Optional[str] |
optional |
Allow Substitutions: Item #300 | Table HL70161 |
|
|
RXO.10 |
Optional[CE] |
optional |
Requested Dispense Code: Item #301 |
|
|
RXO.11 |
Optional[str] |
optional |
Requested Dispense Amount: Item #302 |
|
|
RXO.12 |
Optional[CE] |
optional |
Requested Dispense Units: Item #303 |
|
|
RXO.13 |
Optional[str] |
optional |
Number of Refills: Item #304 |
|
|
RXO.14 |
Optional[str] |
optional |
Ordering Provider’s DEA Number: Item #305 |
|
|
RXO.15 |
Optional[str] |
optional |
Pharmacist Verifier ID: Item #306 |
|
|
RXO.16 |
Optional[str] |
optional |
Needs Human Review: Item #307 |
|
|
RXO.17 |
Optional[str] |
optional |
Requested Give Per (Time Unit): Item #308 |
- class hl7types.hl7.v2_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[CE] |
optional |
Site: Item #310 | Table HL70163 |
|
|
RXR.3 |
Optional[CE] |
optional |
Administration Device: Item #311 | Table HL70164 |
|
|
RXR.4 |
Optional[CE] |
optional |
Administration Method: Item #312 | Table HL70165 |
- class hl7types.hl7.v2_2.segments.STF.STF
HL7 v2 STF segment.
STF¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
STF.1 |
required |
STF - primary key value: Item #671 |
||
|
STF.2 |
Optional[List[CE]] |
optional |
Staff ID Code: Item #672 |
|
|
STF.3 |
Optional[PN] |
optional |
Staff Name: Item #673 |
|
|
STF.4 |
Optional[List[str]] |
optional |
Staff Type: Item #674 | Table HL70182 |
|
|
STF.5 |
Optional[str] |
optional |
Sex: Item #111 | Table HL70001 |
|
|
STF.6 |
Optional[TS] |
optional |
Date of Birth: Item #110 |
|
|
STF.7 |
Optional[str] |
optional |
Active / inactive: Item #675 | Table HL70183 |
|
|
STF.8 |
Optional[List[CE]] |
optional |
Department: Item #676 | Table HL70184 |
|
|
STF.9 |
Optional[List[CE]] |
optional |
Service: Item #677 |
|
|
STF.10 |
Optional[List[str]] |
optional |
Phone: Item #678 |
|
|
STF.11 |
Optional[List[AD]] |
optional |
Office / home address: Item #679 |
|
|
STF.12 |
Optional[List[str]] |
optional |
Activation Date: Item #680 |
|
|
STF.13 |
Optional[List[str]] |
optional |
Inactivation Date: Item #681 |
|
|
STF.14 |
Optional[List[CE]] |
optional |
Backup Person ID: Item #682 |
|
|
STF.15 |
Optional[List[str]] |
optional |
E-mail Address: Item #683 |
|
|
STF.16 |
Optional[str] |
optional |
Preferred method of Contact: Item #684 | Table HL70185 |
- class hl7types.hl7.v2_2.segments.UB1.UB1
HL7 v2 UB1 segment.
UB1¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
UB1.1 |
Optional[str] |
optional |
Set ID - UB82: Item #530 |
|
|
UB1.2 |
Optional[str] |
optional |
Blood deductible (43): Item #492 | Table HL70136 |
|
|
UB1.3 |
Optional[str] |
optional |
Blood furnished pints of (40): Item #532 |
|
|
UB1.4 |
Optional[str] |
optional |
Blood replaced pints (41): Item #533 |
|
|
UB1.5 |
Optional[str] |
optional |
Blood not replaced pints (42): Item #534 |
|
|
UB1.6 |
Optional[str] |
optional |
Co-insurance days (25): Item #535 |
|
|
UB1.7 |
Optional[List[str]] |
optional |
Condition code (35-39): Item #536 | Table HL70043 |
|
|
UB1.8 |
Optional[str] |
optional |
Covered days (23): Item #537 |
|
|
UB1.9 |
Optional[str] |
optional |
Non-covered days (24): Item #538 |
|
|
UB1.10 |
Optional[List[str]] |
optional |
Value amount and code (46-49): Item #539 | Table HL70153 |
|
|
UB1.11 |
Optional[str] |
optional |
Number of grace days (90): Item #540 |
|
|
UB1.12 |
Optional[str] |
optional |
Special program indicator (44): Item #541 |
|
|
UB1.13 |
Optional[str] |
optional |
PSRO / UR approval indicator (87): Item #542 |
|
|
UB1.14 |
Optional[str] |
optional |
PSRO / UR approved stay - from (88): Item #543 |
|
|
UB1.15 |
Optional[str] |
optional |
PSRO / UR approved stay - to (89): Item #544 |
|
|
UB1.16 |
Optional[List[str]] |
optional |
Occurrence (28-32): Item #545 |
|
|
UB1.17 |
Optional[str] |
optional |
Occurrence span (33): Item #546 |
|
|
UB1.18 |
Optional[str] |
optional |
Occurrence span start date (33): Item #547 |
|
|
UB1.19 |
Optional[str] |
optional |
Occurrence span end date (33): Item #548 |
|
|
UB1.20 |
Optional[str] |
optional |
UB-82 locator 2: Item #549 |
|
|
UB1.21 |
Optional[str] |
optional |
UB-82 locator 9: Item #550 |
|
|
UB1.22 |
Optional[str] |
optional |
UB-82 locator 27: Item #551 |
|
|
UB1.23 |
Optional[str] |
optional |
UB-82 locator 45: Item #552 |
- class hl7types.hl7.v2_2.segments.UB2.UB2
HL7 v2 UB2 segment.
UB2¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
UB2.1 |
Optional[str] |
optional |
Set ID - UB92: Item #553 |
|
|
UB2.2 |
Optional[str] |
optional |
Co-insurance days (9): Item #554 |
|
|
UB2.3 |
Optional[List[str]] |
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[str]] |
optional |
Value amount and code (39-41): Item #558 |
|
|
UB2.7 |
Optional[List[str]] |
optional |
Occurrence code and date (32-35): Item #559 |
|
|
UB2.8 |
Optional[List[str]] |
optional |
Occurrence span code / dates (36): Item #560 |
|
|
UB2.9 |
Optional[List[str]] |
optional |
UB92 locator 2 (state): Item #561 |
|
|
UB2.10 |
Optional[List[str]] |
optional |
UB92 locator 11 (state): Item #562 |
|
|
UB2.11 |
Optional[str] |
optional |
UB92 locator 31 (national): Item #563 |
|
|
UB2.12 |
Optional[List[str]] |
optional |
Document control number (37): Item #564 |
|
|
UB2.13 |
Optional[List[str]] |
optional |
UB92 locator 49 (national): Item #565 |
|
|
UB2.14 |
Optional[List[str]] |
optional |
UB92 locator 56 (state): Item #566 |
|
|
UB2.15 |
Optional[str] |
optional |
UB92 locator 57 (national): Item #567 |
|
|
UB2.16 |
Optional[List[str]] |
optional |
UB92 Locator 78 (state): Item #568 |
- class hl7types.hl7.v2_2.segments.URD.URD
HL7 v2 URD segment.
URD¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
URD.1 |
Optional[TS] |
optional |
R/U date / time: Item #45 |
|
|
URD.2 |
Optional[str] |
optional |
Report Priority: Item #46 | Table HL70109 |
|
|
URD.3 |
List[str] |
required |
R/U Who Subject Definition: Item #47 |
|
|
URD.4 |
Optional[List[str]] |
optional |
R/U What Subject Definition: Item #48 | Table HL70048 |
|
|
URD.5 |
Optional[List[str]] |
optional |
R/U What Department Code: Item #49 |
|
|
URD.6 |
Optional[List[str]] |
optional |
R/U display / print locations: Item #50 |
|
|
URD.7 |
Optional[str] |
optional |
R/U Results Level: Item #51 | Table HL70108 |
- class hl7types.hl7.v2_2.segments.URS.URS
HL7 v2 URS segment.
URS¶
Field |
HL7 |
Type |
Required |
Max Length |
Description |
|---|---|---|---|---|---|
|
URS.1 |
List[str] |
required |
R/U Where Subject Definition: Item #52 |
|
|
URS.2 |
Optional[TS] |
optional |
R/U when data start date / time: Item #53 |
|
|
URS.3 |
Optional[TS] |
optional |
R/U when data end date / time: Item #54 |
|
|
URS.4 |
Optional[List[str]] |
optional |
R/U What User Qualifier: Item #55 |
|
|
URS.5 |
Optional[List[str]] |
optional |
R/U Other Results Subject Definition: Item #56 |
|
|
URS.6 |
Optional[List[str]] |
optional |
R/U which date / time qualifier: Item #57 | Table HL70156 |
|
|
URS.7 |
Optional[List[str]] |
optional |
R/U which date / time status qualifier: Item #58 | Table HL70157 |
|
|
URS.8 |
Optional[List[str]] |
optional |
R/U date / time selection qualifier: Item #59 | Table HL70158 |