v2.7 Data Types

class hl7types.hl7.v2_7.datatypes.AD.AD

HL7 v2 AD data type.

AD

Field	HL7	Type	Required	Max Length	Description
ad_1	AD.1	Optional[str]	optional		Street Address
ad_2	AD.2	Optional[str]	optional		Other Designation
ad_3	AD.3	Optional[str]	optional		City
ad_4	AD.4	Optional[str]	optional		State or Province
ad_5	AD.5	Optional[str]	optional		Zip or Postal Code
ad_6	AD.6	Optional[str]	optional	3	Country
ad_7	AD.7	Optional[str]	optional	3	Address Type
ad_8	AD.8	Optional[str]	optional		Other Geographic Designation

class hl7types.hl7.v2_7.datatypes.AUI.AUI

HL7 v2 AUI data type.

AUI

Field	HL7	Type	Required	Max Length	Description
aui_1	AUI.1	Optional[str]	optional		Authorization Number
aui_2	AUI.2	Optional[str]	optional		Date
aui_3	AUI.3	Optional[str]	optional		Source

class hl7types.hl7.v2_7.datatypes.CCD.CCD

HL7 v2 CCD data type.

CCD

Field	HL7	Type	Required	Max Length	Description
ccd_1	CCD.1	str	required	1	Invocation Event
ccd_2	CCD.2	Optional[str]	optional		Date/time

class hl7types.hl7.v2_7.datatypes.CCP.CCP

HL7 v2 CCP data type.

CCP

Field	HL7	Type	Required	Max Length	Description
ccp_1	CCP.1	Optional[str]	optional		Channel Calibration Sensitivity Correction Factor
ccp_2	CCP.2	Optional[str]	optional		Channel Calibration Baseline
ccp_3	CCP.3	Optional[str]	optional		Channel Calibration Time Skew

class hl7types.hl7.v2_7.datatypes.CD.CD

HL7 v2 CD data type.

CD

Field	HL7	Type	Required	Max Length	Description
cd_1	CD.1	Optional[WVI]	optional		Channel Identifier
cd_2	CD.2	Optional[WVS]	optional		Waveform Source
cd_3	CD.3	Optional[CSU]	optional		Channel Sensitivity and Units
cd_4	CD.4	Optional[CCP]	optional		Channel Calibration Parameters
cd_5	CD.5	Optional[str]	optional		Channel Sampling Frequency
cd_6	CD.6	Optional[NR]	optional		Minimum and Maximum Data Values

class hl7types.hl7.v2_7.datatypes.CF.CF

HL7 v2 CF data type.

CF

Field	HL7	Type	Required	Max Length	Description
cf_1	CF.1	Optional[str]	optional		Identifier
cf_2	CF.2	Optional[FT]	optional		Formatted Text
cf_3	CF.3	Optional[str]	optional	12	Name of Coding System
cf_4	CF.4	Optional[str]	optional		Alternate Identifier
cf_5	CF.5	Optional[FT]	optional		Alternate Formatted Text
cf_6	CF.6	Optional[str]	optional	12	Name of Alternate Coding System
cf_7	CF.7	Optional[str]	optional		Coding System Version ID
cf_8	CF.8	Optional[str]	optional		Alternate Coding System Version ID
cf_9	CF.9	Optional[str]	optional		Original Text
cf_10	CF.10	Optional[str]	optional		Second Alternate Identifier
cf_11	CF.11	Optional[FT]	optional		Second Alternate Formatted Text
cf_12	CF.12	Optional[str]	optional	12	Name of Second Alternate Coding System
cf_13	CF.13	Optional[str]	optional		Second Alternate Coding System Version ID
cf_14	CF.14	Optional[str]	optional		Coding System OID
cf_15	CF.15	Optional[str]	optional		Value Set OID
cf_16	CF.16	Optional[str]	optional		Value Set Version ID
cf_17	CF.17	Optional[str]	optional		Alternate Coding System OID
cf_18	CF.18	Optional[str]	optional		Alternate Value Set OID
cf_19	CF.19	Optional[str]	optional		Alternate Value Set Version ID
cf_20	CF.20	Optional[str]	optional		Second Alternate Coding System OID
cf_21	CF.21	Optional[str]	optional		Second Alternate Value Set OID
cf_22	CF.22	Optional[str]	optional		Second Alternate Value Set Version ID

class hl7types.hl7.v2_7.datatypes.CNE.CNE

HL7 v2 CNE data type.

CNE

Field	HL7	Type	Required	Max Length	Description
cne_1	CNE.1	str	required		Identifier
cne_2	CNE.2	Optional[str]	optional		Text
cne_3	CNE.3	Optional[str]	optional	12	Name of Coding System
cne_4	CNE.4	Optional[str]	optional		Alternate Identifier
cne_5	CNE.5	Optional[str]	optional		Alternate Text
cne_6	CNE.6	Optional[str]	optional	12	Name of Alternate Coding System
cne_7	CNE.7	Optional[str]	optional		Coding System Version ID
cne_8	CNE.8	Optional[str]	optional		Alternate Coding System Version ID
cne_9	CNE.9	Optional[str]	optional		Original Text
cne_10	CNE.10	Optional[str]	optional		Second Alternate Identifier
cne_11	CNE.11	Optional[str]	optional		Second Alternate Text
cne_12	CNE.12	Optional[str]	optional	12	Name of Second Alternate Coding System
cne_13	CNE.13	Optional[str]	optional		Second Alternate Coding System Version ID
cne_14	CNE.14	Optional[str]	optional		Coding System OID
cne_15	CNE.15	Optional[str]	optional		Value Set OID
cne_16	CNE.16	Optional[str]	optional		Value Set Version ID
cne_17	CNE.17	Optional[str]	optional		Alternate Coding System OID
cne_18	CNE.18	Optional[str]	optional		Alternate Value Set OID
cne_19	CNE.19	Optional[str]	optional		Alternate Value Set Version ID
cne_20	CNE.20	Optional[str]	optional		Second Alternate Coding System OID
cne_21	CNE.21	Optional[str]	optional		Second Alternate Value Set OID
cne_22	CNE.22	Optional[str]	optional		Second Alternate Value Set Version ID

