In HL7 every segment element (and even every component of every element) is assigned an HL7 data type. Each datatype is made up of one or more components, with each of those also having a datatype. Many of the data types (the vast majority of them in fact) are compound types that have more than one component. Refer to the HL7 rules for Data Types for a more in-depth explanation of how they are defined.
This window allows you to add new data types or add/edit/modify the components that make up a particular data type.
The HL7 Data Types Window
Type: AD - Address (8 components) Category: Demographics Instructions: 2.8.1 <street address (ST)> ^ < other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other geographic designation (ST)> Component 1 [ST] Street Address Component 2 [ST] Other designation Component 3 [ST] City Component 4 [ST] State or province Component 5 [ST] Zip or postal code Component 6 [ID] Country ID Component 7 [ID] Address type ID Component 8 [ST] Other geographic designation
Type: CD - Channel definition (8 components) Category: Waveform Instructions: 2.8.2 For waveform data only, see Chapter 7, Section 7.15.3. <channel identifier (*)> ^ <channel number (NM)> & <channel name (ST)> ^ <electrode names (*) > ^ <channel sensitivity/units (*) > ^ <calibration parameters (*)> ^ <sampling frequency (NM)> ^ <m Component 1 [ST] Channel identifier Component 2 [NM] channel number Component 3 [ST] channel name Component 4 [ST] electrode names Component 5 [ST] channel sensitivity/units Component 6 [ST] calibration parameters Component 7 [NM] sampling frequency Component 8 [ST] miscellaneous
Type: CE - Coded element (6 components) Category: Code Values Instructions: 2.8.3 <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)> Component 1 [ST] identifier Component 2 [ST] text Component 3 [ST] name of coding system Component 4 [ST] alternate identifier Component 5 [ST] alternate text Component 6 [ST] name of alternate coding system
Type: CF - Coded element with formatted values (6 components) Category: Code Values Instructions: 2.8.4 <identifier (ID)> ^ <formatted text (FT)> ^ <name of coding system (ST)> ^ <alternate identifier (ID)> ^ <alternate formatted text (FT)> ^ <name of alternate coding system (ST)> Component 1 [ID] identifier Component 2 [FT] formatted text Component 3 [ST] name of coding system Component 4 [ID] alternate identifier Component 5 [FT] alternate formatted text Component 6 [ST] name of alternate coding system
Type: CK - Composite ID with check digit (4 components) Category: Code Values Instructions: 2.8.5 <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> Component 1 [NM] ID number Component 2 [NM] check digit Component 3 [ID] code identifying the check digit scheme employed Component 4 [HD] assigning authority
Type: CM - Composite (4 components) Category: Generic Instructions: 2.8.6 No new CM's are allowed after HL7 Version 2.2. Hence there are no new CM's in Version 2.3. Component 1 [ST] Component 1 Component 2 [ST] Component 2 Component 3 [ST] Component 3 Component 4 [ST] Component 4
Type: CN - Composite ID number and name (9 components) Category: Code Values Instructions: 2.8.7 <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> Component 1 [ST] ID Number Component 2 [ST] Family name (Last Name) Component 3 [ST] Given Name (First Name) Component 4 [ST] middle initial or name Component 5 [ST] suffix (jr, sr etc) Component 6 [ST] prefix (Dr, Mr, Mrs etc) Component 7 [ST] Degree (MD, PHD etc) Component 8 [IS] Source Table Component 9 [HD] Assigning authority
Type: CNE - Coded with no exceptions (9 components) Category: Code Values Instructions: 2.8.8 <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)> ^ <coding system version ID (ST)> ^ alternate coding system version ID (ST)> ^ <original tex Component 1 [ST] identifier Component 2 [ST] text Component 3 [ST] name of coding system Component 4 [ST] alternate identifier Component 5 [ST] alternate text Component 6 [ST] name of alternate coding system Component 7 [ST] coding system version id Component 8 [ST] alternate coding system version id Component 9 [ST] original text
Type: CP - Composite price (6 components) Category: Price Data Instructions: 2.8.9 In Version 2.3, replaces the MO data type. <price (MO)> ^ <price type (ID)> ^ <from value (NM)> ^ <to value (NM)> ^ <range units (CE)> ^ <range type (ID)> Component 1 [MO] price Component 2 [ID] price type Component 3 [NM] from value Component 4 [NM] to value Component 5 [CE] range units Component 6 [ID] range type
Type: CQ - Composite quantity with units (2 components) Category: Numerical Instructions: 2.8.10 <quantity (NM)> ^ <units (CE)> Component 1 [NM] quantity Component 2 [CE] units
Type: CWE - Coded with exceptions (9 components) Category: Code Values Instructions: 2.8.11 <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)> ^ <coding system version ID (ST)> ^ alternate coding system version ID (ST)> ^ <original t Component 1 [ST] identifier Component 2 [ST] text Component 3 [ST] name of coding system Component 4 [ST] alternate identifier Component 5 [ST] alternate text Component 6 [ST] alternate coding system Component 7 [ST] coding system version ID Component 8 [ST] alternate coding system version ID Component 9 [ST] original text
Type: CX - Extended composite ID with check digit (6 components) Category: Code Values Instructions: 2.8.12 <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> ^ <identifier type code (IS)> ^ < assigning facility (HD) Component 1 [ST] ID Component 2 [ST] check digit Component 3 [ID] code identifying the check digit scheme employed Component 4 [HD] assigning authority Component 5 [IS] identifyer type code Component 6 [HD] assigning facility
Type: DLN - Driver's license number (3 components) Category: Master Files Instructions: 2.8.13 <license number (ST)> ^ <issuing state, province, country (IS)> ^ <expiration date (DT) Component 1 [ST] license number Component 2 [IS] issuing state, province, country Component 3 [DT] expiration date
Type: DR - Date/time range (2 components) Category: Time Series Instructions: 2.8.14 Scheduling Chapter Only:<range start date/time (TS)> ^ <range end date/time (TS)> Component 1 [TS] range start date/time Component 2 [TS] range end date/time
Type: DT - Date (1 component Category: Date/Time Instructions: 2.8.15 YYYY[MM[DD]] Component 1 [ST] date
Type: ED - Encapsulated data (5 components) Category: Waveform Instructions: 2.8.16 Supports ASCII MIME-encoding of binary data. <source application (HD) > ^ <type of data (ID)> ^ <data subtype (ID)> ^ <encoding (ID)> ^ <data (ST)> Component 1 [HD] source application Component 2 [ID] type of data Component 3 [ID] data subtype Component 4 [ID] encoding Component 5 [ST] data
Type: EI - Entity identifier (4 components) Category: Identifier Instructions: 2.8.17 <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> Component 1 [ST] entity identifier Component 2 [IS] namespace id Component 3 [ST] universal id Component 4 [ID] universal ID type
Type: FC - Financial class (2 components) Category: Patient Administration Instructions: 2.8.18 <financial class (ID)> ^ <effective date (TS)> Component 1 [ID] financial class Component 2 [TS] effective date
Type: FT - Formatted text (1 component Category: Alphanumeric Instructions: 2.8.19 Component 1 [ST] Formatted text
Type: HD - Hierarchic designator (3 components) Category: Identifier Instructions: 2.8.20 <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>Used only as part of EI and other data types. Component 1 [IS] namespace id Component 2 [ST] universal ID Component 3 [ID] universal ID type
Type: ID - Coded values for HL7 tables (1 component Category: Identifier Instructions: 2.8.21 Component 1 [ST] Coded value for HL7 Tables
Type: IS - Coded value for user-defined tables (1 component Category: Identifier Instructions: 2.8.22 Component 1 [ST] Code value for user-defined table
Type: JCC - Job code/class (2 components) Category: Master Files Instructions: 2.8.23 <job code (IS)> ^ <job class (IS)> Component 1 [IS] job code Component 2 [IS] job class
Type: MA - Multiplexed array (1 component Category: Waveform Instructions: 2.8.24 For waveform data only, see Chapter 7, Section 7.15.2. <sample 1 from channel 1 (NM)> ^ <sample 1 from channel 2 (NM)> ^ <sample 1 from channel 3 (NM)> ...~<sample 2 from channel 1 (NM)> ^ <sample 2 from channel 2 (NM)> ^ <sample 2 from channel Component 1 [ST] Not supported
Type: MO - Money (2 components) Category: Numerical Instructions: 2.8.25 <quantity (NM)> ^ <denomination (ID)> Component 1 [NM] quantity Component 2 [ID] denomination
Type: NA - Numeric array (4 components) Category: Waveform Instructions: 2.8.26 For waveform data only, see Chapter 7, Section 7.15.1. <value1 (NM)> ^ <value2 (NM)> ^ <value3 (NM)> ^ <value4 (NM)> ^ ... Component 1 [NM] value 1 Component 2 [NM] value 2 Component 3 [NM] value 3 Component 4 [NM] value 4
Type: NM - Numeric (1 component Category: Numerical Instructions: 2.8.27 Component 1 [ST] Numeric data
Type: PL - Person location (9 components) Category: Identifier Instructions: 2.8.28 <point of care (IS )> ^ <room (IS )> ^ <bed (IS)> ^ <facility (HD)> ^ < location status (IS )> ^ <person location type (IS)> ^ <building (IS )> ^ <floor (IS )> ^ <location description (ST)> Component 1 [IS] point of care Component 2 [IS] room Component 3 [IS] bed Component 4 [IS] facility Component 5 [IS] location status Component 6 [IS] person location type Component 7 [IS] building Component 8 [IS] floor Component 9 [ST] Location description
Type: PN - Person name (6 components) Category: Demographics Instructions: 2.8.30 <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> Component 1 [ST] family name (last name) Component 2 [ST] given name (first name) Component 3 [ST] middle initial or name Component 4 [ST] suffix (jr, sr etc) Component 5 [ST] prefix (Dr, Mr, Mrs etc) Component 6 [ST] degree (MD, PHD etc)
Type: PPN - Performing person time stamp (8 components) Category: Medical Records Instructions: 2.8.29 <ID number (ST)> ^ <family name (ST)> ^ & <last name prefix (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authori Component 1 [ST] ID Number Component 2 [ST] Family name (last name) Component 3 [ST] given name (first name) Component 4 [ST] middle initial or name Component 5 [ST] suffix (jr, sr etc) Component 6 [ST] prefix (Dr, Mr, Mrs etc) Component 7 [IS] source table Component 8 [ST] assigning authority
Type: PT - Processing type (2 components) Category: Identifier Instructions: 2.8.31 <processing ID (ID)> ^ <processing mode (ID)> Component 1 [ID] processing ID Component 2 [ID] processing mode
Type: QIP - Query input parameter list (2 components) Category: Extended Queries Instructions: 2.8.32 <field name (ST) > ^ <value1 (ST) & value2 (ST) & value3 (ST) ...> Component 1 [ST] field name Component 2 [ST] field value
Type: QSC - Query selection criteria (4 components) Category: Extended Queries Instructions: 2.8.33 <name of field (ST)> ^ <relational operator (ID)> ^ <value (ST)> ^ <relational conjunction (ID)> Component 1 [ST] value Component 2 [ID] relational conjunction Component 3 [ST] name of field Component 4 [ID] relational operator
Type: RCD - Row column definition (3 components) Category: Extended Queries Instructions: 2.8.34 <HL7 item number (ST)> ^ <HL7 data type (ST)> ^ <maximum column width (NM)> Component 1 [ST] HL7 item number Component 2 [ST] HL7 data type Component 3 [NM] maximum column width
Type: RI - Repeat interval (2 components) Category: Time Series Instructions: 2.8.35 Scheduling Chapter Only:<repeat pattern (IS)> ^ <explicit time interval (ST)> Component 1 [IS] repeat pattern Component 2 [ST] explicit time interval
Type: RP - Reference pointer (4 components) Category: Identifier Instructions: 2.8.36 <pointer (ST) > ^ < application ID (HD)> ^ <type of data (ID)> ^ <subtype (ID)> Component 1 [ST] pointer Component 2 [HD] application ID Component 3 [ID] type of data Component 4 [ID] subtype
Type: SCV - Scheduling class value pair (2 components) Category: Time Series Instructions: 2.8.37 Scheduling Chapter Only:<parameter class (IS)> ^ <parameter value (ST)> Component 1 [IS] parameter class Component 2 [ST] parameter value
Type: SI - Sequence ID (1 component Category: Numerical Instructions: 2.8.38 Component 1 [ST] Sequence ID
Type: SN - Structured numeric (4 components) Category: Numerical Instructions: 2.8.39 <comparator (ST)> ^ <num1 (NM)> ^ <separator/suffix> ^ <num2 (NM)> Component 1 [ST] comparator Component 2 [NM] num1 Component 3 [ST] separator / suffix Component 4 [NM] num2
Type: ST - String (1 component Category: Alphanumeric Instructions: 2.8.40 Component 1 [ST] string data
Type: TM - Time (1 component Category: Date/Time Instructions: 2.8.41 HH[MM[SS[.S[S[S[S]]]]]][+/-ZZZZ] Component 1 [ST] time data
Type: TN - Telephone number (1 component Category: Demographics Instructions: 2.8.42 [NN] [(999)]999-9999[X99999][B99999][C any text] Component 1 [ST] Telephone number
Type: TQ - Timing/quantity (9 components) Category: Time Series Instructions: 2.8.43 For timing/quantity specifications for orders, see Chapter 4, Section 4.4. <quantity (CQ)> ^ <interval (*)> ^ <duration (*)> ^ <start date/time (TS)> ^ <end date/time (TS)> ^ <priority (ST)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^ Component 1 [CQ] quantity Component 2 [ST] interval Component 3 [ST] duration Component 4 [TS] start date/time Component 5 [TS] end date/time Component 6 [ST] priority Component 7 [ST] condition Component 8 [TX] text Component 9 [ID] conjunction
Type: TS - Time stamp (2 components) Category: Date/Time Instructions: 2.8.44 YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] ^ <degree of precision> Component 1 [ST] Time stamp data Component 2 [ST] degree of precision (optional)
Type: TX - Text data (1 component Category: Alphanumeric Instructions: 2.8.45 Component 1 [ST] Text data
Type: VH - Visiting hours (4 components) Category: Master Files Instructions: 2.8.46 <start day range (ID)> ^ <end day range (ID)> ^ <start hour range (TM)> ^ <end hour range (TM)> Component 1 [ID] start day range Component 2 [ID] end day range Component 3 [TM] start hour range Component 4 [TM] end hour range
Type: VID - Version identifier (3 components) Category: Identifier Instructions: <version ID (ID)> ^ <internationalization code (CE)> ^ <international version ID (CE) Component 1 [ID] version id Component 2 [CE] internationalization code Component 3 [CE] international version ID
Type: XAD - Extended address (9 components) Category: Demographics Instructions: 2.8.48 replaces the AD data type. <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ < address type (ID)> ^ <other geographic designation (ST)> ^ <count Component 1 [ST] street address Component 2 [ST] other designation Component 3 [ST] city Component 4 [ST] state or province Component 5 [ST] zip or postal code Component 6 [ID] country Component 7 [ID] address type Component 8 [ST] other geographic designation Component 9 [ST] country ??
Type: XCN - Extended composite ID number and name (7 components) Category: Code Values Instructions: 2.8.49 use instead of the CN data type. <ID number (ST)> ^ <family name (ST)> & <last_name_prefix (ST) ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) ( Component 1 [ST] ID Number Component 2 [ST] family name (last name) Component 3 [ST] given name (first name) Component 4 [ST] middle initial or name Component 5 [ST] suffix Component 6 [ST] prefix Component 7 [ST] degree
Type: XON - composite name/ID for organizations (8 components) Category: Demographics Instructions: 2.8.50 <organization name (ST)> ^ <organization name type code (IS)> ^ <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD Component 1 [ST] organization name Component 2 [IS] organization name type code Component 3 [NM] ID number Component 4 [NM] Check digit Component 5 [ID] code identifying check digit scheme used Component 6 [HD] assigning authority Component 7 [IS] identifier type code Component 8 [HD] assigning facility ID
Type: XPN - Extended person name (7 components) Category: Demographics Instructions: 2.8.51 replaces the PN data type. <family name (ST)> ^ <given name (ST)> & <last_name_prefix (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (IST)> ^ <name type code Component 1 [ST] family name (last name) Component 2 [ST] given name (first name) Component 3 [ST] middle initial or name Component 4 [ST] suffix (jr, sr, etc) Component 5 [ST] prefix (Mr, Mrs, Dr etc) Component 6 [ST] degree (MD, PHD etc) Component 7 [ID] name type code
Type: XTN - Extended telecommunications number (8 components) Category: Demographics Instructions: 2.8.52replaces the TN data type. [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ < Component 1 [ID] Telecommunications use code Component 2 [ID] Telecommunications equipment type Component 3 [ST] email address Component 4 [NM] country code Component 5 [NM] area/city code Component 6 [NM] phone number Component 7 [NM] extension Component 8 [ST] any text
|