v2.3.1 Data Types

class hl7types.hl7.v2_3_1.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		country
ad_7	AD.7	Optional[str]	optional		address type
ad_8	AD.8	Optional[str]	optional		other geographic designation

class hl7types.hl7.v2_3_1.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[TS]	optional		date
aui_3	AUI.3	Optional[str]	optional		source

class hl7types.hl7.v2_3_1.datatypes.CCD.CCD

HL7 v2 CCD data type.

CCD

Field	HL7	Type	Required	Max Length	Description
ccd_1	CCD.1	Optional[str]	optional		when to charge code
ccd_2	CCD.2	Optional[TS]	optional		date/time

class hl7types.hl7.v2_3_1.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_3_1.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		electrode names
cd_3	CD.3	Optional[CSU]	optional		channel sensitivity/units
cd_4	CD.4	Optional[CCP]	optional		calibration parameters
cd_5	CD.5	Optional[str]	optional		sampling frequency
cd_6	CD.6	Optional[NR]	optional		minimum/maximum data values

class hl7types.hl7.v2_3_1.datatypes.CE.CE

HL7 v2 CE data type.

CE

Field	HL7	Type	Required	Max Length	Description
ce_1	CE.1	Optional[str]	optional		identifier
ce_2	CE.2	Optional[str]	optional		text
ce_3	CE.3	Optional[str]	optional		name of coding system
ce_4	CE.4	Optional[str]	optional		alternate identifier
ce_5	CE.5	Optional[str]	optional		alternate text
ce_6	CE.6	Optional[str]	optional		name of alternate coding system

class hl7types.hl7.v2_3_1.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		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		name of alternate coding system

class hl7types.hl7.v2_3_1.datatypes.CK.CK

HL7 v2 CK data type.

CK

Field	HL7	Type	Required	Max Length	Description
ck_1	CK.1	Optional[str]	optional		ID number (NM)
ck_2	CK.2	Optional[str]	optional		check digit
ck_3	CK.3	Optional[str]	optional		code identifying the check digit scheme employed
ck_4	CK.4	Optional[HD]	optional		assigning authority

class hl7types.hl7.v2_3_1.datatypes.CN.CN

HL7 v2 CN data type.

CN

Field	HL7	Type	Required	Max Length	Description
cn_1	CN.1	Optional[str]	optional		ID number (ST)
cn_2	CN.2	Optional[str]	optional		family name
cn_3	CN.3	Optional[str]	optional		given name
cn_4	CN.4	Optional[str]	optional		middle initial or name
cn_5	CN.5	Optional[str]	optional		suffix (e.g., JR or III)
cn_6	CN.6	Optional[str]	optional		prefix (e.g., DR)
cn_7	CN.7	Optional[str]	optional		degree (e.g., MD)
cn_8	CN.8	Optional[str]	optional		source table
cn_9	CN.9	Optional[HD]	optional		assigning authority

class hl7types.hl7.v2_3_1.datatypes.CNE.CNE

HL7 v2 CNE data type.

CNE

Field	HL7	Type	Required	Max Length	Description
cne_1	CNE.1	Optional[str]	optional		identifier
cne_2	CNE.2	Optional[str]	optional		text
cne_3	CNE.3	Optional[str]	optional		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		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

class hl7types.hl7.v2_3_1.datatypes.CNS.CNS

HL7 v2 CNS data type.

CNS

Field	HL7	Type	Required	Max Length	Description
cns_1	CNS.1	Optional[str]	optional		ID number (ST)
cns_2	CNS.2	Optional[str]	optional		family name
cns_3	CNS.3	Optional[str]	optional		given name
cns_4	CNS.4	Optional[str]	optional		second and further given names or initials thereof
cns_5	CNS.5	Optional[str]	optional		suffix (e.g., JR or III)
cns_6	CNS.6	Optional[str]	optional		prefix (e.g., DR)
cns_7	CNS.7	Optional[str]	optional		degree (e.g., MD)
cns_8	CNS.8	Optional[str]	optional		source table
cns_9	CNS.9	Optional[str]	optional		assigning authority namespace ID
cns_10	CNS.10	Optional[str]	optional		assigning authority universal ID
cns_11	CNS.11	Optional[str]	optional		assigning authority universal ID type

class hl7types.hl7.v2_3_1.datatypes.CP.CP

HL7 v2 CP data type.