class hl7types.hl7.v2_7.datatypes.CNN.CNN

HL7 v2 CNN data type.

CNN

Field	HL7	Type	Required	Max Length	Description
cnn_1	CNN.1	Optional[str]	optional		ID Number
cnn_2	CNN.2	Optional[str]	optional		Family Name
cnn_3	CNN.3	Optional[str]	optional		Given Name
cnn_4	CNN.4	Optional[str]	optional		Second and Further Given Names or Initials Thereof
cnn_5	CNN.5	Optional[str]	optional		Suffix (e.g., JR or III)
cnn_6	CNN.6	Optional[str]	optional		Prefix (e.g., DR)
cnn_7	CNN.7	Optional[str]	optional		Degree (e.g., MD)
cnn_8	CNN.8	Optional[str]	optional		Source Table
cnn_9	CNN.9	Optional[str]	optional		Assigning Authority - Namespace ID
cnn_10	CNN.10	Optional[str]	optional		Assigning Authority - Universal ID
cnn_11	CNN.11	Optional[str]	optional	6	Assigning Authority - Universal ID Type

class hl7types.hl7.v2_7.datatypes.CP.CP

HL7 v2 CP data type.

CP

Field	HL7	Type	Required	Max Length	Description
cp_1	CP.1	MO	required		Price
cp_2	CP.2	Optional[str]	optional	2	Price Type
cp_3	CP.3	Optional[str]	optional		From Value
cp_4	CP.4	Optional[str]	optional		To Value
cp_5	CP.5	Optional[CWE]	optional		Range Units
cp_6	CP.6	Optional[str]	optional	1	Range Type

class hl7types.hl7.v2_7.datatypes.CQ.CQ

HL7 v2 CQ data type.

CQ

Field	HL7	Type	Required	Max Length	Description
cq_1	CQ.1	Optional[str]	optional		Quantity
cq_2	CQ.2	Optional[CWE]	optional		Units

class hl7types.hl7.v2_7.datatypes.CSU.CSU

HL7 v2 CSU data type.

CSU

Field	HL7	Type	Required	Max Length	Description
csu_1	CSU.1	str	required		Channel Sensitivity
csu_2	CSU.2	Optional[str]	optional		Unit of Measure Identifier
csu_3	CSU.3	Optional[str]	optional		Unit of Measure Description
csu_4	CSU.4	Optional[str]	optional	12	Unit of Measure Coding System
csu_5	CSU.5	Optional[str]	optional		Alternate Unit of Measure Identifier
csu_6	CSU.6	Optional[str]	optional		Alternate Unit of Measure Description
csu_7	CSU.7	Optional[str]	optional	12	Alternate Unit of Measure Coding System
csu_8	CSU.8	Optional[str]	optional		Unit of Measure Coding System Version ID
csu_9	CSU.9	Optional[str]	optional		Alternate Unit of Measure Coding System Version ID
csu_10	CSU.10	Optional[str]	optional	199	Original Text
csu_11	CSU.11	Optional[str]	optional		Second Alternate Unit of Measure Identifier
csu_12	CSU.12	Optional[str]	optional		Second Alternate Unit of Measure Text
csu_13	CSU.13	Optional[str]	optional	12	Name of Second Alternate Unit of Measure Coding Sy
csu_14	CSU.14	Optional[str]	optional		Second Alternate Unit of Measure Coding System Ver
csu_15	CSU.15	Optional[str]	optional		Unit of Measure Coding System OID
csu_16	CSU.16	Optional[str]	optional		Unit of Measure Value Set OID
csu_17	CSU.17	Optional[str]	optional		Unit of Measure Value Set Version ID
csu_18	CSU.18	Optional[str]	optional		Alternate Unit of Measure Coding System OID
csu_19	CSU.19	Optional[str]	optional		Alternate Unit of Measure Value Set OID
csu_20	CSU.20	Optional[str]	optional		Alternate Unit of Measure Value Set Version ID
csu_21	CSU.21	Optional[str]	optional		Alternate Unit of Measure Coding System OID
csu_22	CSU.22	Optional[str]	optional		Alternate Unit of Measure Value Set OID
csu_23	CSU.23	Optional[str]	optional		Alternate Unit of Measure Value Set Version ID

class hl7types.hl7.v2_7.datatypes.CWE.CWE

HL7 v2 CWE data type.

CWE

