v2.8 Data Types =============== .. _hl7-v2_8-AD: .. py:class:: hl7types.hl7.v2_8.datatypes.AD.AD :noindex: HL7 v2 AD data type. AD ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-AUI: .. py:class:: hl7types.hl7.v2_8.datatypes.AUI.AUI :noindex: HL7 v2 AUI data type. AUI ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CCD: .. py:class:: hl7types.hl7.v2_8.datatypes.CCD.CCD :noindex: HL7 v2 CCD data type. CCD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CCP: .. py:class:: hl7types.hl7.v2_8.datatypes.CCP.CCP :noindex: HL7 v2 CCP data type. CCP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CD: .. py:class:: hl7types.hl7.v2_8.datatypes.CD.CD :noindex: HL7 v2 CD data type. CD ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``cd_1`` - CD.1 - Optional[:ref:`WVI `] - optional - - Channel Identifier * - ``cd_2`` - CD.2 - Optional[:ref:`WVS `] - optional - - Waveform Source * - ``cd_3`` - CD.3 - Optional[:ref:`CSU `] - optional - - Channel Sensitivity and Units * - ``cd_4`` - CD.4 - Optional[:ref:`CCP `] - optional - - Channel Calibration Parameters * - ``cd_5`` - CD.5 - Optional[str] - optional - - Channel Sampling Frequency * - ``cd_6`` - CD.6 - Optional[:ref:`NR `] - optional - - Minimum and Maximum Data Values .. _hl7-v2_8-CF: .. py:class:: hl7types.hl7.v2_8.datatypes.CF.CF :noindex: HL7 v2 CF data type. CF ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``cf_1`` - CF.1 - Optional[str] - optional - - Identifier * - ``cf_2`` - CF.2 - Optional[:ref:`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[:ref:`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[:ref:`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 .. _hl7-v2_8-CNE: .. py:class:: hl7types.hl7.v2_8.datatypes.CNE.CNE :noindex: HL7 v2 CNE data type. CNE ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CNN: .. py:class:: hl7types.hl7.v2_8.datatypes.CNN.CNN :noindex: HL7 v2 CNN data type. CNN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CP: .. py:class:: hl7types.hl7.v2_8.datatypes.CP.CP :noindex: HL7 v2 CP data type. CP ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``cp_1`` - CP.1 - :ref:`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[:ref:`CWE `] - optional - - Range Units * - ``cp_6`` - CP.6 - Optional[str] - optional - 1 - Range Type .. _hl7-v2_8-CQ: .. py:class:: hl7types.hl7.v2_8.datatypes.CQ.CQ :noindex: HL7 v2 CQ data type. CQ ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``cq_1`` - CQ.1 - Optional[str] - optional - - Quantity * - ``cq_2`` - CQ.2 - Optional[:ref:`CWE `] - optional - - Units .. _hl7-v2_8-CSU: .. py:class:: hl7types.hl7.v2_8.datatypes.CSU.CSU :noindex: HL7 v2 CSU data type. CSU ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CWE: .. py:class:: hl7types.hl7.v2_8.datatypes.CWE.CWE :noindex: HL7 v2 CWE data type. CWE ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-CX: .. py:class:: hl7types.hl7.v2_8.datatypes.CX.CX :noindex: HL7 v2 CX data type. CX ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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[:ref:`HD `] - optional - - Assigning Authority * - ``cx_5`` - CX.5 - str - required - 5 - Identifier Type Code * - ``cx_6`` - CX.6 - Optional[:ref:`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[:ref:`CWE `] - optional - - Assigning Jurisdiction * - ``cx_10`` - CX.10 - Optional[:ref:`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 .. _hl7-v2_8-DDI: .. py:class:: hl7types.hl7.v2_8.datatypes.DDI.DDI :noindex: HL7 v2 DDI data type. DDI ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ddi_1`` - DDI.1 - Optional[str] - optional - - Delay Days * - ``ddi_2`` - DDI.2 - :ref:`MO ` - required - - Monetary Amount * - ``ddi_3`` - DDI.3 - Optional[str] - optional - - Number of Days .. _hl7-v2_8-DIN: .. py:class:: hl7types.hl7.v2_8.datatypes.DIN.DIN :noindex: HL7 v2 DIN data type. DIN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``din_1`` - DIN.1 - str - required - - Date * - ``din_2`` - DIN.2 - :ref:`CWE ` - required - - Institution Name .. _hl7-v2_8-DLD: .. py:class:: hl7types.hl7.v2_8.datatypes.DLD.DLD :noindex: HL7 v2 DLD data type. DLD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``dld_1`` - DLD.1 - :ref:`CWE ` - required - - Discharge to Location * - ``dld_2`` - DLD.2 - Optional[str] - optional - - Effective Date .. _hl7-v2_8-DLN: .. py:class:: hl7types.hl7.v2_8.datatypes.DLN.DLN :noindex: HL7 v2 DLN data type. DLN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``dln_1`` - DLN.1 - str - required - - License Number * - ``dln_2`` - DLN.2 - Optional[:ref:`CWE `] - optional - - Issuing State, Province, Country * - ``dln_3`` - DLN.3 - Optional[str] - optional - - Expiration Date .. _hl7-v2_8-DLT: .. py:class:: hl7types.hl7.v2_8.datatypes.DLT.DLT :noindex: HL7 v2 DLT data type. DLT ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``dlt_1`` - DLT.1 - Optional[:ref:`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 .. _hl7-v2_8-DR: .. py:class:: hl7types.hl7.v2_8.datatypes.DR.DR :noindex: HL7 v2 DR data type. DR ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-DTN: .. py:class:: hl7types.hl7.v2_8.datatypes.DTN.DTN :noindex: HL7 v2 DTN data type. DTN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``dtn_1`` - DTN.1 - :ref:`CWE ` - required - - Day Type * - ``dtn_2`` - DTN.2 - str - required - - Number of Days .. _hl7-v2_8-ED: .. py:class:: hl7types.hl7.v2_8.datatypes.ED.ED :noindex: HL7 v2 ED data type. ED ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ed_1`` - ED.1 - Optional[:ref:`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 - :ref:`TX ` - required - - Data .. _hl7-v2_8-EI: .. py:class:: hl7types.hl7.v2_8.datatypes.EI.EI :noindex: HL7 v2 EI data type. EI ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-EIP: .. py:class:: hl7types.hl7.v2_8.datatypes.EIP.EIP :noindex: HL7 v2 EIP data type. EIP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``eip_1`` - EIP.1 - Optional[:ref:`EI `] - optional - - Placer Assigned Identifier * - ``eip_2`` - EIP.2 - Optional[:ref:`EI `] - optional - - Filler Assigned Identifier .. _hl7-v2_8-ERL: .. py:class:: hl7types.hl7.v2_8.datatypes.ERL.ERL :noindex: HL7 v2 ERL data type. ERL ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-FC: .. py:class:: hl7types.hl7.v2_8.datatypes.FC.FC :noindex: HL7 v2 FC data type. FC ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``fc_1`` - FC.1 - :ref:`CWE ` - required - - Financial Class Code * - ``fc_2`` - FC.2 - Optional[str] - optional - - Effective Date .. _hl7-v2_8-FN: .. py:class:: hl7types.hl7.v2_8.datatypes.FN.FN :noindex: HL7 v2 FN data type. FN ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-HD: .. py:class:: hl7types.hl7.v2_8.datatypes.HD.HD :noindex: HL7 v2 HD data type. HD ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-ICD: .. py:class:: hl7types.hl7.v2_8.datatypes.ICD.ICD :noindex: HL7 v2 ICD data type. ICD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``icd_1`` - ICD.1 - Optional[:ref:`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 .. _hl7-v2_8-JCC: .. py:class:: hl7types.hl7.v2_8.datatypes.JCC.JCC :noindex: HL7 v2 JCC data type. JCC ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``jcc_1`` - JCC.1 - Optional[:ref:`CWE `] - optional - - Job Code * - ``jcc_2`` - JCC.2 - Optional[:ref:`CWE `] - optional - - Job Class * - ``jcc_3`` - JCC.3 - Optional[:ref:`TX `] - optional - - Job Description Text .. _hl7-v2_8-MA: .. py:class:: hl7types.hl7.v2_8.datatypes.MA.MA :noindex: HL7 v2 MA data type. MA ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-MO: .. py:class:: hl7types.hl7.v2_8.datatypes.MO.MO :noindex: HL7 v2 MO data type. MO ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``mo_1`` - MO.1 - Optional[str] - optional - - Quantity * - ``mo_2`` - MO.2 - Optional[str] - optional - 3 - Denomination .. _hl7-v2_8-MOC: .. py:class:: hl7types.hl7.v2_8.datatypes.MOC.MOC :noindex: HL7 v2 MOC data type. MOC ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``moc_1`` - MOC.1 - Optional[:ref:`MO `] - optional - - Monetary Amount * - ``moc_2`` - MOC.2 - Optional[:ref:`CWE `] - optional - - Charge Code .. _hl7-v2_8-MOP: .. py:class:: hl7types.hl7.v2_8.datatypes.MOP.MOP :noindex: HL7 v2 MOP data type. MOP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-MSG: .. py:class:: hl7types.hl7.v2_8.datatypes.MSG.MSG :noindex: HL7 v2 MSG data type. MSG ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-NA: .. py:class:: hl7types.hl7.v2_8.datatypes.NA.NA :noindex: HL7 v2 NA data type. NA ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-NDL: .. py:class:: hl7types.hl7.v2_8.datatypes.NDL.NDL :noindex: HL7 v2 NDL data type. NDL ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ndl_1`` - NDL.1 - Optional[:ref:`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[:ref:`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 .. _hl7-v2_8-NR: .. py:class:: hl7types.hl7.v2_8.datatypes.NR.NR :noindex: HL7 v2 NR data type. NR ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-OCD: .. py:class:: hl7types.hl7.v2_8.datatypes.OCD.OCD :noindex: HL7 v2 OCD data type. OCD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ocd_1`` - OCD.1 - :ref:`CNE ` - required - - Occurrence Code * - ``ocd_2`` - OCD.2 - str - required - - Occurrence Date .. _hl7-v2_8-OSP: .. py:class:: hl7types.hl7.v2_8.datatypes.OSP.OSP :noindex: HL7 v2 OSP data type. OSP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``osp_1`` - OSP.1 - :ref:`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 .. _hl7-v2_8-PIP: .. py:class:: hl7types.hl7.v2_8.datatypes.PIP.PIP :noindex: HL7 v2 PIP data type. PIP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``pip_1`` - PIP.1 - :ref:`CWE ` - required - - Privilege * - ``pip_2`` - PIP.2 - Optional[:ref:`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[:ref:`EI `] - optional - - Facility .. _hl7-v2_8-PL: .. py:class:: hl7types.hl7.v2_8.datatypes.PL.PL :noindex: HL7 v2 PL data type. PL ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``pl_1`` - PL.1 - Optional[:ref:`HD `] - optional - - Point of Care * - ``pl_2`` - PL.2 - Optional[:ref:`HD `] - optional - - Room * - ``pl_3`` - PL.3 - Optional[:ref:`HD `] - optional - - Bed * - ``pl_4`` - PL.4 - Optional[:ref:`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[:ref:`HD `] - optional - - Building * - ``pl_8`` - PL.8 - Optional[:ref:`HD `] - optional - - Floor * - ``pl_9`` - PL.9 - Optional[str] - optional - - Location Description * - ``pl_10`` - PL.10 - Optional[:ref:`EI `] - optional - - Comprehensive Location Identifier * - ``pl_11`` - PL.11 - Optional[:ref:`HD `] - optional - - Assigning Authority for Location .. _hl7-v2_8-PLN: .. py:class:: hl7types.hl7.v2_8.datatypes.PLN.PLN :noindex: HL7 v2 PLN data type. PLN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``pln_1`` - PLN.1 - str - required - - ID Number * - ``pln_2`` - PLN.2 - :ref:`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 .. _hl7-v2_8-PPN: .. py:class:: hl7types.hl7.v2_8.datatypes.PPN.PPN :noindex: HL7 v2 PPN data type. PPN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ppn_1`` - PPN.1 - Optional[str] - optional - - Person Identifier * - ``ppn_2`` - PPN.2 - Optional[:ref:`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[:ref:`CWE `] - optional - - Source Table * - ``ppn_9`` - PPN.9 - Optional[:ref:`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[:ref:`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[:ref:`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[:ref:`CWE `] - optional - - Assigning Jurisdiction * - ``ppn_24`` - PPN.24 - Optional[:ref:`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 .. _hl7-v2_8-PRL: .. py:class:: hl7types.hl7.v2_8.datatypes.PRL.PRL :noindex: HL7 v2 PRL data type. PRL ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``prl_1`` - PRL.1 - :ref:`CWE ` - required - - Parent Observation Identifier * - ``prl_2`` - PRL.2 - Optional[str] - optional - - Parent Observation Sub-identifier * - ``prl_3`` - PRL.3 - Optional[:ref:`TX `] - optional - - Parent Observation Value Descriptor .. _hl7-v2_8-PT: .. py:class:: hl7types.hl7.v2_8.datatypes.PT.PT :noindex: HL7 v2 PT data type. PT ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-PTA: .. py:class:: hl7types.hl7.v2_8.datatypes.PTA.PTA :noindex: HL7 v2 PTA data type. PTA ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``pta_1`` - PTA.1 - :ref:`CWE ` - required - - Policy Type * - ``pta_2`` - PTA.2 - Optional[:ref:`CWE `] - optional - - Amount Class * - ``pta_4`` - PTA.4 - :ref:`MOP ` - required - - Money or Percentage .. _hl7-v2_8-QIP: .. py:class:: hl7types.hl7.v2_8.datatypes.QIP.QIP :noindex: HL7 v2 QIP data type. QIP ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``qip_1`` - QIP.1 - str - required - 12 - Segment Field Name * - ``qip_2`` - QIP.2 - str - required - - Values .. _hl7-v2_8-QSC: .. py:class:: hl7types.hl7.v2_8.datatypes.QSC.QSC :noindex: HL7 v2 QSC data type. QSC ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-RCD: .. py:class:: hl7types.hl7.v2_8.datatypes.RCD.RCD :noindex: HL7 v2 RCD data type. RCD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-RFR: .. py:class:: hl7types.hl7.v2_8.datatypes.RFR.RFR :noindex: HL7 v2 RFR data type. RFR ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``rfr_1`` - RFR.1 - :ref:`NR ` - required - - Numeric Range * - ``rfr_2`` - RFR.2 - Optional[:ref:`CWE `] - optional - - Administrative Sex * - ``rfr_3`` - RFR.3 - Optional[:ref:`NR `] - optional - - Age Range * - ``rfr_4`` - RFR.4 - Optional[:ref:`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[:ref:`TX `] - optional - - Conditions .. _hl7-v2_8-RI: .. py:class:: hl7types.hl7.v2_8.datatypes.RI.RI :noindex: HL7 v2 RI data type. RI ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``ri_1`` - RI.1 - Optional[:ref:`CWE `] - optional - - Repeat Pattern * - ``ri_2`` - RI.2 - Optional[str] - optional - - Explicit Time Interval .. _hl7-v2_8-RMC: .. py:class:: hl7types.hl7.v2_8.datatypes.RMC.RMC :noindex: HL7 v2 RMC data type. RMC ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``rmc_1`` - RMC.1 - :ref:`CWE ` - required - - Room Type * - ``rmc_2`` - RMC.2 - Optional[:ref:`CWE `] - optional - - Amount Type * - ``rmc_4`` - RMC.4 - :ref:`MOP ` - required - - Money or Percentage .. _hl7-v2_8-RP: .. py:class:: hl7types.hl7.v2_8.datatypes.RP.RP :noindex: HL7 v2 RP data type. RP ~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``rp_1`` - RP.1 - Optional[str] - optional - - Pointer * - ``rp_2`` - RP.2 - Optional[:ref:`HD `] - optional - - Application ID * - ``rp_3`` - RP.3 - Optional[str] - optional - 11 - Type of Data * - ``rp_4`` - RP.4 - Optional[str] - optional - - Subtype .. _hl7-v2_8-RPT: .. py:class:: hl7types.hl7.v2_8.datatypes.RPT.RPT :noindex: HL7 v2 RPT data type. RPT ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``rpt_1`` - RPT.1 - :ref:`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[:ref:`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[:ref:`CWE `] - optional - - Event Offset Units * - ``rpt_11`` - RPT.11 - Optional[str] - optional - - General Timing Specification .. _hl7-v2_8-SAD: .. py:class:: hl7types.hl7.v2_8.datatypes.SAD.SAD :noindex: HL7 v2 SAD data type. SAD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-SCV: .. py:class:: hl7types.hl7.v2_8.datatypes.SCV.SCV :noindex: HL7 v2 SCV data type. SCV ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``scv_1`` - SCV.1 - Optional[:ref:`CWE `] - optional - - Parameter Class * - ``scv_2`` - SCV.2 - Optional[str] - optional - - Parameter Value .. _hl7-v2_8-SN: .. py:class:: hl7types.hl7.v2_8.datatypes.SN.SN :noindex: HL7 v2 SN data type. SN ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-SPD: .. py:class:: hl7types.hl7.v2_8.datatypes.SPD.SPD :noindex: HL7 v2 SPD data type. SPD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-SRT: .. py:class:: hl7types.hl7.v2_8.datatypes.SRT.SRT :noindex: HL7 v2 SRT data type. SRT ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-UVC: .. py:class:: hl7types.hl7.v2_8.datatypes.UVC.UVC :noindex: HL7 v2 UVC data type. UVC ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``uvc_1`` - UVC.1 - :ref:`CWE ` - required - - Value Code * - ``uvc_2`` - UVC.2 - Optional[:ref:`MO `] - optional - - Value Amount * - ``uvc_3`` - UVC.3 - Optional[str] - optional - - Non-Monetary Value Amount / Quantity * - ``uvc_4`` - UVC.4 - Optional[:ref:`CWE `] - optional - - Non-Monetary Value Amount / Units .. _hl7-v2_8-VH: .. py:class:: hl7types.hl7.v2_8.datatypes.VH.VH :noindex: HL7 v2 VH data type. VH ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-VID: .. py:class:: hl7types.hl7.v2_8.datatypes.VID.VID :noindex: HL7 v2 VID data type. VID ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``vid_1`` - VID.1 - str - required - 5 - Version ID * - ``vid_2`` - VID.2 - Optional[:ref:`CWE `] - optional - - Internationalization Code * - ``vid_3`` - VID.3 - Optional[:ref:`CWE `] - optional - - International Version ID .. _hl7-v2_8-VR: .. py:class:: hl7types.hl7.v2_8.datatypes.VR.VR :noindex: HL7 v2 VR data type. VR ~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-WVI: .. py:class:: hl7types.hl7.v2_8.datatypes.WVI.WVI :noindex: HL7 v2 WVI data type. WVI ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``wvi_1`` - WVI.1 - str - required - - Channel Number * - ``wvi_2`` - WVI.2 - Optional[str] - optional - - Channel Name .. _hl7-v2_8-WVS: .. py:class:: hl7types.hl7.v2_8.datatypes.WVS.WVS :noindex: HL7 v2 WVS data type. WVS ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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 .. _hl7-v2_8-XAD: .. py:class:: hl7types.hl7.v2_8.datatypes.XAD.XAD :noindex: HL7 v2 XAD data type. XAD ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``xad_1`` - XAD.1 - Optional[:ref:`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[:ref:`CWE `] - optional - - County/Parish Code * - ``xad_10`` - XAD.10 - Optional[:ref:`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[:ref:`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[:ref:`CWE `] - optional - - Protection Code * - ``xad_23`` - XAD.23 - Optional[:ref:`EI `] - optional - - Address Identifier .. _hl7-v2_8-XCN: .. py:class:: hl7types.hl7.v2_8.datatypes.XCN.XCN :noindex: HL7 v2 XCN data type. XCN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``xcn_1`` - XCN.1 - Optional[str] - optional - - Person Identifier * - ``xcn_2`` - XCN.2 - Optional[:ref:`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[:ref:`CWE `] - optional - - Source Table * - ``xcn_9`` - XCN.9 - Optional[:ref:`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[:ref:`HD `] - optional - - Assigning Facility * - ``xcn_15`` - XCN.15 - Optional[str] - optional - 1 - Name Representation Code * - ``xcn_16`` - XCN.16 - Optional[:ref:`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[:ref:`CWE `] - optional - - Assigning Jurisdiction * - ``xcn_23`` - XCN.23 - Optional[:ref:`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 .. _hl7-v2_8-XON: .. py:class:: hl7types.hl7.v2_8.datatypes.XON.XON :noindex: HL7 v2 XON data type. XON ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``xon_1`` - XON.1 - Optional[str] - optional - - Organization Name * - ``xon_2`` - XON.2 - Optional[:ref:`CWE `] - optional - - Organization Name Type Code * - ``xon_6`` - XON.6 - Optional[:ref:`HD `] - optional - - Assigning Authority * - ``xon_7`` - XON.7 - Optional[str] - optional - 5 - Identifier Type Code * - ``xon_8`` - XON.8 - Optional[:ref:`HD `] - optional - - Assigning Facility * - ``xon_9`` - XON.9 - Optional[str] - optional - 1 - Name Representation Code * - ``xon_10`` - XON.10 - Optional[str] - optional - - Organization Identifier .. _hl7-v2_8-XPN: .. py:class:: hl7types.hl7.v2_8.datatypes.XPN.XPN :noindex: HL7 v2 XPN data type. XPN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - Field - HL7 - Type - Required - Max Length - Description * - ``xpn_1`` - XPN.1 - Optional[:ref:`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[:ref:`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 .. _hl7-v2_8-XTN: .. py:class:: hl7types.hl7.v2_8.datatypes.XTN.XTN :noindex: HL7 v2 XTN data type. XTN ~~~ .. list-table:: :header-rows: 1 :widths: auto * - 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[:ref:`CWE `] - optional - - Expiration Reason * - ``xtn_16`` - XTN.16 - Optional[:ref:`CWE `] - optional - - Protection Code * - ``xtn_17`` - XTN.17 - Optional[:ref:`EI `] - optional - - Shared Telecommunication Identifier * - ``xtn_18`` - XTN.18 - Optional[str] - optional - - Preference Order