CP

Field	HL7	Type	Required	Max Length	Description
cp_1	CP.1	Optional[MO]	optional		price
cp_2	CP.2	Optional[str]	optional		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[CE]	optional		range units
cp_6	CP.6	Optional[str]	optional		range type

class hl7types.hl7.v2_3_1.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[CE]	optional		units

class hl7types.hl7.v2_3_1.datatypes.CSU.CSU

HL7 v2 CSU data type.

CSU

Field	HL7	Type	Required	Max Length	Description
csu_1	CSU.1	Optional[str]	optional		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		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		alternate unit of measure coding system

class hl7types.hl7.v2_3_1.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		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		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

class hl7types.hl7.v2_3_1.datatypes.CX.CX

HL7 v2 CX data type.

CX

Field	HL7	Type	Required	Max Length	Description
cx_1	CX.1	Optional[str]	optional		ID
cx_2	CX.2	Optional[str]	optional		check digit
cx_3	CX.3	Optional[str]	optional		code identifying the check digit scheme employed
cx_4	CX.4	Optional[HD]	optional		assigning authority
cx_5	CX.5	Optional[str]	optional		identifier type code
cx_6	CX.6	Optional[HD]	optional		assigning facility

class hl7types.hl7.v2_3_1.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	Optional[str]	optional		amount
ddi_3	DDI.3	Optional[str]	optional		number of days

class hl7types.hl7.v2_3_1.datatypes.DIN.DIN

HL7 v2 DIN data type.

DIN

Field	HL7	Type	Required	Max Length	Description
din_1	DIN.1	Optional[TS]	optional		date
din_2	DIN.2	Optional[CE]	optional		institution name

class hl7types.hl7.v2_3_1.datatypes.DLD.DLD

HL7 v2 DLD data type.

DLD

Field	HL7	Type	Required	Max Length	Description
dld_1	DLD.1	Optional[str]	optional		discharge location
dld_2	DLD.2	Optional[TS]	optional		effective date

class hl7types.hl7.v2_3_1.datatypes.DLN.DLN

HL7 v2 DLN data type.

DLN

Field	HL7	Type	Required	Max Length	Description
dln_1	DLN.1	Optional[str]	optional		Driver´s License Number
dln_2	DLN.2	Optional[str]	optional		Issuing State, province, country
dln_3	DLN.3	Optional[str]	optional		expiration date

class hl7types.hl7.v2_3_1.datatypes.DLT.DLT

HL7 v2 DLT data type.

DLT

Field	HL7	Type	Required	Max Length	Description
dlt_1	DLT.1	Optional[NR]	optional		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		length of time-days

class hl7types.hl7.v2_3_1.datatypes.DR.DR

HL7 v2 DR data type.

DR

Field	HL7	Type	Required	Max Length	Description
dr_1	DR.1	Optional[TS]	optional		range start date/time
dr_2	DR.2	Optional[TS]	optional		range end date/time

class hl7types.hl7.v2_3_1.datatypes.DTN.DTN

HL7 v2 DTN data type.

DTN

Field	HL7	Type	Required	Max Length	Description
dtn_1	DTN.1	Optional[str]	optional		day type
dtn_2	DTN.2	Optional[str]	optional		number of days

class hl7types.hl7.v2_3_1.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	Optional[str]	optional		type of data
ed_3	ED.3	Optional[str]	optional		data
ed_4	ED.4	Optional[str]	optional		encoding
ed_5	ED.5	Optional[str]	optional		data

class hl7types.hl7.v2_3_1.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		universal ID type

class hl7types.hl7.v2_3_1.datatypes.EIP.EIP

HL7 v2 EIP data type.

EIP

Field	HL7	Type	Required	Max Length	Description
eip_1	EIP.1	Optional[EI]	optional		parent´s placer order number
eip_2	EIP.2	Optional[EI]	optional		parent´s filler order number

class hl7types.hl7.v2_3_1.datatypes.ELD.ELD

HL7 v2 ELD data type.

ELD

Field	HL7	Type	Required	Max Length	Description
eld_1	ELD.1	Optional[str]	optional		segment ID
eld_2	ELD.2	Optional[str]	optional		sequence
eld_3	ELD.3	Optional[str]	optional		field position
eld_4	ELD.4	Optional[CE]	optional		code identifying error