Field	HL7	Type	Required	Max Length	Description
cwe_1	CWE.1	Optional[str]	optional		Identifier
cwe_2	CWE.2	Optional[str]	optional		Text
cwe_3	CWE.3	Optional[str]	optional	12	Name of Coding System
cwe_4	CWE.4	Optional[str]	optional		Alternate Identifier
cwe_5	CWE.5	Optional[str]	optional		Alternate Text
cwe_6	CWE.6	Optional[str]	optional	12	Name of Alternate Coding System
cwe_7	CWE.7	Optional[str]	optional		Coding System Version ID
cwe_8	CWE.8	Optional[str]	optional		Alternate Coding System Version ID
cwe_9	CWE.9	Optional[str]	optional		Original Text
cwe_10	CWE.10	Optional[str]	optional		Second Alternate Identifier
cwe_11	CWE.11	Optional[str]	optional		Second Alternate Text
cwe_12	CWE.12	Optional[str]	optional	12	Name of Second Alternate Coding System
cwe_13	CWE.13	Optional[str]	optional		Second Alternate Coding System Version ID
cwe_14	CWE.14	Optional[str]	optional		Coding System OID
cwe_15	CWE.15	Optional[str]	optional		Value Set OID
cwe_16	CWE.16	Optional[str]	optional		Value Set Version ID
cwe_17	CWE.17	Optional[str]	optional		Alternate Coding System OID
cwe_18	CWE.18	Optional[str]	optional		Alternate Value Set OID
cwe_19	CWE.19	Optional[str]	optional		Alternate Value Set Version ID
cwe_20	CWE.20	Optional[str]	optional		Second Alternate Coding System OID
cwe_21	CWE.21	Optional[str]	optional		Second Alternate Value Set OID
cwe_22	CWE.22	Optional[str]	optional		Second Alternate Value Set Version ID

class hl7types.hl7.v2_7.datatypes.CX.CX

HL7 v2 CX data type.

CX

Field	HL7	Type	Required	Max Length	Description
cx_1	CX.1	str	required		ID Number
cx_2	CX.2	Optional[str]	optional		Identifier Check Digit
cx_3	CX.3	Optional[str]	optional	3	Check Digit Scheme
cx_4	CX.4	Optional[HD]	optional		Assigning Authority
cx_5	CX.5	str	required	5	Identifier Type Code
cx_6	CX.6	Optional[HD]	optional		Assigning Facility
cx_7	CX.7	Optional[str]	optional		Effective Date
cx_8	CX.8	Optional[str]	optional		Expiration Date
cx_9	CX.9	Optional[CWE]	optional		Assigning Jurisdiction
cx_10	CX.10	Optional[CWE]	optional		Assigning Agency or Department
cx_11	CX.11	Optional[str]	optional		Security Check
cx_12	CX.12	Optional[str]	optional	3	Security Check Scheme

class hl7types.hl7.v2_7.datatypes.DDI.DDI

HL7 v2 DDI data type.

DDI

Field	HL7	Type	Required	Max Length	Description
ddi_1	DDI.1	Optional[str]	optional		Delay Days
ddi_2	DDI.2	MO	required		Monetary Amount
ddi_3	DDI.3	Optional[str]	optional		Number of Days

class hl7types.hl7.v2_7.datatypes.DIN.DIN

HL7 v2 DIN data type.

DIN

Field	HL7	Type	Required	Max Length	Description
din_1	DIN.1	str	required		Date
din_2	DIN.2	CWE	required		Institution Name

class hl7types.hl7.v2_7.datatypes.DLD.DLD

HL7 v2 DLD data type.

DLD

Field	HL7	Type	Required	Max Length	Description
dld_1	DLD.1	CWE	required		Discharge to Location
dld_2	DLD.2	Optional[str]	optional		Effective Date

class hl7types.hl7.v2_7.datatypes.DLN.DLN

HL7 v2 DLN data type.

DLN

Field	HL7	Type	Required	Max Length	Description
dln_1	DLN.1	str	required		License Number
dln_2	DLN.2	Optional[CWE]	optional		Issuing State, Province, Country
dln_3	DLN.3	Optional[str]	optional		Expiration Date

class hl7types.hl7.v2_7.datatypes.DLT.DLT

HL7 v2 DLT data type.

DLT

Field	HL7	Type	Required	Max Length	Description
dlt_1	DLT.1	Optional[NR]	optional		Normal Range
dlt_2	DLT.2	Optional[str]	optional		Numeric Threshold
dlt_3	DLT.3	Optional[str]	optional		Change Computation
dlt_4	DLT.4	Optional[str]	optional		Days Retained

class hl7types.hl7.v2_7.datatypes.DR.DR

HL7 v2 DR data type.

DR

Field	HL7	Type	Required	Max Length	Description
dr_1	DR.1	Optional[str]	optional		Range Start Date/Time
dr_2	DR.2	Optional[str]	optional		Range End Date/Time

class hl7types.hl7.v2_7.datatypes.DTN.DTN

HL7 v2 DTN data type.

DTN

Field	HL7	Type	Required	Max Length	Description
dtn_1	DTN.1	CWE	required		Day Type
dtn_2	DTN.2	str	required		Number of Days

class hl7types.hl7.v2_7.datatypes.ED.ED

HL7 v2 ED data type.

ED

Field	HL7	Type	Required	Max Length	Description
ed_1	ED.1	Optional[HD]	optional		Source Application
ed_2	ED.2	str	required	11	Type of Data
ed_3	ED.3	Optional[str]	optional		Data Subtype
ed_4	ED.4	str	required	6	Encoding
ed_5	ED.5	TX	required		Data

class hl7types.hl7.v2_7.datatypes.EI.EI

HL7 v2 EI data type.

EI

Field	HL7	Type	Required	Max Length	Description
ei_1	EI.1	Optional[str]	optional		Entity Identifier
ei_2	EI.2	Optional[str]	optional		Namespace ID
ei_3	EI.3	Optional[str]	optional		Universal ID
ei_4	EI.4	Optional[str]	optional	6	Universal ID Type

class hl7types.hl7.v2_7.datatypes.EIP.EIP

HL7 v2 EIP data type.

EIP

Field	HL7	Type	Required	Max Length	Description
eip_1	EIP.1	Optional[EI]	optional		Placer Assigned Identifier
eip_2	EIP.2	Optional[EI]	optional		Filler Assigned Identifier

class hl7types.hl7.v2_7.datatypes.ERL.ERL

HL7 v2 ERL data type.

ERL