class hl7types.hl7.v2_3_1.datatypes.FC.FC

HL7 v2 FC data type.

FC

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

class hl7types.hl7.v2_3_1.datatypes.FN.FN

HL7 v2 FN data type.

FN

Field	HL7	Type	Required	Max Length	Description
fn_1	FN.1	Optional[str]	optional		family name
fn_2	FN.2	Optional[str]	optional		last name prefix

class hl7types.hl7.v2_3_1.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		universal ID type

class hl7types.hl7.v2_3_1.datatypes.JCC.JCC

HL7 v2 JCC data type.

JCC

Field	HL7	Type	Required	Max Length	Description
jcc_1	JCC.1	Optional[str]	optional		job code
jcc_2	JCC.2	Optional[str]	optional		job class

class hl7types.hl7.v2_3_1.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 (IS)
la1_2	LA1.2	Optional[str]	optional		room
la1_3	LA1.3	Optional[str]	optional		bed
la1_4	LA1.4	Optional[HD]	optional		facility (HD)
la1_5	LA1.5	Optional[str]	optional		location status
la1_6	LA1.6	Optional[str]	optional		person 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_3_1.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 (IS)
la2_2	LA2.2	Optional[str]	optional		room
la2_3	LA2.3	Optional[str]	optional		bed
la2_4	LA2.4	Optional[HD]	optional		facility (HD)
la2_5	LA2.5	Optional[str]	optional		location status
la2_6	LA2.6	Optional[str]	optional		person 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		country
la2_15	LA2.15	Optional[str]	optional		address type
la2_16	LA2.16	Optional[str]	optional		other geographic designation

class hl7types.hl7.v2_3_1.datatypes.MA.MA

HL7 v2 MA data type.

MA

Field	HL7	Type	Required	Max Length	Description
ma_1	MA.1	Optional[str]	optional		sample 1 from channel 1
ma_2	MA.2	Optional[str]	optional		sample 1 from channel 2
ma_3	MA.3	Optional[str]	optional		sample 1 from channel 3
ma_4	MA.4	Optional[str]	optional		sample 2 from channel 1
ma_5	MA.5	Optional[str]	optional		sample 2 from channel 2
ma_6	MA.6	Optional[str]	optional		sample 2 from channel 3

class hl7types.hl7.v2_3_1.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		denomination

class hl7types.hl7.v2_3_1.datatypes.MOC.MOC

HL7 v2 MOC data type.

MOC

Field	HL7	Type	Required	Max Length	Description
moc_1	MOC.1	Optional[MO]	optional		dollar amount
moc_2	MOC.2	Optional[CE]	optional		charge code

class hl7types.hl7.v2_3_1.datatypes.MOP.MOP

HL7 v2 MOP data type.

MOP

Field	HL7	Type	Required	Max Length	Description
mop_1	MOP.1	Optional[str]	optional		money or percentage indicator
mop_2	MOP.2	Optional[str]	optional		money or percentage quantity

class hl7types.hl7.v2_3_1.datatypes.MSG.MSG

HL7 v2 MSG data type.

MSG

Field	HL7	Type	Required	Max Length	Description
msg_1	MSG.1	Optional[str]	optional		message type
msg_2	MSG.2	Optional[str]	optional		trigger event
msg_3	MSG.3	Optional[str]	optional		message structure

class hl7types.hl7.v2_3_1.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_3_1.datatypes.NDL.NDL

HL7 v2 NDL data type.

NDL

Field	HL7	Type	Required	Max Length	Description
ndl_1	NDL.1	Optional[CN]	optional		name
ndl_2	NDL.2	Optional[TS]	optional		start date/time
ndl_3	NDL.3	Optional[TS]	optional		end date/time
ndl_4	NDL.4	Optional[str]	optional		point of care (IS)
ndl_5	NDL.5	Optional[str]	optional		room
ndl_6	NDL.6	Optional[str]	optional		bed
ndl_7	NDL.7	Optional[HD]	optional		facility (HD)
ndl_8	NDL.8	Optional[str]	optional		location status
ndl_9	NDL.9	Optional[str]	optional		person location type
ndl_10	NDL.10	Optional[str]	optional		building
ndl_11	NDL.11	Optional[str]	optional		floor

class hl7types.hl7.v2_3_1.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_3_1.datatypes.OCD.OCD

HL7 v2 OCD data type.

OCD