Field	HL7	Type	Required	Max Length	Description
erl_1	ERL.1	str	required	3	Segment ID
erl_2	ERL.2	str	required		Segment Sequence
erl_3	ERL.3	Optional[str]	optional		Field Position
erl_4	ERL.4	Optional[str]	optional		Field Repetition
erl_5	ERL.5	Optional[str]	optional		Component Number
erl_6	ERL.6	Optional[str]	optional		Sub-Component Number

class hl7types.hl7.v2_7.datatypes.FC.FC

HL7 v2 FC data type.

FC

Field	HL7	Type	Required	Max Length	Description
fc_1	FC.1	CWE	required		Financial Class Code
fc_2	FC.2	Optional[str]	optional		Effective Date

class hl7types.hl7.v2_7.datatypes.FN.FN

HL7 v2 FN data type.

FN

Field	HL7	Type	Required	Max Length	Description
fn_1	FN.1	str	required		Surname
fn_2	FN.2	Optional[str]	optional		Own Surname Prefix
fn_3	FN.3	Optional[str]	optional		Own Surname
fn_4	FN.4	Optional[str]	optional		Surname Prefix from Partner/Spouse
fn_5	FN.5	Optional[str]	optional		Surname from Partner/Spouse

class hl7types.hl7.v2_7.datatypes.HD.HD

HL7 v2 HD data type.

HD

Field	HL7	Type	Required	Max Length	Description
hd_1	HD.1	Optional[str]	optional		Namespace ID
hd_2	HD.2	Optional[str]	optional		Universal ID
hd_3	HD.3	Optional[str]	optional	6	Universal ID Type

class hl7types.hl7.v2_7.datatypes.ICD.ICD

HL7 v2 ICD data type.

ICD

Field	HL7	Type	Required	Max Length	Description
icd_1	ICD.1	Optional[CWE]	optional		Certification Patient Type
icd_2	ICD.2	str	required	1	Certification Required
icd_3	ICD.3	Optional[str]	optional		Date/Time Certification Required

class hl7types.hl7.v2_7.datatypes.JCC.JCC

HL7 v2 JCC data type.

JCC

Field	HL7	Type	Required	Max Length	Description
jcc_1	JCC.1	Optional[CWE]	optional		Job Code
jcc_2	JCC.2	Optional[CWE]	optional		Job Class
jcc_3	JCC.3	Optional[TX]	optional		Job Description Text

class hl7types.hl7.v2_7.datatypes.LA1.LA1

HL7 v2 LA1 data type.

LA1

Field	HL7	Type	Required	Max Length	Description
la1_1	LA1.1	Optional[str]	optional		Point of Care
la1_2	LA1.2	Optional[str]	optional		Room
la1_3	LA1.3	Optional[str]	optional		Bed
la1_4	LA1.4	Optional[HD]	optional		Facility
la1_5	LA1.5	Optional[str]	optional		Location Status
la1_6	LA1.6	Optional[str]	optional		Patient Location Type
la1_7	LA1.7	Optional[str]	optional		Building
la1_8	LA1.8	Optional[str]	optional		Floor
la1_9	LA1.9	Optional[AD]	optional		Address

class hl7types.hl7.v2_7.datatypes.LA2.LA2

HL7 v2 LA2 data type.

LA2

Field	HL7	Type	Required	Max Length	Description
la2_1	LA2.1	Optional[str]	optional		Point of Care
la2_2	LA2.2	Optional[str]	optional		Room
la2_3	LA2.3	Optional[str]	optional		Bed
la2_4	LA2.4	Optional[HD]	optional		Facility
la2_5	LA2.5	Optional[str]	optional		Location Status
la2_6	LA2.6	Optional[str]	optional		Patient Location Type
la2_7	LA2.7	Optional[str]	optional		Building
la2_8	LA2.8	Optional[str]	optional		Floor
la2_9	LA2.9	Optional[str]	optional		Street Address
la2_10	LA2.10	Optional[str]	optional		Other Designation
la2_11	LA2.11	Optional[str]	optional		City
la2_12	LA2.12	Optional[str]	optional		State or Province
la2_13	LA2.13	Optional[str]	optional		Zip or Postal Code
la2_14	LA2.14	Optional[str]	optional	3	Country
la2_15	LA2.15	Optional[str]	optional	3	Address Type
la2_16	LA2.16	Optional[str]	optional		Other Geographic Designation

class hl7types.hl7.v2_7.datatypes.MA.MA

HL7 v2 MA data type.

MA

Field	HL7	Type	Required	Max Length	Description
ma_1	MA.1	Optional[str]	optional		Sample Y From Channel 1
ma_2	MA.2	Optional[str]	optional		Sample Y From Channel 2
ma_3	MA.3	Optional[str]	optional		Sample Y From Channel 3
ma_4	MA.4	Optional[str]	optional		Sample Y From Channel 4

class hl7types.hl7.v2_7.datatypes.MO.MO

HL7 v2 MO data type.

MO

Field	HL7	Type	Required	Max Length	Description
mo_1	MO.1	Optional[str]	optional		Quantity
mo_2	MO.2	Optional[str]	optional	3	Denomination

class hl7types.hl7.v2_7.datatypes.MOC.MOC

HL7 v2 MOC data type.

MOC

Field	HL7	Type	Required	Max Length	Description
moc_1	MOC.1	Optional[MO]	optional		Monetary Amount
moc_2	MOC.2	Optional[CWE]	optional		Charge Code

class hl7types.hl7.v2_7.datatypes.MOP.MOP

HL7 v2 MOP data type.

MOP

Field	HL7	Type	Required	Max Length	Description
mop_1	MOP.1	str	required		Money or Percentage Indicator
mop_2	MOP.2	str	required		Money or Percentage Quantity
mop_3	MOP.3	Optional[str]	optional	3	Monetary Denomination

class hl7types.hl7.v2_7.datatypes.MSG.MSG

HL7 v2 MSG data type.

MSG

Field	HL7	Type	Required	Max Length	Description
msg_1	MSG.1	str	required	3	Message Code
msg_2	MSG.2	str	required	3	Trigger Event
msg_3	MSG.3	str	required	7	Message Structure

class hl7types.hl7.v2_7.datatypes.NA.NA

HL7 v2 NA data type.

NA

Field	HL7	Type	Required	Max Length	Description
na_1	NA.1	Optional[str]	optional		Value1
na_2	NA.2	Optional[str]	optional		Value2
na_3	NA.3	Optional[str]	optional		Value3
na_4	NA.4	Optional[str]	optional		Value4

class hl7types.hl7.v2_7.datatypes.NDL.NDL

HL7 v2 NDL data type.

NDL

Field	HL7	Type	Required	Max Length	Description
ndl_1	NDL.1	Optional[CNN]	optional		Name
ndl_2	NDL.2	Optional[str]	optional		Start Date/time
ndl_3	NDL.3	Optional[str]	optional		End Date/time
ndl_4	NDL.4	Optional[str]	optional		Point of Care
ndl_5	NDL.5	Optional[str]	optional		Room
ndl_6	NDL.6	Optional[str]	optional		Bed
ndl_7	NDL.7	Optional[HD]	optional		Facility
ndl_8	NDL.8	Optional[str]	optional		Location Status
ndl_9	NDL.9	Optional[str]	optional		Patient Location Type
ndl_10	NDL.10	Optional[str]	optional		Building
ndl_11	NDL.11	Optional[str]	optional		Floor

class hl7types.hl7.v2_7.datatypes.NR.NR

HL7 v2 NR data type.

NR

Field	HL7	Type	Required	Max Length	Description
nr_1	NR.1	Optional[str]	optional		Low Value
nr_2	NR.2	Optional[str]	optional		High Value

class hl7types.hl7.v2_7.datatypes.OCD.OCD

HL7 v2 OCD data type.

OCD

Field	HL7	Type	Required	Max Length	Description
ocd_1	OCD.1	CNE	required		Occurrence Code
ocd_2	OCD.2	str	required		Occurrence Date

class hl7types.hl7.v2_7.datatypes.OSP.OSP

HL7 v2 OSP data type.

OSP

Field	HL7	Type	Required	Max Length	Description
osp_1	OSP.1	CNE	required		Occurrence Span Code
osp_2	OSP.2	Optional[str]	optional		Occurrence Span Start Date
osp_3	OSP.3	Optional[str]	optional		Occurrence Span Stop Date

class hl7types.hl7.v2_7.datatypes.PIP.PIP

HL7 v2 PIP data type.

PIP

Field	HL7	Type	Required	Max Length	Description
pip_1	PIP.1	CWE	required		Privilege
pip_2	PIP.2	Optional[CWE]	optional		Privilege Class
pip_3	PIP.3	Optional[str]	optional		Expiration Date
pip_4	PIP.4	Optional[str]	optional		Activation Date
pip_5	PIP.5	Optional[EI]	optional		Facility

class hl7types.hl7.v2_7.datatypes.PL.PL

HL7 v2 PL data type.

PL

Field	HL7	Type	Required	Max Length	Description
pl_1	PL.1	Optional[HD]	optional		Point of Care
pl_2	PL.2	Optional[HD]	optional		Room
pl_3	PL.3	Optional[HD]	optional		Bed
pl_4	PL.4	Optional[HD]	optional		Facility
pl_5	PL.5	Optional[str]	optional		Location Status
pl_6	PL.6	Optional[str]	optional		Person Location Type
pl_7	PL.7	Optional[HD]	optional		Building
pl_8	PL.8	Optional[HD]	optional		Floor
pl_9	PL.9	Optional[str]	optional		Location Description
pl_10	PL.10	Optional[EI]	optional		Comprehensive Location Identifier
pl_11	PL.11	Optional[HD]	optional		Assigning Authority for Location

class hl7types.hl7.v2_7.datatypes.PLN.PLN

HL7 v2 PLN data type.

PLN

Field	HL7	Type	Required	Max Length	Description
pln_1	PLN.1	str	required		ID Number
pln_2	PLN.2	CWE	required		Type of ID Number
pln_3	PLN.3	Optional[str]	optional		State/other Qualifying Information
pln_4	PLN.4	Optional[str]	optional		Expiration Date

class hl7types.hl7.v2_7.datatypes.PPN.PPN

HL7 v2 PPN data type.

PPN

Field	HL7	Type	Required	Max Length	Description
ppn_1	PPN.1	Optional[str]	optional		Person Identifier
ppn_2	PPN.2	Optional[FN]	optional		Family Name
ppn_3	PPN.3	Optional[str]	optional		Given Name
ppn_4	PPN.4	Optional[str]	optional		Second and Further Given Names or Initials Thereof
ppn_5	PPN.5	Optional[str]	optional		Suffix (e.g., JR or III)
ppn_6	PPN.6	Optional[str]	optional		Prefix (e.g., DR)
ppn_8	PPN.8	Optional[CWE]	optional		Source Table
ppn_9	PPN.9	Optional[HD]	optional		Assigning Authority
ppn_10	PPN.10	Optional[str]	optional	5	Name Type Code
ppn_11	PPN.11	Optional[str]	optional		Identifier Check Digit
ppn_12	PPN.12	Optional[str]	optional	3	Check Digit Scheme
ppn_13	PPN.13	Optional[str]	optional	5	Identifier Type Code
ppn_14	PPN.14	Optional[HD]	optional		Assigning Facility
ppn_15	PPN.15	Optional[str]	optional		Date/Time Action Performed
ppn_16	PPN.16	Optional[str]	optional	1	Name Representation Code
ppn_17	PPN.17	Optional[CWE]	optional		Name Context
ppn_19	PPN.19	Optional[str]	optional	1	Name Assembly Order
ppn_20	PPN.20	Optional[str]	optional		Effective Date
ppn_21	PPN.21	Optional[str]	optional		Expiration Date
ppn_22	PPN.22	Optional[str]	optional		Professional Suffix
ppn_23	PPN.23	Optional[CWE]	optional		Assigning Jurisdiction
ppn_24	PPN.24	Optional[CWE]	optional		Assigning Agency or Department
ppn_25	PPN.25	Optional[str]	optional		Security Check
ppn_26	PPN.26	Optional[str]	optional	3	Security Check Scheme