Field	HL7	Type	Required	Max Length	Description
ocd_1	OCD.1	Optional[str]	optional		occurrence code
ocd_2	OCD.2	Optional[str]	optional		occurrence date

class hl7types.hl7.v2_3_1.datatypes.OSD.OSD

HL7 v2 OSD data type.

OSD

Field	HL7	Type	Required	Max Length	Description
osd_1	OSD.1	Optional[str]	optional		sequence/results flag
osd_2	OSD.2	Optional[str]	optional		placer order number: entity identifier
osd_3	OSD.3	Optional[str]	optional		placer order number: namespace ID
osd_4	OSD.4	Optional[str]	optional		filler order number: entity identifier
osd_5	OSD.5	Optional[str]	optional		filler order number: namespace ID
osd_6	OSD.6	Optional[str]	optional		sequence condition value
osd_7	OSD.7	Optional[str]	optional		maximum number of repeats
osd_8	OSD.8	Optional[str]	optional		placer order number: universal ID
osd_9	OSD.9	Optional[str]	optional		placer order number; universal ID type
osd_10	OSD.10	Optional[str]	optional		filler order number: universal ID
osd_11	OSD.11	Optional[str]	optional		filler order number: universal ID type

class hl7types.hl7.v2_3_1.datatypes.OSP.OSP

HL7 v2 OSP data type.

OSP

Field	HL7	Type	Required	Max Length	Description
osp_1	OSP.1	Optional[CE]	optional		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_3_1.datatypes.PCF.PCF

HL7 v2 PCF data type.

PCF

Field	HL7	Type	Required	Max Length	Description
pcf_1	PCF.1	Optional[str]	optional		pre-certification patient type
pcf_2	PCF.2	Optional[str]	optional		pre-certification required
pcf_3	PCF.3	Optional[TS]	optional		pre-certification window

class hl7types.hl7.v2_3_1.datatypes.PI.PI

HL7 v2 PI data type.

PI

Field	HL7	Type	Required	Max Length	Description
pi_1	PI.1	Optional[str]	optional		ID number (ST)
pi_2	PI.2	Optional[str]	optional		type of ID number (IS)
pi_3	PI.3	Optional[str]	optional		other qualifying info

class hl7types.hl7.v2_3_1.datatypes.PIP.PIP

HL7 v2 PIP data type.

PIP

Field	HL7	Type	Required	Max Length	Description
pip_1	PIP.1	Optional[CE]	optional		privilege
pip_2	PIP.2	Optional[CE]	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 (EI)

class hl7types.hl7.v2_3_1.datatypes.PL.PL

HL7 v2 PL data type.

PL

Field	HL7	Type	Required	Max Length	Description
pl_1	PL.1	Optional[str]	optional		point of care
pl_2	PL.2	Optional[str]	optional		room
pl_3	PL.3	Optional[str]	optional		bed
pl_4	PL.4	Optional[HD]	optional		facility (HD)
pl_5	PL.5	Optional[str]	optional		location status
pl_6	PL.6	Optional[str]	optional		person location type
pl_7	PL.7	Optional[str]	optional		building
pl_8	PL.8	Optional[str]	optional		floor
pl_9	PL.9	Optional[str]	optional		Location description

class hl7types.hl7.v2_3_1.datatypes.PLN.PLN

HL7 v2 PLN data type.

PLN

Field	HL7	Type	Required	Max Length	Description
pln_1	PLN.1	Optional[str]	optional		ID number (ST)
pln_2	PLN.2	Optional[str]	optional		type of ID number (IS)
pln_3	PLN.3	Optional[str]	optional		state/other qualifying info
pln_4	PLN.4	Optional[str]	optional		expiration date

class hl7types.hl7.v2_3_1.datatypes.PN.PN

HL7 v2 PN data type.

PN

Field	HL7	Type	Required	Max Length	Description
pn_1	PN.1	Optional[FN]	optional		family+last name
pn_2	PN.2	Optional[str]	optional		given name
pn_3	PN.3	Optional[str]	optional		middle initial or name
pn_4	PN.4	Optional[str]	optional		suffix (e.g., JR or III)
pn_5	PN.5	Optional[str]	optional		prefix (e.g., DR)
pn_6	PN.6	Optional[str]	optional		degree (e.g., MD)

class hl7types.hl7.v2_3_1.datatypes.PPN.PPN