class hl7types.hl7.v2_7.datatypes.PRL.PRL

HL7 v2 PRL data type.

PRL

Field	HL7	Type	Required	Max Length	Description
prl_1	PRL.1	CWE	required		Parent Observation Identifier
prl_2	PRL.2	Optional[str]	optional		Parent Observation Sub-identifier
prl_3	PRL.3	Optional[TX]	optional		Parent Observation Value Descriptor

class hl7types.hl7.v2_7.datatypes.PT.PT

HL7 v2 PT data type.

PT

Field	HL7	Type	Required	Max Length	Description
pt_1	PT.1	str	required	1	Processing ID
pt_2	PT.2	Optional[str]	optional	1	Processing Mode

class hl7types.hl7.v2_7.datatypes.PTA.PTA

HL7 v2 PTA data type.

PTA

Field	HL7	Type	Required	Max Length	Description
pta_1	PTA.1	CWE	required		Policy Type
pta_2	PTA.2	Optional[CWE]	optional		Amount Class
pta_4	PTA.4	MOP	required		Money or Percentage

class hl7types.hl7.v2_7.datatypes.QIP.QIP

HL7 v2 QIP data type.

QIP

Field	HL7	Type	Required	Max Length	Description
qip_1	QIP.1	str	required	12	Segment Field Name
qip_2	QIP.2	str	required		Values

class hl7types.hl7.v2_7.datatypes.QSC.QSC

HL7 v2 QSC data type.

QSC

Field	HL7	Type	Required	Max Length	Description
qsc_1	QSC.1	str	required		Segment Field Name
qsc_2	QSC.2	Optional[str]	optional	2	Relational Operator
qsc_3	QSC.3	Optional[str]	optional		Value
qsc_4	QSC.4	Optional[str]	optional	3	Relational Conjunction

class hl7types.hl7.v2_7.datatypes.RCD.RCD

HL7 v2 RCD data type.

RCD

Field	HL7	Type	Required	Max Length	Description
rcd_1	RCD.1	Optional[str]	optional	12	Segment Field Name
rcd_2	RCD.2	Optional[str]	optional	3	HL7 Data Type
rcd_3	RCD.3	Optional[str]	optional	5	Maximum Column Width

class hl7types.hl7.v2_7.datatypes.RFR.RFR

HL7 v2 RFR data type.

RFR

Field	HL7	Type	Required	Max Length	Description
rfr_1	RFR.1	NR	required		Numeric Range
rfr_2	RFR.2	Optional[CWE]	optional		Administrative Sex
rfr_3	RFR.3	Optional[NR]	optional		Age Range
rfr_4	RFR.4	Optional[NR]	optional		Gestational Age Range
rfr_5	RFR.5	Optional[str]	optional		Species
rfr_6	RFR.6	Optional[str]	optional		Race/subspecies
rfr_7	RFR.7	Optional[TX]	optional		Conditions

class hl7types.hl7.v2_7.datatypes.RI.RI

HL7 v2 RI data type.

RI

Field	HL7	Type	Required	Max Length	Description
ri_1	RI.1	Optional[CWE]	optional		Repeat Pattern
ri_2	RI.2	Optional[str]	optional		Explicit Time Interval

class hl7types.hl7.v2_7.datatypes.RMC.RMC

HL7 v2 RMC data type.

RMC

Field	HL7	Type	Required	Max Length	Description
rmc_1	RMC.1	CWE	required		Room Type
rmc_2	RMC.2	Optional[CWE]	optional		Amount Type
rmc_4	RMC.4	MOP	required		Money or Percentage

class hl7types.hl7.v2_7.datatypes.RP.RP

HL7 v2 RP data type.

RP

Field	HL7	Type	Required	Max Length	Description
rp_1	RP.1	Optional[str]	optional		Pointer
rp_2	RP.2	Optional[HD]	optional		Application ID
rp_3	RP.3	Optional[str]	optional	11	Type of Data
rp_4	RP.4	Optional[str]	optional		Subtype

class hl7types.hl7.v2_7.datatypes.RPT.RPT

HL7 v2 RPT data type.

RPT

Field	HL7	Type	Required	Max Length	Description
rpt_1	RPT.1	CWE	required		Repeat Pattern Code
rpt_2	RPT.2	Optional[str]	optional	2	Calendar Alignment
rpt_3	RPT.3	Optional[str]	optional		Phase Range Begin Value
rpt_4	RPT.4	Optional[str]	optional		Phase Range End Value
rpt_5	RPT.5	Optional[str]	optional		Period Quantity
rpt_6	RPT.6	Optional[CWE]	optional		Period Units
rpt_7	RPT.7	Optional[str]	optional	1	Institution Specified Time
rpt_8	RPT.8	Optional[str]	optional	3	Event
rpt_9	RPT.9	Optional[str]	optional		Event Offset Quantity
rpt_10	RPT.10	Optional[CWE]	optional		Event Offset Units
rpt_11	RPT.11	Optional[str]	optional		General Timing Specification

class hl7types.hl7.v2_7.datatypes.SAD.SAD

HL7 v2 SAD data type.

SAD

Field	HL7	Type	Required	Max Length	Description
sad_1	SAD.1	Optional[str]	optional		Street or Mailing Address
sad_2	SAD.2	Optional[str]	optional		Street Name
sad_3	SAD.3	Optional[str]	optional		Dwelling Number

class hl7types.hl7.v2_7.datatypes.SCV.SCV

HL7 v2 SCV data type.

SCV

Field	HL7	Type	Required	Max Length	Description
scv_1	SCV.1	Optional[CWE]	optional		Parameter Class
scv_2	SCV.2	Optional[str]	optional		Parameter Value

class hl7types.hl7.v2_7.datatypes.SN.SN

HL7 v2 SN data type.

SN

Field	HL7	Type	Required	Max Length	Description
sn_1	SN.1	Optional[str]	optional	2	Comparator
sn_2	SN.2	Optional[str]	optional		Num1
sn_3	SN.3	Optional[str]	optional	1	Separator/Suffix
sn_4	SN.4	Optional[str]	optional		Num2

class hl7types.hl7.v2_7.datatypes.SPD.SPD

HL7 v2 SPD data type.

SPD

Field	HL7	Type	Required	Max Length	Description
spd_1	SPD.1	str	required		Specialty Name
spd_2	SPD.2	Optional[str]	optional		Governing Board
spd_3	SPD.3	Optional[str]	optional	1	Eligible or Certified
spd_4	SPD.4	Optional[str]	optional		Date of Certification

class hl7types.hl7.v2_7.datatypes.SRT.SRT

HL7 v2 SRT data type.

SRT

Field	HL7	Type	Required	Max Length	Description
srt_1	SRT.1	str	required	12	Sort-by Field
srt_2	SRT.2	Optional[str]	optional	2	Sequencing

class hl7types.hl7.v2_7.datatypes.UVC.UVC

HL7 v2 UVC data type.

UVC

Field	HL7	Type	Required	Max Length	Description
uvc_1	UVC.1	CWE	required		Value Code
uvc_2	UVC.2	Optional[MO]	optional		Value Amount
uvc_3	UVC.3	Optional[str]	optional		Non-Monetary Value Amount / Quantity
uvc_4	UVC.4	Optional[CWE]	optional		Non-Monetary Value Amount / Units

class hl7types.hl7.v2_7.datatypes.VH.VH

HL7 v2 VH data type.

VH

Field	HL7	Type	Required	Max Length	Description
vh_1	VH.1	Optional[str]	optional	3	Start Day Range
vh_2	VH.2	Optional[str]	optional	3	End Day Range
vh_3	VH.3	Optional[str]	optional		Start Hour Range
vh_4	VH.4	Optional[str]	optional		End Hour Range

class hl7types.hl7.v2_7.datatypes.VID.VID

HL7 v2 VID data type.

VID

Field	HL7	Type	Required	Max Length	Description
vid_1	VID.1	str	required	5	Version ID
vid_2	VID.2	Optional[CWE]	optional		Internationalization Code
vid_3	VID.3	Optional[CWE]	optional		International Version ID

class hl7types.hl7.v2_7.datatypes.VR.VR

HL7 v2 VR data type.

VR

Field	HL7	Type	Required	Max Length	Description
vr_1	VR.1	Optional[str]	optional		First Data Code Value
vr_2	VR.2	Optional[str]	optional		Last Data Code Value

class hl7types.hl7.v2_7.datatypes.WVI.WVI

HL7 v2 WVI data type.

WVI

Field	HL7	Type	Required	Max Length	Description
wvi_1	WVI.1	str	required		Channel Number
wvi_2	WVI.2	Optional[str]	optional		Channel Name

class hl7types.hl7.v2_7.datatypes.WVS.WVS

HL7 v2 WVS data type.

WVS

Field	HL7	Type	Required	Max Length	Description
wvs_1	WVS.1	str	required		Source One Name
wvs_2	WVS.2	Optional[str]	optional		Source Two Name

class hl7types.hl7.v2_7.datatypes.XAD.XAD

HL7 v2 XAD data type.

XAD

Field	HL7	Type	Required	Max Length	Description
xad_1	XAD.1	Optional[SAD]	optional		Street Address
xad_2	XAD.2	Optional[str]	optional		Other Designation
xad_3	XAD.3	Optional[str]	optional		City
xad_4	XAD.4	Optional[str]	optional		State or Province
xad_5	XAD.5	Optional[str]	optional		Zip or Postal Code
xad_6	XAD.6	Optional[str]	optional	3	Country
xad_7	XAD.7	Optional[str]	optional	3	Address Type
xad_8	XAD.8	Optional[str]	optional		Other Geographic Designation
xad_9	XAD.9	Optional[CWE]	optional		County/Parish Code
xad_10	XAD.10	Optional[CWE]	optional		Census Tract
xad_11	XAD.11	Optional[str]	optional	1	Address Representation Code
xad_13	XAD.13	Optional[str]	optional		Effective Date
xad_14	XAD.14	Optional[str]	optional		Expiration Date
xad_15	XAD.15	Optional[CWE]	optional		Expiration Reason
xad_16	XAD.16	Optional[str]	optional	1	Temporary Indicator
xad_17	XAD.17	Optional[str]	optional	1	Bad Address Indicator
xad_18	XAD.18	Optional[str]	optional	1	Address Usage
xad_19	XAD.19	Optional[str]	optional		Addressee
xad_20	XAD.20	Optional[str]	optional		Comment
xad_21	XAD.21	Optional[str]	optional		Preference Order
xad_22	XAD.22	Optional[CWE]	optional		Protection Code
xad_23	XAD.23	Optional[EI]	optional		Address Identifier