HL7 v2 PPN data type.

PPN

Field	HL7	Type	Required	Max Length	Description
ppn_1	PPN.1	Optional[str]	optional		ID number (ST)
ppn_2	PPN.2	Optional[FN]	optional		family+last name
ppn_3	PPN.3	Optional[str]	optional		given name
ppn_4	PPN.4	Optional[str]	optional		middle initial or name
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_7	PPN.7	Optional[str]	optional		degree (e.g., MD)
ppn_8	PPN.8	Optional[str]	optional		source table
ppn_9	PPN.9	Optional[HD]	optional		assigning authority
ppn_10	PPN.10	Optional[str]	optional		name type code
ppn_11	PPN.11	Optional[str]	optional		identifier check digit
ppn_12	PPN.12	Optional[str]	optional		code identifying the check digit scheme employed
ppn_13	PPN.13	Optional[str]	optional		identifier type code
ppn_14	PPN.14	Optional[HD]	optional		assigning facility
ppn_15	PPN.15	Optional[TS]	optional		Date/Time Action Performed
ppn_16	PPN.16	Optional[str]	optional		Name Representation code

class hl7types.hl7.v2_3_1.datatypes.PRL.PRL

HL7 v2 PRL data type.

PRL

Field	HL7	Type	Required	Max Length	Description
prl_1	PRL.1	Optional[CE]	optional		OBX-3 observation identifier of parent result
prl_2	PRL.2	Optional[str]	optional		OBX-4 sub-ID of parent result
prl_3	PRL.3	Optional[TX]	optional		part of OBX-5 observation result from parent

class hl7types.hl7.v2_3_1.datatypes.PT.PT

HL7 v2 PT data type.

PT

Field	HL7	Type	Required	Max Length	Description
pt_1	PT.1	Optional[str]	optional		processing ID
pt_2	PT.2	Optional[str]	optional		processing mode

class hl7types.hl7.v2_3_1.datatypes.PTA.PTA

HL7 v2 PTA data type.

PTA

Field	HL7	Type	Required	Max Length	Description
pta_1	PTA.1	Optional[str]	optional		policy type
pta_2	PTA.2	Optional[str]	optional		amount class
pta_3	PTA.3	Optional[str]	optional		amount

class hl7types.hl7.v2_3_1.datatypes.QIP.QIP

HL7 v2 QIP data type.

QIP

Field	HL7	Type	Required	Max Length	Description
qip_1	QIP.1	Optional[str]	optional		field name
qip_2	QIP.2	Optional[str]	optional		value1&value2&value3

class hl7types.hl7.v2_3_1.datatypes.QSC.QSC

HL7 v2 QSC data type.

QSC

Field	HL7	Type	Required	Max Length	Description
qsc_1	QSC.1	Optional[str]	optional		segment field name
qsc_2	QSC.2	Optional[str]	optional		relational operator
qsc_3	QSC.3	Optional[str]	optional		Value
qsc_4	QSC.4	Optional[str]	optional		relational conjunction

class hl7types.hl7.v2_3_1.datatypes.RCD.RCD

HL7 v2 RCD data type.

RCD

Field	HL7	Type	Required	Max Length	Description
rcd_1	RCD.1	Optional[str]	optional		segment field name
rcd_2	RCD.2	Optional[str]	optional		HL7 date type
rcd_3	RCD.3	Optional[str]	optional		maximum column width

class hl7types.hl7.v2_3_1.datatypes.RFR.RFR

HL7 v2 RFR data type.

RFR

Field	HL7	Type	Required	Max Length	Description
rfr_1	RFR.1	Optional[NR]	optional		numeric range
rfr_2	RFR.2	Optional[str]	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[TX]	optional		species
rfr_6	RFR.6	Optional[str]	optional		race/subspecies
rfr_7	RFR.7	Optional[TX]	optional		conditions

class hl7types.hl7.v2_3_1.datatypes.RI.RI

HL7 v2 RI data type.

RI

Field	HL7	Type	Required	Max Length	Description
ri_1	RI.1	Optional[str]	optional		repeat pattern
ri_2	RI.2	Optional[str]	optional		explicit time interval

class hl7types.hl7.v2_3_1.datatypes.RMC.RMC

HL7 v2 RMC data type.

RMC