class hl7types.hl7.v2_7.datatypes.XCN.XCN

HL7 v2 XCN data type.

XCN

Field	HL7	Type	Required	Max Length	Description
xcn_1	XCN.1	Optional[str]	optional		Person Identifier
xcn_2	XCN.2	Optional[FN]	optional		Family Name
xcn_3	XCN.3	Optional[str]	optional		Given Name
xcn_4	XCN.4	Optional[str]	optional		Second and Further Given Names or Initials Thereof
xcn_5	XCN.5	Optional[str]	optional		Suffix (e.g., JR or III)
xcn_6	XCN.6	Optional[str]	optional		Prefix (e.g., DR)
xcn_8	XCN.8	Optional[CWE]	optional		Source Table
xcn_9	XCN.9	Optional[HD]	optional		Assigning Authority
xcn_10	XCN.10	Optional[str]	optional	5	Name Type Code
xcn_11	XCN.11	Optional[str]	optional	4	Identifier Check Digit
xcn_12	XCN.12	Optional[str]	optional	3	Check Digit Scheme
xcn_13	XCN.13	Optional[str]	optional	5	Identifier Type Code
xcn_14	XCN.14	Optional[HD]	optional		Assigning Facility
xcn_15	XCN.15	Optional[str]	optional	1	Name Representation Code
xcn_16	XCN.16	Optional[CWE]	optional		Name Context
xcn_18	XCN.18	Optional[str]	optional	1	Name Assembly Order
xcn_19	XCN.19	Optional[str]	optional		Effective Date
xcn_20	XCN.20	Optional[str]	optional		Expiration Date
xcn_21	XCN.21	Optional[str]	optional		Professional Suffix
xcn_22	XCN.22	Optional[CWE]	optional		Assigning Jurisdiction
xcn_23	XCN.23	Optional[CWE]	optional		Assigning Agency or Department
xcn_24	XCN.24	Optional[str]	optional		Security Check
xcn_25	XCN.25	Optional[str]	optional	3	Security Check Scheme

class hl7types.hl7.v2_7.datatypes.XON.XON

HL7 v2 XON data type.

XON

Field	HL7	Type	Required	Max Length	Description
xon_1	XON.1	Optional[str]	optional		Organization Name
xon_2	XON.2	Optional[CWE]	optional		Organization Name Type Code
xon_4	XON.4	Optional[str]	optional		Identifier Check Digit
xon_5	XON.5	Optional[str]	optional	3	Check Digit Scheme
xon_6	XON.6	Optional[HD]	optional		Assigning Authority
xon_7	XON.7	Optional[str]	optional	5	Identifier Type Code
xon_8	XON.8	Optional[HD]	optional		Assigning Facility
xon_9	XON.9	Optional[str]	optional	1	Name Representation Code
xon_10	XON.10	Optional[str]	optional		Organization Identifier

class hl7types.hl7.v2_7.datatypes.XPN.XPN

HL7 v2 XPN data type.

XPN

Field	HL7	Type	Required	Max Length	Description
xpn_1	XPN.1	Optional[FN]	optional		Family Name
xpn_2	XPN.2	Optional[str]	optional		Given Name
xpn_3	XPN.3	Optional[str]	optional		Second and Further Given Names or Initials Thereof
xpn_4	XPN.4	Optional[str]	optional		Suffix (e.g., JR or III)
xpn_5	XPN.5	Optional[str]	optional		Prefix (e.g., DR)
xpn_7	XPN.7	Optional[str]	optional	5	Name Type Code
xpn_8	XPN.8	Optional[str]	optional	1	Name Representation Code
xpn_9	XPN.9	Optional[CWE]	optional		Name Context
xpn_11	XPN.11	Optional[str]	optional	1	Name Assembly Order
xpn_12	XPN.12	Optional[str]	optional		Effective Date
xpn_13	XPN.13	Optional[str]	optional		Expiration Date
xpn_14	XPN.14	Optional[str]	optional		Professional Suffix
xpn_15	XPN.15	Optional[str]	optional		Called By

class hl7types.hl7.v2_7.datatypes.XTN.XTN

HL7 v2 XTN data type.

XTN

Field	HL7	Type	Required	Max Length	Description
xtn_2	XTN.2	Optional[str]	optional	3	Telecommunication Use Code
xtn_3	XTN.3	str	required	8	Telecommunication Equipment Type
xtn_4	XTN.4	Optional[str]	optional		Communication Address
xtn_5	XTN.5	Optional[str]	optional		Country Code
xtn_6	XTN.6	Optional[str]	optional		Area/City Code
xtn_7	XTN.7	Optional[str]	optional		Local Number
xtn_8	XTN.8	Optional[str]	optional		Extension
xtn_9	XTN.9	Optional[str]	optional		Any Text
xtn_10	XTN.10	Optional[str]	optional		Extension Prefix
xtn_11	XTN.11	Optional[str]	optional		Speed Dial Code
xtn_12	XTN.12	Optional[str]	optional		Unformatted Telephone number
xtn_13	XTN.13	Optional[str]	optional		Effective Start Date
xtn_14	XTN.14	Optional[str]	optional		Expiration Date
xtn_15	XTN.15	Optional[CWE]	optional		Expiration Reason
xtn_16	XTN.16	Optional[CWE]	optional		Protection Code
xtn_17	XTN.17	Optional[EI]	optional		Shared Telecommunication Identifier
xtn_18	XTN.18	Optional[str]	optional		Preference Order