Field	HL7	Type	Required	Max Length	Description
rmc_1	RMC.1	Optional[str]	optional		room type
rmc_2	RMC.2	Optional[str]	optional		amount type
rmc_3	RMC.3	Optional[str]	optional		coverage amount

class hl7types.hl7.v2_3_1.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		type of data
rp_4	RP.4	Optional[str]	optional		subtype

class hl7types.hl7.v2_3_1.datatypes.SCV.SCV

HL7 v2 SCV data type.

SCV

Field	HL7	Type	Required	Max Length	Description
scv_1	SCV.1	Optional[str]	optional		parameter class
scv_2	SCV.2	Optional[str]	optional		parameter value

class hl7types.hl7.v2_3_1.datatypes.SN.SN

HL7 v2 SN data type.

SN

Field	HL7	Type	Required	Max Length	Description
sn_1	SN.1	Optional[str]	optional		comparator
sn_2	SN.2	Optional[str]	optional		num1
sn_3	SN.3	Optional[str]	optional		separator or suffix
sn_4	SN.4	Optional[str]	optional		num2

class hl7types.hl7.v2_3_1.datatypes.SPD.SPD

HL7 v2 SPD data type.

SPD

Field	HL7	Type	Required	Max Length	Description
spd_1	SPD.1	Optional[str]	optional		specialty name
spd_2	SPD.2	Optional[str]	optional		governing board
spd_3	SPD.3	Optional[str]	optional		eligible or certified
spd_4	SPD.4	Optional[str]	optional		date of certification

class hl7types.hl7.v2_3_1.datatypes.SPS.SPS

HL7 v2 SPS data type.

SPS

Field	HL7	Type	Required	Max Length	Description
sps_1	SPS.1	Optional[CE]	optional		specimen source name or code
sps_2	SPS.2	Optional[TX]	optional		additives
sps_3	SPS.3	Optional[TX]	optional		freetext
sps_4	SPS.4	Optional[CE]	optional		body site
sps_5	SPS.5	Optional[CE]	optional		site modifier
sps_6	SPS.6	Optional[CE]	optional		collection modifier method code
sps_7	SPS.7	Optional[CE]	optional		specimen role

class hl7types.hl7.v2_3_1.datatypes.TQ.TQ

HL7 v2 TQ data type.

TQ

Field	HL7	Type	Required	Max Length	Description
tq_1	TQ.1	Optional[CQ]	optional		quantity
tq_2	TQ.2	Optional[RI]	optional		interval
tq_3	TQ.3	Optional[str]	optional		duration
tq_4	TQ.4	Optional[TS]	optional		start date/time
tq_5	TQ.5	Optional[TS]	optional		end date/time
tq_6	TQ.6	Optional[str]	optional		priority
tq_7	TQ.7	Optional[str]	optional		condition
tq_8	TQ.8	Optional[str]	optional		text
tq_9	TQ.9	Optional[str]	optional		conjunction
tq_10	TQ.10	Optional[OSD]	optional		order sequencing
tq_11	TQ.11	Optional[CE]	optional		occurrence duration
tq_12	TQ.12	Optional[str]	optional		total occurences

class hl7types.hl7.v2_3_1.datatypes.TS.TS

HL7 v2 TS data type.

TS

Field	HL7	Type	Required	Max Length	Description
ts_1	TS.1	Optional[str]	optional		time of an event
ts_2	TS.2	Optional[str]	optional		degree of precision

class hl7types.hl7.v2_3_1.datatypes.TX_CHALLENGE.TX_CHALLENGE

HL7 v2 TX_CHALLENGE data type.

TX_CHALLENGE

Field	HL7	Type	Required	Max Length	Description
tx_challenge_1	TX_CHALLENGE.1	Optional[TX]	optional
tx_challenge_2	TX_CHALLENGE.2	Optional[TX]	optional

class hl7types.hl7.v2_3_1.datatypes.UVC.UVC

HL7 v2 UVC data type.

UVC

Field	HL7	Type	Required	Max Length	Description
uvc_1	UVC.1	Optional[str]	optional		value code
uvc_2	UVC.2	Optional[str]	optional		value amount

class hl7types.hl7.v2_3_1.datatypes.VH.VH

HL7 v2 VH data type.

VH

Field	HL7	Type	Required	Max Length	Description
vh_1	VH.1	Optional[str]	optional		start day range
vh_2	VH.2	Optional[str]	optional		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_3_1.datatypes.VID.VID

HL7 v2 VID data type.

VID

Field	HL7	Type	Required	Max Length	Description
vid_1	VID.1	Optional[str]	optional		version ID
vid_2	VID.2	Optional[CE]	optional		internationalization code
vid_3	VID.3	Optional[CE]	optional		international version ID

class hl7types.hl7.v2_3_1.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 calue

class hl7types.hl7.v2_3_1.datatypes.WVI.WVI

HL7 v2 WVI data type.

WVI

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

class hl7types.hl7.v2_3_1.datatypes.WVS.WVS

HL7 v2 WVS data type.

WVS

Field	HL7	Type	Required	Max Length	Description
wvs_1	WVS.1	Optional[str]	optional		source name 1
wvs_2	WVS.2	Optional[str]	optional		source name 2

class hl7types.hl7.v2_3_1.datatypes.XAD.XAD

HL7 v2 XAD data type.

XAD

Field	HL7	Type	Required	Max Length	Description
xad_1	XAD.1	Optional[str]	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		country
xad_7	XAD.7	Optional[str]	optional		address type
xad_8	XAD.8	Optional[str]	optional		other geographic designation
xad_9	XAD.9	Optional[str]	optional		county/parish code
xad_10	XAD.10	Optional[str]	optional		census tract
xad_11	XAD.11	Optional[str]	optional		address representation code

class hl7types.hl7.v2_3_1.datatypes.XCN.XCN

HL7 v2 XCN data type.

XCN

Field	HL7	Type	Required	Max Length	Description
xcn_1	XCN.1	Optional[str]	optional		ID number (ST)
xcn_2	XCN.2	Optional[FN]	optional		family+last name
xcn_3	XCN.3	Optional[str]	optional		given name
xcn_4	XCN.4	Optional[str]	optional		middle initial or name
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_7	XCN.7	Optional[str]	optional		degree (e.g., MD)
xcn_8	XCN.8	Optional[str]	optional		source table
xcn_9	XCN.9	Optional[HD]	optional		assigning authority
xcn_10	XCN.10	Optional[str]	optional		name type code
xcn_11	XCN.11	Optional[str]	optional		identifier check digit
xcn_12	XCN.12	Optional[str]	optional		code identifying the check digit scheme employed
xcn_13	XCN.13	Optional[str]	optional		identifier type code
xcn_14	XCN.14	Optional[HD]	optional		assigning facility
xcn_15	XCN.15	Optional[str]	optional		Name Representation code

class hl7types.hl7.v2_3_1.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[str]	optional		organization name type code
xon_3	XON.3	Optional[str]	optional		ID number (NM)
xon_4	XON.4	Optional[str]	optional		check digit
xon_5	XON.5	Optional[str]	optional		code identifying the check digit scheme employed
xon_6	XON.6	Optional[HD]	optional		assigning authority
xon_7	XON.7	Optional[str]	optional		identifier type code
xon_8	XON.8	Optional[HD]	optional		assigning facility ID
xon_9	XON.9	Optional[str]	optional		Name Representation code

class hl7types.hl7.v2_3_1.datatypes.XPN.XPN

HL7 v2 XPN data type.

XPN

Field	HL7	Type	Required	Max Length	Description
xpn_1	XPN.1	Optional[FN]	optional		family+last name
xpn_2	XPN.2	Optional[str]	optional		given name
xpn_3	XPN.3	Optional[str]	optional		middle initial or name
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_6	XPN.6	Optional[str]	optional		degree (e.g., MD)
xpn_7	XPN.7	Optional[str]	optional		name type code
xpn_8	XPN.8	Optional[str]	optional		Name Representation code

class hl7types.hl7.v2_3_1.datatypes.XTN.XTN

HL7 v2 XTN data type.

XTN

Field	HL7	Type	Required	Max Length	Description
xtn_1	XTN.1	Optional[str]	optional		[(999)] 999-9999 [X99999][C any text]
xtn_2	XTN.2	Optional[str]	optional		telecommunication use code
xtn_3	XTN.3	Optional[str]	optional		telecommunication equipment type (ID)
xtn_4	XTN.4	Optional[str]	optional		Email 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		Phone number
xtn_8	XTN.8	Optional[str]	optional		Extension
xtn_9	XTN.9	Optional[str]	optional		any text