2 . Control (continued)

2.A DATA TYPES

The data types in this section are listed in alphabetical order. Refer to HL7 Table 0440 - Data Types in Section 2.15, "Data Types" for valid values and associated detail.

Beginning HL7 Version 2.5 maximum lengths are being assigned to data types.

The following rules apply to the setting of data type length:

1. The upper bound maximum length of a data type is the sum of:

1. The combined length of all components (including those not required) that are not mutually exclusive.

2. The combined length of the largest set of mutually exclusive components.

3. The combined length of message delimiters that are required to construct the field, based on Section 2.6-Message construction Rules.

1. The lower bound maximum length of a data type is the sum of:

1. The combined length of all required components that are not mutually exclusive.

2. The combined length of the largest set of mutually exclusive required components.

3. The combined length of message delimiters that are required to construct the field, based on Section 2.6-Message construction Rules.

The data type examples in this Standard are given using the standard HL7 encoding rules, with the delimiter values from Figure 2-1 of Section 2.5.4, "Message Delimiters." Although only one set of encoding rules is defined as a standard in HL7 Version 2.4, other encoding rules are possible (but since they are non-standard, they may only be used by a site-specific agreement).

In certain data type definitions, square brackets, "[" and "]", are used to specify optional parts of a data type (or of a data type component or subcomponent).

2.A.1 AD - address

HL7 Component Table - AD - Address

Definition: This data type specifies the address of a person, place or organization.

Maximum Length: 415

Note: Used only in the LA1 data type. Retained for backward compatibility as of v2.6. Replaced elsewhere by the XAD data type as of v 2.3.

Example:

|10 ASH LN^#3^LIMA^OH^48132|

2.A.1.1 Street Address (ST)

Definition: This component specifies the street or mailing address of a person or institution. When referencing an institution, this first component is used to specify the institution name. When used in connection with a person, this component specifies the first line of the address.

2.A.1.2 Other Designation (ST)

Definition: This component specifies the second line of address. In general, it qualifies address. Examples: Suite 555 or Fourth Floor. When referencing an institution, this component specifies the street address.

2.A.1.3 City (ST)

Definition: This component specifies the city, district or place where the addressee is located depending upon the national convention for formatting addresses for postal usage.

2.A.1.4 State or Province (ST)

Definition: This component specifies the state or province where the addressee is located. State or province should be represented by the official postal service codes for that country.

2.A.1.5 Zip or Postal Code (ST)

Definition: This component specifies the zip or postal code where the addressee is located. Zip or postal codes should be represented by the official codes for that country. In the US, the zip code takes the form 99999[-9999], while the Canadian postal code takes the form A9A9A9 and the Australian Postcode takes the form 9999.

2.A.1.6 Country (ID)

Definition: This component specifies the country where the addressee is located. HL7 specifies that the 3-character (alphabetic) form of ISO 3166 be used for the country code. Refer to HL7 Table 0399 - Country Code in section 2.14.9.17 for valid values.

2.A.1.7 Address Type (ID)

Definition: This component specifies the kind or type of address. Refer to HL7 Table 0190 - Address Type for valid values.

2.A.1.8 Other geographic designation (ST)

Definition: This component specifies any other geographic designation that may be necessary. It includes county, bioregion, SMSA, etc.

2.A.2 AUI - authorization information

HL7 Component Table - AUI - Authorization Information

Definition: This data type specifies the identifier or code for an insurance authorization instance and its associated detail.

Maximum Length: 239

Note: Replaces the CM data type used in sections 6.5.6.14 IN1-14, as of v 2.5.

2.A.2.1 Authorization Number (ST)

Definition: Identifier assigned to the authorization.

2.A.2.2 Date (DT)

Definition: Date of authorization.

2.A.2.3 Source (ST)

Definition: Source of authorization.

2.A.3 CCD - charge code and date

HL7 Component Table - CCD - Charge Code and Date

Definition: Specifies whether a charge action is based on an invocation event or is time-based.

Maximum Length: 26

Note: Replaces the CM data type used in section 4.5.2.1 BLG-1, as of v 2.5.

2.A.3.1 Invocation Event (ID)

Definition: Specifies the code for the event precipitating/triggering the charge activity. Refer to HL7 Table 0100 - Invocation event for valid values.

HL7 Table 0100 - Invocation event

Definition: The second component is used to express the exact time to charge for the ordered service; it is used only when the CCD.1 value is T. When used, it is expressed as a DTM data type.

2.A.4 CCP - channel calibration parameters

HL7 Component Table - CCP - Channel Calibration Parameters

Definition: This data type identifies the corrections to channel sensitivity, the baseline, and the channel time skew when transmitting waveform results.

Maximum Length: 20

Note: Replaces the CM data type used in 7.14.1.5 OBX-5.3 where OBX-5 Observation value (*) is data type CD as of v 2.5.

2.A.4.1 Channel Calibration Sensitivity Correction Factor (NM)

Definition: This component defines a correction factor for channel sensitivity, which may be derived from the last calibration procedure performed. The actual channel sensitivity is the nominal channel sensitivity given in the previous component multiplied by the unitless correction factor.

2.A.4.2 Channel Calibration Baseline (NM)

Definition: This component defines the actual channel baseline (the data value which corresponds to a nominal input signal of zero). The actual baseline may differ from the ideal because of a dc offset in the amplifier connected to the ADC. The actual baseline values for all channels (which need not be integers) may be determined at the time of calibration as the average digitized values obtained when a zero input signal is connected to each channel.

2.A.4.3 Channel Calibration Time Skew (NM)

Definition: This component defines the time difference between the nominal sampling (digitization) time (which would be the same for all channels) and the actual sampling time of the channel, in seconds (or fractions thereof). This value will differ from zero when all channels in the montage are not sampled simultaneously, as occurs in systems, which sample successive channels at regular time intervals. This value may be determined from a calibration procedure in which an identical time-varying signal is applied to all channels and interchannel time differences are estimated, or more commonly it may be taken from the manufacturer's specifications for the digitizing system used. For example, for a system which samples successive channels at regular time intervals t, the time skew of channel number n would be (n-1)t. The actual time of sampling (digitization) of sample number m of channel number n in such a system would be R + (m-1)/f + (n-1)t, where R is the reference time at the start of the epoch and f is the channel sampling frequency (t < 1/f).

2.A.5 CD - channel definition

HL7 Component Table - CD - Channel Definition

Definition: This data type is used for labeling of digital waveform data. It defines a recording channel, which is associated with one of the values in each time sample of waveform data. Each channel has a number (which generally defines its position in a multichannel display) and an optional name or label (also used in displays). One or two named waveform sources may also be associated with a channel (providing for the use of differential amplifiers with two inputs). The other components of the channel definition data type are optional. The individual components are defined as follows:

Maximum Length: 581

2.A.5.1 Channel Identifier (WVI)

Definition: This component specifies the number and name of the recording channel where waveform data is transmitted.

2.A.5.2 Waveform Source (WVS)

Definition: This component identifies the source of the waveform connected to the channel. Two names may be specified if it is necessary to individually identify the two inputs for a waveform. Only one name need be specified if the channel is connected to a single input. For example, in EKG recordings typically only one name is used (such as I or II); in electroencephalography, two names are typically used, one for each input of the differential amplifier (such as F3 and C3).

2.A.5.3 Channel Sensitivity and Units (CSU)

Definition: This component defines the channel sensitivity (gain) and the units in which it is measured.

2.A.5.4 Channel Calibration Parameters (CCP)

Definition: This component identifies the corrections to channel sensitivity, the baseline, and the channel time skew.

2.A.5.5 Channel Sampling Frequency (NM)

Definition: This component defines the sampling frequency in hertz of the channel, that is, the reciprocal of the time in seconds between successive samples. Note that this is the frequency of transmitted data, which may or may not be the actual frequency at which the data was acquired by an analog-to-digital converter or other digital data source (i.e. the data transmitted may be subsampled, or interpolated, from the originally acquired data.)

2.A.5.6 Minimum and Maximum Data Values (NR)

Definition: This component defines the minimum and maximum data values which can occur in this channel in the digital waveform data, that is, the range of the ADC, and also specifies whether or not non-integral data values may occur in this channel in the waveform data. If the minimum and maximum values are both integers (or not present), only integral data values may be used in this channel. If either the minimum or the maximum value contains a decimal point, then non-integral as well as integral data values may be used in this channel. For an n-bit signed ADC, the nominal baseline B = 0, and the minimum (L) and maximum (H) values may be calculated as follows:

L = -2n-1

H = 2n-1 - 1

For an unsigned n-bit ADC, the minimum value L = 0, and the nominal baseline value (B) and maximum value (H) may be calculated from the formulas,

B = 2n-1

H = 2n - 1

The actual signal amplitude A (for differentially amplified potential measurements, the potential at electrode number one minus that at electrode number two) may be calculated from the value D (range L to H) in the waveform data using the actual baseline value B and the nominal sensitivity S and actual sensitivity correction factor C by the formula,

A = SC(D-B)

2.A.6 CE - coded element

HL7 Component Table - CE - Coded Element

Attention: The CE data type has been replaced by the CWE and CNE data types and the detail was withdrawn and removed from the standard as of v 2.6.

2.A.7 CF - coded element with formatted values

HL7 Component Table - CF - Coded Element with Formatted Values

Note: The Vocabulary TC is the steward of the CF data type.

Definition: This data type transmits codes and the formatted text associated with the code. This data type can be used to transmit for the first time the formatted text for the canned text portion of a report, for example, a standard radiological description for a normal chest X-ray. The receiving system can store this information and in subsequent messages only the identifier need be sent. Another potential use of this data type is transmitting master file records that contain formatted text. This data type has six components as follows:

Maximum Length: 65536

The components, primary and alternate, are defined exactly as in the CE data type with the exception of the second and fifth components, which are of the formatted text data type.

Example:

OBX||CF|71020^CXR^99CPMC||79989^\H\Description:\N\\.sp\\ti+4\Heart is not enlarged. There is no evidence of pneumonia, effusion, pneumothorax or any masses. \.sp+3\\H\Impression:\N\\.sp\\.ti+4\Negative chest.^99CPMC

2.A.7.1 Identifier (ST)

Definition: Sequence of characters (the code) that uniquely identifies the item being referenced by the <text>. Different coding schemes will have different elements here.

2.A.7.2 Formatted Text (FT)

Definition: Name or description of the item in question with the addition of embedded formatting instructions.

2.A.7.3 Name of Coding System (ID)

Definition: Contains the name of the coding system employed.

Refer to HL7 Table 0396 - Coding System in section 2.16.4, "Coding System Table" for valid values.

2.A.7.4 Alternate Identifier (ST)

Definition: Alternate sequence of characters (the code) that uniquely identifies the item being referenced by the <text>. This identifier is the equivalent of component one.

2.A.7.5 Alternate Formatted Text (FT)

Definition: Name or description of the alternate identifier in question with the addition of embedded formatting instructions.

2.A.7.6 Name of Alternate Coding System (ID)

Definition: Contains the name of the coding system employed for the alternate identifier.

Refer to HL7 Table 0396 - Coding System in section 2.16.4, "Coding System Table" for valid values.

2.A.8 CNE - coded with no exceptions

HL7 Component Table - CNE - Coded with No Exceptions

Note: The Vocabulary TC is the steward of the CNE data type.

Definition: Specifies a coded element and its associated detail. The CNE data type is used when a required or mandatory coded field is needed. The specified HL7 table or imported or externally defined coding system must be used and may not be extended with local values. Text may not replace the code. A CNE field must have an HL7 defined or external table associated with it. A CNE field may be context sensitive such that a choice of explicit coding systems might be designated. This allows for realm and other types of specificity. Every effort will be made to enumerate the valid coding system(s) to be specified in the 3rd component, however, the standards body realizes that this is impossible to fully enumerate.

Note: The presence of two sets of equivalent codes in this data type is semantically different from a repetition of a CNE-type field. With repetition, several distinct codes (with distinct meanings) may be transmitted.

Maximum Length: 705

Example 1: The drug must be coded and must be taken from the specified coding system. The coding system is an external coding system. Example is derived from FT1-26.

|0006-0106-58^Prinivil 10mg oral tablet^NDC|

Example 2: Consent mode must be coded and must be taken from the specified coding system. The coding system is an HL7 code table. Example is taken from CON-10.

|V^Verbal^HL70497^^^^2.5|

2.A.8.1 Identifier (ST)

Definition: The first component contains the sequence of characters (the code) that uniquely identifies the item being referenced by the CNE.2. Different coding schemes will have different elements here.

Usage Note: The identifier is required and must be a valid code.

2.A.8.2 Text (ST)

Definition: The second component contains the descriptive or textual name of the identifier, e.g., myocardial infarction or X-ray impression. This is the corresponding text assigned by the coding system to the identifier.

Usage Note: Text description of code is optional but its use should be encouraged since it makes messages easier to review for accuracy, especially during interface testing and debugging.

2.A.8.3 Name of Coding System (ID)

Definition: The third component contains the code for the name of the coding system from which the value in CNE.1 is obtained. Refer to HL7 Table 0396 - Coding Systems in section 2.16.4, "Coding System Table" for valid values. Each coding system is assigned a unique identifier.

The combination of the identifier and name of coding system represent a unique concept for a data item.

Some organizations that publish code sets author more than one. The coding system, then, to be unique, is a concatenation of the name of the coding authority organization and the name of its code set or table. When an HL7 table is used for a CNE data type, the name of coding system component is defined as HL7nnnn where nnnn is the HL7 table number. Similarly, ISO tables will be named ISOnnnn, where nnnn is the ISO table number.

Usage Note: Best practice would recommend that this component always be populated. However, if the field narrative explicitly states "Refer to HL7 Table nnnn for valid values", and, if the sending and receiving systems are HL7 compliant, the coding system would be known from the standard. This would be similar to a field with an ID data type, except that there is a second triplet in which to express an alternate code.

2.A.8.4 Alternate Identifier (ST)

Analogous to "Identifier" in component 1.

Usage Notes: The Alternate Identifier is used to represent the local or user seen code as described. If present, it obeys the same rules of use and interpretation as described for component 1. If both are present, the identifiers in component 4 and component 1 should have exactly the same meaning, i.e., they should be exact synonyms.

2.A.8.5 Alternate Text (ST)

Definition: The descriptive or textual name of the alternate identifier. Analogous to "Text" in component 2.

Usage Notes: If present, component 5 obeys the same rules of use and interpretation as described for component 2.

2.A.8.6 Name of Alternate Coding System (ID)

Definition: Identifies the coding scheme being used in the alternate identifier component. Analogous to "Name of Coding System" in component 3. Refer to HL7 Table 0396 - Coding Systems in section 2.16.4, "Coding System Table" for valid values.

Usage Notes: If present, components 6 obeys the same rules of use and interpretation as described for component 3.

2.A.8.7 Coding System Version ID (ST)

Definition: the version ID for the coding system identified by component 3. It belongs conceptually to components 1-3 and appears here only for reasons of backward compatibility.

Usage Note: If the coding system is any system other than an "HL7 coding system," version ID must be valued with an actual version ID. If the coding system is "HL7 coding system," version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. Text description of code is optional but its use should be encouraged since it makes messages easier to review for accuracy, especially during interface testing and debugging.

2.A.8.8 Alternate Coding System Version ID (ST)

Definition: the version ID for the coding system identified by component 6. It belongs conceptually to the group of Alternate components (see note 2.A.1) and appears here only for reasons of backward compatibility.

Usage Notes: If present, component 8 obeys the same rules of use and interpretation as described for component 7.

2.A.8.9 Original Text (ST)

The original text that was available to an automated process or a human before a specific code was assigned.

2.A.9 CNN - composite ID number and name simplified

HL7 Component Table - CNN - Composite ID Number and Name Simplified

Note: Restores the original data type CN as was initially implementable in the CM used in sections 4.5.3.32 and 7.4.1.32 - (OBR-32), 4.5.3.33 and 7.4.1.33 - ( OBR-33), 4.5.3.34 and 7.4.1.34 - ( OBR-34), 4.5.3.35 and 7.4.1.35 - (OBR-35). Components 7 and 8, however, have been promoted to data type IS to be consistent with current practice without violating backward compatibility.

Maximum Length: 406

2.A.9.1 ID Number (ST)

Coded ID according to a user-defined table. If the first component is present, either component 8 or 9, or both 10 and 11, must be valued.

2.A.9.2 Family Name (ST)

This component contains the person's family name in a string format.

2.A.9.3 Given Name (ST)

Used to specify a first name.

2.A.9.4 Second and Further Given Names or Initials Thereof (ST)

2.A.9.5 Suffix (ST)

Used to specify a name suffix (e.g., Jr. or III).

2.A.9.6 Prefix (ST)

Used to specify a name prefix (e.g., Dr.).

2.A.9.7 Degree (IS)

Used to specify an educational degree (e.g., MD). Refer to User-defined Table 0360 - Degree/license/certificate for suggested values.

User-defined Table 0360 - Degree/license/certificate

Refer to User-defined Table 0297 - CN ID source for suggested values. Used to delineate the first component. If component 1 is valued, either component 8, or 9, or both 10 and 11, must be valued.

User-defined Table 0297 - CN ID source

See section, 2.A.14.4, "Assigning Authority (HD)" for definition. Refer to User-defined Table 0363 - Assigning authority for suggested values. Assigning Authority is normally expressed as an HD data type, but has been flattened to 3 components here (CNN.9, CNN.10 and CNN.11) in this data type so that it may be fully expressed. Also note that if additional components are added to the HD data type in the future, adjustment will need to be made accordingly to this data type.

If component 1 is valued, either component 8, or 9, or both 10 and 11, must be valued.

2.A.9.10 Assigning Authority - Universal ID (ST)

See section, 2.A.14.4, "Assigning Authority (HD)" for definition.

If CNN.11 is valued, this component must be valued. If component 1 is valued, either component 8, or 9, or both 10 and 11, must be valued.

2.A.9.11 Assigning Authority - Universal ID Type (ID)

See section, 2.A.14.4, "Assigning Authority (HD)" for definition. If this component is a known UID refer to HL7 Table 0301 - Universal ID type for valid values

If CNN.10 is valued, this component must be valued. If component 1 is valued, either component 8, or 9, or both 10 and 11, must be valued.

2.A.10 CP - composite price

HL7 Component Table - CP - Composite Price

Note: This data type is often used to define a repeating field within a given segment.

Maximum Length: 765

Example:

|100.00&USD^UP^0^9^min^P~50.00&USD^UP^10^59^min^P~10.00&USD^UP^60^999^P~50.00&USD^AP~200.00&USD^PF

~80.00&USD^DC|

2.A.10.1 Price (MO)

The only required component; usually containing a decimal point. Note that each component of the MO data type (Section 2.A.41, "MO - money") is a subcomponent here.

2.A.10.2 Price Type (ID)

A coded value, data type ID. Refer to HL7 Table 0205 - Price type for valid values.

HL7 Table 0205 - Price type

Each is a NM data type; together they specify the "range". The range can be defined as either time or quantity. For example, the range can indicate that the first 10 minutes of the procedure has one price. Another repetition of the data type can use the range to specify that the following 10 to 60 minutes of the procedure is charged at another price per; a final repetition can specify that the final 60 to N minutes of the procedure at a third price.

Note that, if the <price type> component is TP, both <from value> and <to value> may be null.

2.A.10.4 To Value (NM)

See <from value> above.

2.A.10.5 Range Units (CWE)

A coded value, data type CWE, defined by the standard table of units for either time or quantity (see for example, the tables in Section 7.1.4, "Coding schemes"). This describes the units associated with the range, e.g., seconds, minutes, hours, days, quantity (i.e., count); it is required if <from value> and <to value> are present.

2.A.10.6 Range Type (ID)

Refer to HL7 Table 0298 - CP range type for valid values.

HL7 Table 0298 - CP range type

HL7 Component Table - CQ -Composite Quantity with Units

Maximum Length: 722

Note: CQ cannot be legally expressed when embedded within another data type. Its use is constrained to a segment field.

Examples:

|123.7^kg| kilograms is an ISO unit

|150^lb&&ANSI+| weight in pounds is a customary US unit defined within ANSI+.

2.A.11.1 Quantity (NM)

Definition: This component specifies the numeric quantity or amount of an entity.

2.A.11.2 Units (CWE)

Definition: This component species the units in which the quantity is expressed. Field-by-field, default units may be defined within the specifications. When the quantity is measured in the default units, the units need not be transmitted. If the quantity is recorded in units different from the default, the units must be transmitted.

2.A.12 CSU - channel sensitivity and units

HL7 Component Table - CSU - Channel Sensitivity and Units

Definition: This data type defines the channel sensitivity (gain) and the units in which it is measured in a waveform result.

Maximum Length: 490

Note: Replaces the CM data type used in 7.14.1.5 OBX-5.3 where OBX-5 Observation value (*) is data type CD as of v 2.5.

2.A.12.1 Channel Sensitivity (NM)

Definition: This component transmits the nominal value that corresponds to one unit in the waveform data, that is, the effective resolution of the least significant bit of the ADC, and the polarity of the channel.

2.A.12.2 Unit of Measure Identifier (ST)

Definition: The unit designation for the channel sensitivity. This field is required if the unit of measure description is not present.

2.A.12.3 Unit of Measure Description (ST)

Definition: The full text name of the unit of measure identifier. This field is required if the unit of measure identifier is not present.

2.A.12.4 Unit of Measure Coding System (IS)

Definition: Specifies the designated system of units. Refer to HL7 Table 0396 - Coding System in section 2.16.4, "Coding System Table" for suggested values. This field is required if the unit of measure identifier is present.

2.A.12.5 Alternate Unit of Measure Identifier (ST)

Definition: An alternate units designation for the channel sensitivity.

2.A.12.6 Alternate Unit of Measure Description (ST)

Definition: The full text name of the alternate unit of measure identifier

2.A.12.7 Alternate Unit of Measure Coding System (IS)

Definition: Specifies the coding system for the alternate unit of measure. Refer to HL7 Table 0396 - Coding System in section 2.16.4, "Coding System Table" for suggested values.

2.A.13 CWE - coded with exceptions

HL7 Component Table - CWE - Coded with Exceptions

Note: The Vocabulary TC is the steward of the CWE data type.

Definition: Specifies a coded element and its associated detail. The CWE data type is used when 1) more than one table may be applicable or 2) the specified HL7 or externally defined table may be extended with local values or 3) when text is in place, the code may be omitted.

Maximum Length: 705

The presence of two sets of equivalent codes in this data type is semantically different from a repetition of a CWE-type field. With repetition, several distinct codes (with distinct meanings) may be transmitted.

Usage Notes: The CWE data type should be used for coded fields with one or more of the following characteristics:

The identifier code (CWE.1) component is optional

The set of allowable values from which the identifier code is drawn may be extended on a site-specific basis

An exception identifier code may be encountered; that is, a code that is not defined in the value set (either model or site-extended).

This is in contrast to the CNE data type, which requires a code from a non-extendable value set be sent in the identifier code component (CNE.1) in all cases (except, of course, if the entire field is empty and defined as optional at the segment level).

The rules for populating CWE components are governed by the status of the identifier code:

Identifier Code Status

Identifier Code (CWE.1)

Descriptive Text (CWE.2)

Coding System (CWE.3)

Contained in model value set

Populated

May be populated

Must be populated with model coding system, or (not recommended) site-specific coding system that is a superset containing model values.

Contained in site-specific extensions to model value set

Populated

May be populated

Site-specific coding system.

Contained in neither model nor extended value sets

Not populated

May be populated with the identifier code, free-text description, or a concatenation of the two. Should be human interpretable.

Must not be populated.

Not supplied; but descriptive text is supplied.

Not populated

May be populated with descriptive text.

Must not be populated.

As an example, consider "currency" codes where:

The model values are defined by the ISO 4217 value set,

The value set is extended on site to include the code HL7 - "HL7 Drink Ticket", and

The data entry screen on the sending system does not enforce any edits for the currency code.

And so the value set used on site is:

Identifier Code Status

Identifier

Code

Descriptive Text

Model values from ISO 4217 external table

AED

United Arab Emirates, Dirhams

AFA

Afghanistan, Afghanis

ALL

Albania, Leke

...

ZAR

South Africa, Rand

ZMK

Zambia, Kwacha

ZWD

Zimbabwe, Zimbabwe Dollars

Site-specific extension

HL7

HL7 Events, Drink Ticket

Collectively, this value set must be referred to with a local coding system ID, because "HL7" does not exist in ISO 4217. According to the rules, the site assigns the coding system ID "99CUR" to the value set.

Based on the code and descriptive text entered by the user on the sending system, the CWE would be populated as follows:

Entered by user

Sent in CWE

Code

Descriptive Text

Identifier Code (CWE.1)

Descriptive Text (CWE.2)

Coding System (CWE.3)

GBP

Great Britain, Pound

GBP

Great Britain, Pound

ISO4217

GBP

Great Britain, Pound

99CUR (This option is NOT recommended)

HL7

HL7 Drink Ticket

HL7

HL7 Drink Ticket

99CUR

XXX

<Bogus entry>

Must not be populated

XXX

Must not be populated.

Must not be populated

Bogus entry

Must not be populated.

Must not be populated

XXX: Bogus entry

Must not be populated.

Must not be populated

anything - or nothing.

Must not be populated.

Dollar

Must not be populated

Dollar

Must not be populated.

Valued from HL7 Table 0353 (e.g., "U" for unkown)

Dollar

HL70353

Notes:

Where multiple valid options for sending the entered data exist, each alternative is depicted as a separate row.

CWE.2 - Descriptive Text is never required, and there are no hard and fast rules on what text may be sent in this component. Of course, common sense suggests that if valued, the text should complement the identifier code of CWE.1.

It follows that where CWE.1 cannot be valued because the entered code does not exist in the value set, the entered code may be sent in CWE.2; with or without additional descriptive text. However, this is not required by HL7.

The example with GBP shows two options for the code set: ISO4217 or 99CUR. While it is now technically possible to send 99CUR on the basis that this code may exist on its own in the extended local code set, HL7 urges that where a code is a member of the standard code set, that code set should be named in CWE.3. HL7 intends to mandate this in a future release.

While there are no formal rules regarding the valuation of CWE-2: Descriptive Text, it is expected that any value contained therein be meaningful to a human reader.

2.A.13.1 Identifier (ST)

Definition: The first component contains the sequence of characters (the code) that uniquely identifies the item being referenced by the CWE.2. Different coding schemes will have different elements here.

In the context of "Data Missing", described above in the Usage Note, refer to HL7 Table 0353 - CWE statuses for valid values.

HL7 Table 0353 - CWE statuses

2.A.13.2 Text (ST)

Definition: The second component contains the descriptive or textual name of the identifier, e.g., myocardial infarction or X-ray impression.

2.A.13.3 Name of Coding System (ID)

Definition: The third component contains the code for the name of the coding system from which the value in CWE.1 is obtained. Each coding system is assigned a unique identifier.

Refer to HL7 Table 0396 - Coding System in section 2.16.4, "Coding System Table" for valid values.

Refer to section 2.A.8.3, "Name of Coding System (ID)" for a discussion of coding system conventions.

Usage Note: Best practice would recommend that this component always be populated. However, if the field narrative explicitly states "Refer to HL7 Table nnnn for valid values", and, if the sending and receiving systems are HL7 compliant the coding system would be known from the standard. This would be similar to a field with an ID data type, except that there is a second triplet in which to express an alternate code.

2.A.13.4 Alternate Identifier (ST)

Definition: An alternate sequence of characters (the code) that uniquely identifies the item being referenced. Analogous to "Identifier" in component 1. See usage note in section introduction.

2.A.13.5 Alternate Text (ST)

Definition: The descriptive or textual name of the alternate identifier. Analogous to "Text" in component 2. See usage note in section introduction.

2.A.13.6 Name of Alternate Coding System (ID)

Definition: Identifies the coding scheme being used in the alternate identifier component. Analogous to "Name of Coding System" above. See usage note in section introduction.

2.A.13.7 Coding System Version ID (ST)

Definition: This component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID. If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header.

2.A.13.8 Alternate Coding System Version ID (ST)

Definition: This component carries the version for the coding system identified by components 4-6.

2.A.13.9 Original Text (ST)

The original text that was available to an automated process or a human before a specific code was assigned.

2.A.14 CX - extended composite ID with check digit

HL7 Component Table - CX - Extended Composite ID with Check Digit

Definition: This data type is used for specifying an identifier with its associated administrative detail.

Maximum Length: 1916

Note: The check digit and check digit scheme are null if ID is alphanumeric.

Example:

|1234567^4^M11^ADT01^MR^University Hospital|

2.A.14.1 ID (ST)

Definition: The value of the identifier itself.

2.A.14.2 Identifier Check Digit (ST)

Definition: A digit, or digits, exclusive of the identifier in CX.1, usually calculated by applying an algorithm to all or some of the digits in the number, which may be used to test validity of the non-check-digit identifier.

This component may also be used to transmit information intended to validate the veracity of the supplied identifier or the presenter of the identifier. For example, this component may be used to ensure that the presenter of a credit card is an authorized user of that card.

2.A.14.3 Check Digit Scheme (ID)

Definition: Contains the code identifying the check digit scheme employed.

Refer to HL7 Table 0061 - Check digit scheme for valid values.

HL7 Table 0061 - Check digit scheme

The algorithm for calculating a Mod10 check digit is as follows:

Assume you have an identifier - 12345. Take the odd digit positions, counting from the right, i.e., 531, multiply this number by 2 to get 1062. Take the even digit positions, starting from the right (i.e., 42), prepend these to the 1062 to get 421062. Add all of these six digits together to get 15. Subtract this number from the next highest multiple of 10, i.e., 20 - 15 to get 5. The Mod10 check digit is 5. The Mod10 check digit for 401 is 0; for 9999, it's 4; for 99999999, it's 8.

The algorithm for calculating a Mod11 check digit is as follows:

Terms

d

=

digit of number starting from units digit, followed by 10's position, followed by 100's position, etc.

w

=

weight of digit position starting with the units position, followed by 10's position, followed by 100's position etc. Values for w = 2, 3, 4, 5, 6, 7, 2, 3, 4, 5, 6, 7, etc. (repeats for each group of 6 digits)

c

=

check digit

Calculation

(Step 1) m

=

sum of (d * w) for positions 1, 2, etc. starting with units digit

for d = digit value starting with units position to highest order

for w = weight value from 2 to 7 for every six positions starting with units digit

(Step 2) c1

=

m mod 11

(Step 3) if c1

=

0 then reset c1 = 1

(Step 4)

=

(11 - c1) mod 10

Example:

If the number is 1234567, then the mod 11 check digit = 4

The calculations are:

M = (7*2)+(6*3)+(5*4)+(4*5)+(3*6)+(2*7)+(1*2)

= 14 + 18 + 20 + 20 + 18 + 14 + 2

= 106

c1 = 106 mod 11

= 7

c = (11-c1) mod 10

= 4 mod 10

= 4

Other variants of these check digit algorithms exist and may be used by local bilateral site agreement.

Note: The check digit and code identifying check digit scheme are null if ID is alphanumeric.

2.A.14.4 Assigning Authority (HD)

The assigning authority is a unique name of the system (or organization or agency or department) that creates the data. . Refer to User-defined Table 0363 - Assigning authority for suggested values.

User-defined Table 0363 - Assigning authority

The reader is referred to the CX.9 and the CX.10 if there is a need to transmit values with semantic meaning for an assigning jurisdiction or assigning department or agency in addition to, or instead of, an assigning authority. However, all 3 components may be valued. If, in so doing, it is discovered that the values in CX.9 and/or CX.10 conflict with CX.4, the user would look to the Message Profile or other implementation agreement for a statement as to which takes precedence.

Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component) may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment. By site agreement, implementers may continue to use User-defined Table 0300 - Namespace ID for the first sub-component.

2.A.14.5 Identifier Type Code (ID)

A code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the "Assigning authority" component. Refer to HL7 Table 0203 - Identifier type for suggested values.

HL7 Table 0203 - Identifier type

An Identifier for a provider at a location in the CMS/Medicare program. This identifier type is only unique within the context of a location. The location is not integral to the identifier, it must be derived from the message context/content (e.g., this identifier associated to a location by association in a message or a message segment.)

PPN	Passport number	A unique number assigned to the document affirming that a person is a citizen of the country. In the US this number is issued only by the State Department.
PRC	Permanent Resident Card Number
PRN	Provider number	A number that is unique to an individual provider, a provider group or an organization within an Assigning Authority. Use case: This allows PRN to represent either an individual (a nurse) or a group/organization (orthopedic surgery team).
PT	Patient external identifier
QA	QA number
RI	Resource identifier	A generalized resource identifier. Use Case: An identifier type is needed to accommodate what are commonly known as resources. The resources can include human (e.g. a respiratory therapist), non-human (e.g., a companion animal), inanimate object (e.g., an exam room), organization (e.g., diabetic education class) or any other physical or logical entity.
RPH	Pharmacist license number	An identifier that is unique to a pharmacist within the jurisdiction of the licensing board.
RN	Registered Nurse Number	An identifier that is unique to a registered nurse within the jurisdiction of the licensing board.
RR	Railroad Retirement number	An identifier for an individual enrolled with the Railroad Retirement Administration. Analogous to, but distinct from, a Social Security Number
RRI	Regional registry ID
RRP	Railroad Retirement Provider	Class: Insurance

An identifier for a provider register within the CMS/Railroad Retirement Administration/Medicare program (a subprogram of the CMS/Medicare)

SL	State license
SN	Subscriber Number	Class: Insurance An identifier for a subscriber of an insurance policy which is unique for, and usually assigned by, the insurance carrier. Use Case: A person is the subscriber of an insurance policy. The person's family may be plan members, but are not the subscriber.
SP	Study Permit	A number associated with a permit identifying a person who is a resident of a jurisdiction for the purpose of education.
SR	State registry ID
SS	Social Security number
TAX	Tax ID number
TN	Treaty Number/ (Canada)	A number assigned to a member of an indigenous group in Canada. Use Case: First Nation.
TPR	Temporary Permanent Resident (Canada)	A number associated with a document identifying a person's temporary permanent resident status.
U	Unspecified identifier
UPIN	Medicare/CMS (formerly HCFA)'s Universal Physician Identification numbers	Class: Insurance An identifier for a provider within the CMS/Medicare program. A globally unique identifier for the provider in the Medicare program.
VN	Visit number
VP	Visitor Permit	A number associated with a document identifying a person as a visitor of a jurisdiction or country.
VS	VISA	Deprecated and replaced by BC in v 2.5.
WC	WIC identifier
WCN	Workers' Comp Number
WP	Work Permit	A number associated with a permit for a person who is granted permission to work in a country for a specified time period.
XX	Organization identifier

Definition: The place or location identifier where the identifier was first assigned to the patient. This component is not an inherent part of the identifier but rather part of the history of the identifier: as part of this data type, its existence is a convenience for certain intercommunicating systems.

Note: When the HD data type is used in a given segment as a component of a field of another data type, User-defined Table 0300 - Namespace ID (referenced by the first sub-component of the HD component), may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.

2.A.14.7 Effective Date (DT)

Definition: The first date, if known, on which the identifier is valid and active.

2.A.14.8 Expiration Date (DT)

Definition: The last date, if known, on which the identifier is valid and active.

2.A.14.9 Assigning Jurisdiction (CWE)

Definition: The geo-political body that assigned the identifier in component 1.

• Refer to HL7 Table 0399 - Country Code in section 2.15.9.17 for valid values if the administrative unit under whose jurisdiction the identifier was issued is a country.

• Refer to User-Defined Table 0347 - State/Province for suggested values if the administrative unit under whose jurisdiction the identifier was issued is a state or province. This table is country specific. In the US, postal codes may be used.

User-defined Table 0347 - State/province

• Refer to User-defined Table -0289 County/Parish for suggested values if the administrative unit under whose jurisdiction the identifier was issued is a county or parish.

The reader is referred to the CX.4 if there is a need to transmit this information as an OID.

2.A.14.10 Assigning Agency or Department (CWE)

Definition: The agency or department that assigned the identifier in component 1.

Refer to User-defined Table 0530 - Organizations, agency, department for suggested values if the administrative unit under whose jurisdiction the identifier was issued is an organization, agency or department. This is populated with site-specific assigning authorities. It also should contain national or international codes when CX-5 Identifier Type may be assigned by more than one authority within a governmental or organizational unit. For example, a federal government may have 2 departments that assign a military identifier, its Veterans Affairs department and its Department of Defense. It is not recommended to include values for entities such as Social Security Administration (SSA), Immigration and Naturalization Service (INS), Center for Medicare and Medicaid Services (CMS) because they are included in the identifier type table. In these cases the name of the country plus the identifier type yields the correct interpretation of the identifier in component 1. Likewise, entries like department of motor vehicles (DMV) and licensing boards are not recommended for inclusion because the combination of state and identifier type yields the correct interpretation of the identifier in component 1. This approach is not to be confused with the detailed information provided in the chapter 15 segments that have provision for specifying the precise granting body and issuing body information needed in personnel management messages.

User-defined Table 0530 - Organization, agency, department

Example 1: <Identifier> plus <Visa> yields a unique identifier.

Example 2: <identifier> plus <state> plus <DLN> yields a unique driver's license number.

Example 3: <identifier> plus <country> plus <INS> yields a unique immigration number.

The reader is referred to the CX.4, if there is a need to transmit this information as an OID.

2.A.15 DDI - daily deductible information

HL7 Component Table - DDI - Daily Deductible Information

Definition: This data type specifies the detail information for the daily deductible.

Maximum Length: 25

Note: Replaces the CM data type used in section 6.5.7.30 IN2-30, as of v 2.5.

2.A.15.1 Delay Days (NM)

Definition: The number of days after which the daily deductible begins

2.A.15.2 Monetary Amount (MO)

Definition: The monetary amount of the deductible

2.A.15.3 Number of Days (NM)

Definition: The number of days to apply the deductible. If this component is not populated, it means that the number of days is indefinite.

2.A.16 DIN - date and institution name

HL7 Component Table - DIN - Date and Institution Name

Definition: Specifies the date and institution information where a staff member became active or inactive.

Maximum Length: 730

Note: Replaces the CM data type used in sections 15.4.6.12 STF-12 and 15.4.6.14 STF-13, as of v 2.5.

2.A.16.1 Date (DTM)

Definition: Specifies the date when a staff member became active or inactive.

2.A.16.2 Institution Name (CWE)

Definition: Specifies the institution where a staff member is or was active. Refer to User-Defined Table 0531 - Institutions for suggested values.

User-defined Table 0531 - Institution

HL7 Component Table - DLD - Discharge to Location and Date

Definition: Specifies the healthcare facility to which the patient was discharged and the date.

Maximum Length: 730

Note: Replaces the CM data type used in section 3.4.3.37 PV1-37, as of v 2.5.

2.A.17.1 Discharge to Location (CWE)

Definition: This component specifies the healthcare facility to which the patient was discharged. Refer to User-defined Table 0113 - Discharged to location for suggested values.

User-defined Table 0113 - Discharged to location

Definition: Specifies the date on which the patient was discharged to a healthcare facility.

2.A.18 DLN - driver's license number

HL7 Component Table - DLN - Driver's License Number

Definition: This field contains the driver's license information. For state or province refer to official postal codes for that country; for country refer to ISO 3166 for codes.

Maximum Length: 66

2.A.18.1 Driver's License Number (as ST data type)

This field contains the driver's license number.

2.A.18.2 Issuing State, Province, Country (IS)

Issuing authority for driver's license. For state or province, refer to official postal codes for that country; for country, refer to ISO 3166 for codes. The ISO 3166 table has three separate forms of the country code: HL7 specifies that the 3-character (alphabetic) form be used for the country code. User-defined Table 0333 - Driver's license issuing authority is used as the HL7 identifier for the user-defined table of values for this component.

User-defined Table 0333 - Driver's license issuing authority

Expiration date (DT) for driver's license.

2.A.19 DLT - delta

HL7 Component Table - DLT - Delta

Definition: Describes the information that controls delta check warnings.

Length: 45

Note: Replaces the CM data type used in section 8.8.4.9 - OM2-9, as of v 2.5.

2.A.19.1 Normal Range (NR)

Definition: Specifies the normal interval of the reference data

2.A.19.2 Numeric Threshold (NM)

Definition: The numeric threshold of the change that is detected.

For example the threshold may be set to 10.

2.A.19.3 Change Computation (ID)

Definition: Specifies if the change is computed as a percent change or as an absolute change. Refer to HL7 Table 0523 - Computation type for valid values.

HL7 Table 0523 - Computation type

Definition: The length of time in days that the value is retained for computing delta checks.

2.A.20 DR - date/time range

HL7 Component Table - DR - Date/Time Range

Note: DR cannot be legally expressed when embedded within another data type. Its use is constrained to a segment field.

Maximum Length: 49

2.A.20.1 Range Start Date/Time (DTM)

Definition: The first component contains the earliest date/time (time stamp) in the specified range.

2.A.20.2 Range End Date/Time (DTM)

The second component contains the latest date/time in the specified range. Note that the DTM (time stamp) data type allows the specification of precision.

2.A.21 DT - date

HL7 Component Table - DT - Date

Definition: Specifies the century and year with optional precision to month and day.

Maximum Length: 8

As of v 2.3, the number of digits populated specifies the precision using the format specification YYYY[MM[DD]]. Thus:

1. only the first four digits are used to specify a precision of "year"

2. the first six are used to specify a precision of "month"

3. the first eight are used to specify a precision of "day"

Examples:

|19880704|

|199503|

Prior to v 2.3, this data type was specified in the format YYYYMMDD. As of v 2.3 month and days are no longer required. By site-specific agreement, YYYYMMDD may be used where backward compatibility must be maintained.

2.A.22 DTM - date/time

HL7 Component Table - DTM - Date/Time

Definition: Specifies a point in time using a 24-hour clock notation.

Maximum Length: 24

The number of characters populated (excluding the time zone specification) specifies the precision.

Format: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ].

Thus:

1. only the first four are used to specify a precision of "year"

2. the first six are used to specify a precision of "month"

3. the first eight are used to specify a precision of "day"

4. the first ten are used to specify a precision of "hour"

5. the first twelve are used to specify a precision of "minute"

6. the first fourteen are used to specify a precision of "second"

7. the first sixteen are used to specify a precision of "one tenth of a second"

8. the first nineteen are used to specify a precision of " one ten thousandths of a second"

Example: |199904| specifies April 1999.

The time zone (+/-ZZZZ) is represented as +/-HHMM offset from Coordinated Universal Time (UTC) (formerly Greenwich Mean Time (GMT)), where +0000 or -0000 both represent UTC (without offset). The specific data representations used in the HL7 encoding rules are compatible with ISO 8824-1987(E).

Note that if the time zone is not included, the time zone defaults to that of the local time zone of the sender. Also note that a DTM valued field with the HHMM part set to "0000" represents midnight of the night extending from the previous day to the day given by the YYYYMMDD part (see example below). Examples:

The HL7 Standard strongly recommends that all systems routinely send the time zone offset but does not require it. All HL7 systems are required to accept the time zone offset, but its implementation is application specific. For many applications the time of interest is the local time of the sender. For example, an application in the Eastern Standard Time zone receiving notification of an admission that takes place at 11:00 PM in San Francisco on December 11 would prefer to treat the admission as having occurred on December 11 rather than advancing the date to December 12.

Note: The time zone [+/-ZZZZ], when used, is restricted to legally-defined time zones and is represented in HHMM format.

One exception to this rule would be a clinical system that processed patient data collected in a clinic and a nearby hospital that happens to be in a different time zone. Such applications may choose to convert the data to a common representation. Similar concerns apply to the transitions to and from daylight saving time. HL7 supports such requirements by requiring that the time zone information be present when the information is sent. It does not, however, specify which of the treatments discussed here will be applied by the receiving system.

2.A.23 DTN - day type and number

HL7 Component Table - DTN - Day Type and Number

Definition: This data type specifies the type and number of days for which a certification is valid.

Maximum Length: 6

Note: Replaces the CM data type used in section 6.5.8.11 IN3-11, as of v 2.5.

2.A.23.1 Day Type (IS)

Definition: Specifies whether the days are denied, pending, or approved.

Refer to User-defined Table 0149 - Day type for suggested values.

User-defined Table 0149 - Day type

Definition: Specifies the number of days for which the certification is valid.

2.A.24 ED - encapsulated data

HL7 Component Table - ED - Encapsulated Data

Definition: This data type transmits encapsulated data from a source system to a destination system. It contains the identity of the source system, the type of data, the encoding method of the data, and the data itself. This data type is similar to the RP (reference pointer) data type of Section 2.A.65, "RP - reference pointer," except that instead of pointing to the data on another system, it contains the data which is to be sent to that system.

Maximum Length: 65536

2.A.24.1 Source Application (HD)

A unique name that identifies the system which was the source of the data. Identical format and restrictions as in reference pointer (see Section 2.A.65.2, "Application ID (HD)").

2.A.24.2 Type of Data (ID)

Identical to "type of data" component in the reference pointer (RP) data type. See Section 2.A.65.3, "Type of Data (ID)".

Refer to Imported Table 0834 - MIME Types for valid values.

2.A.24.3 Data Subtype (ID)

Identical to "subtype" component in the reference pointer (RP) data type. See Section 2.A.65.4, "Subtype (ID)".

Refer to External Table 0291 - Subtype of referenced data for valid values.

2.A.24.4 Encoding (ID)

The type of encoding used to represent successive octets of binary data as displayable ASCII characters. Refer to HL7 Table 0299 - Encoding for valid values.

HL7 Table 0299 - Encoding

Displayable ASCII characters which constitute the data to be sent from source application to destination application. The characters are limited to the legal characters of the ST data type, as defined in Section 2.A.74, "ST - string data," and, if encoded binary, are encoded according to the method of Section 2.A.24.2, "Type of Data (ID)".

If the encoding component (see Section 2.A.24.4, "Encoding (ID)") = "A" (none), then the data component must be scanned before transmission for HL7 delimiter characters, and any found must be escaped by using the HL7 escape sequences defined in Section 2.7 - "Use of escape sequences in text fields." On the receiving application, the data field must be de-escaped after being parsed.

If the encoding component ED.4 does not equal "A", then, after encoding, the (encoded) data must be scanned for HL7 delimiter characters, and any found must be escaped by using the HL7 escape sequences. Only then can the component be added to the HL7 segment/message. On the receiving application, the data field must be de-escaped after being parsed out of the message before being decoded. This can be expressed as "encode", "escape", "parse", "de-escape" or "decode".

2.A.25 EI - entity identifier

HL7 Component Table - EI - Entity Identifier

Definition: The entity identifier defines a given entity within a specified series of identifiers.

Maximum Length: 427

The EI is appropriate for, but not limited to, machine or software generated identifiers. The generated identifier goes in the first component. The remaining components, 2 through 4, are known as the assigning authority; they identify the machine/system responsible for generating the identifier in component 1.

The specified series, the assigning authority, is defined by components 2 through 4. The assigning authority is of the hierarchic designator (HD) data type, but it is defined as three separate components in the EI data type, rather than as a single component as would normally be the case. This is in order to maintain backward compatibility with the EI's use as a component in several existing data fields. Otherwise, the components 2 through 4 are as defined in Section 2.A.33, "HD - hierarchic designator". Hierarchic designators (HD) are unique across a given HL7 implementation.

2.A.25.1 Entity Identifier (ST)

The first component, <entity identifier>, is usually defined to be unique within the series of identifiers created by the <assigning authority>, defined by a hierarchic designator, represented by components 2 through 4. See Section 2.A.33, "HD - hierarchic designator".

2.A.25.2 Namespace ID (IS)

See Section 2.A.33.1, "Namespace ID (IS)" for definition.

The assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data. Refer to User-defined Table 0363 - Assigning authority for suggested values.

Note: When the HD is used as a part of another data type, in this case as part of the EI data type, this table may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.

By site agreement, implementers may continue to use User-defined Table 0300 - Namespace ID for the first component

2.A.25.3 Universal ID (ST)

See Section 2.A.33.2, "Universal ID (ST)" for definition.

2.A.25.4 Universal ID Type (ID)

Refer to HL7 Table 0301 - Universal ID type for valid values. See Section 2.A.33.3, "Universal ID Type (ID)," for definition.

2.A.26 EIP - entity identifier pair

HL7 Component Table - EIP - Entity Identifier Pair

Definition: Specifies an identifier assigned to an entity by either the placer or the filler system. If both components are populated the identifiers must refer to the same entity.

Maximum Length: 855

Note: Replaces the CM data type used in sections 4.5.1.8 - ORC-8, 4.5.3.29 - OBR-29, 7.3.1.29 - OBR-29, as of v 2.5.

2.A.26.1 Placer Assigned Identifier (EI)

Definition: Specifies an identifier assigned to an entity by the placer system.

For example, the component might be used to convey the following:

1. placer order number of the parent order.

2. the specimen identifier as assigned by the placer.

3. a location identifier assigned (or used by) the placer.

2.A.26.2 Filler Assigned Identifier (EI)

Definition: Specifies an identifier assigned to an entity by the filler system.

For example, the component might convey the following:

1. filler order number of the parent order.

2. the specimen identifier as assigned by the filler.

3. a location identifier assigned (or used by) the filler.

2.A.27 ELD - error location and description

HL7 Component Table - ELD - Error Location and Description

Definition: Specifies the segment that contains an error and describes the nature of the error.

Maximum Length: 715

Note: Replaces the CM data type used in 2.16.5.1 ERR-1 as of v 2.5. Retained for backward compatibility only as of v 2.5. Refer to ERR segment.

2.A.27.1 Segment ID (ST)

Definition: The segment containing the error in another message

2.A.27.2 Segment sequence (NM)

Definition: Specifies the specific occurrence if the segment specified in component 1 occurs more than once in the message.

2.A.27.3 Field Position (NM)

Definition: Ordinal position of the data field within the segment. For systems that do not use the HL7 Encoding Rules, the data item number may be used for the third component.

2.A.27.4 Code Identifying Error (CWE)

Definition: A code that describes the nature of the error. Refer to HL7 Table 0357 - Message error condition codes in section 2.14.5, "ERR - error segment" for valid values.

2.A.28 ERL - error location

HL7 Component Table - ERL - Error Location

Definition: This data type identifies the segment and its constituent where an error has occurred.

Maximum Length: 18

2.A.28.1 Segment ID (ST)

Definition: Specifies the 3-letter name for the segment.

2.A.28.2 Segment Sequence (NM)

Definition: Identifies the segment occurrence within the message.

2.A.28.3 Field Position (NM)

Definition: Identifies the number of the field within the segment. The first field is assigned a number of 1. Field number should not be specified when referring to the entire segment.

2.A.28.4 Field Repetition (NM)

Definition: Identifies the repetition number of the field. The first repetition is counted as 1. If a Field Position is specified, but Field Repetition is not, Field Repetition should be assumed to be 1. If Field Position is not specified, Field Repetition should not be specified.

2.A.28.5 Component Number (NM)

Definition: Identifies the number of the component within the field. The first component is assigned a number of 1. Component number should not be specified when referring to the entire field.

2.A.28.6 Sub-Component Number (NM)

Definition: Identifies the number of the sub-component within the component. The first sub-component is assigned a number of 1. Sub-component number should not be specified when referring to the entire component.

2.A.29 FC - financial class

HL7 Component Table - FC- Financial Class

Maximum Length: 45

2.A.29.1 Financial Class Code (IS)

This component contains the financial class assigned to a person. User-defined Table 0064 - Financial class is used as the HL7 identifier for the user-defined table of values for this component.

User-defined Table 0064 - Financial class

This component contains the effective date/time of the person's assignment to the financial class specified in the first component.

2.A.30 FN - family name

HL7 Component Table - FN - Family Name

Definition: This data type allows full specification of the surname of a person. Where appropriate, it differentiates the person's own surname from that of the person's partner or spouse, in cases where the person's name may contain elements from either name. It also permits messages to distinguish the surname prefix (such as "van" or "de") from the surname root.

Maximum Length: 194

Note: Appears ONLY in the PPN, XCN and XPN.

2.A.30.1 Surname (ST)

The atomic element of the person's family name. In most Western usage, this is the person's last name.

2.A.30.2 Own Surname Prefix (ST)

Internationalization usage for Germanic languages. This component is optional. An example of a <surname prefix> is the "van" in "Ludwig van Beethoven". Since the <surname prefix> doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component of the PN and extended PN data types (XPN and XCN).

Note: Subcomponents <own surname prefix>, <own surname>, <surname prefix from partner/spouse> and <surname from partner/spouse> decompose complex Germanic names such as "Martha de Mum-van Beethoven". If these subcomponents are valued, the <surname> subcomponent should still be fully valued for backward compatibility, i.e., ^de Mum-van Beethoven&de&Mum&van&Beethoven^. Also, for clarity, the <last name prefix> has been renamed to <own surname prefix>.

2.A.30.3 Own Surname (ST)

The portion of the surname (in most Western usage, the last name) that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse. This component is optional.

If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

2.A.30.4 Surname Prefix from Partner/Spouse (ST)

Internationalization usage for Germanic languages. This component is optional. An example of a <surname prefix> is the "van" in "Ludwig van Beethoven". Since the <surname prefix> doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component of the PN and extended PN data types (XPN and XCN).

Note: Subcomponents <own surname prefix>, <own surname>, <surname prefix from partner/spouse> and <surname from partner/spouse> decompose complex Germanic names such as "Martha de Mum-van Beethoven". If these subcomponents are valued, the <surname> subcomponent should still be fully valued for backward compatibility, i.e., ^de Mum-van Beethoven&de&Mum&van&Beethoven^." Also, for clarity, the <last name prefix> has been renamed to <own surname prefix>.

2.A.30.5 Surname from Partner/Spouse (ST)

The portion of the person's surname (in most Western usage, the last name) that is derived from the surname of the person's partner or spouse, as distinguished from the part derived from the person's own surname. This component is optional.

If no portion of the person's surname is derived from the surname of the person's partner or spouse, this component is not valued. Otherwise, if the surname of the partner or spouse has legally changed to become (or incorporate) the person's surname, this is the surname of the partner or spouse immediately prior to such change.

2.A.31 FT - formatted text data

HL7 Component Table - FT - Formatted Text Data

Maximum Length: 65536

This data type is derived from the TX data type by allowing the addition of embedded formatting instructions. These instructions are limited to those that are intrinsic and independent of the circumstances under which the field is being used. The actual instructions and their representation are described in section 2.7.6, "Usage and Examples of Formatted Text". The FT field is of arbitrary length (up to 64k) and may contain formatting commands enclosed in escape characters.

Example:

|\.sp\(skip one vertical line)|

For additional examples of formatting commands see Section 2.7, "Use of Escape Sequences in Text Fields".

To include alternative character sets, use the appropriate escape sequence. See Section 2.15.9.18, "Character set" and Section 2.15.9.20, "Alternate character set handling".

2.A.32 GTS - general timing specification

HL7 Component Table - GTS - General Timing Specification

The General Timing Specification data type is used to communicate complex inter-related information Timing information. The value of such a field follows the formatting rules for a ST field. The string data will be structured according to the rules set forth in the "Version 3 Data Types Part II Unabridged Specification" for the General Timing Specification (GTS) data type.

Maximum Length: 199

2.A.33 HD - hierarchic designator

HL7 Component Table - HD - Hierarchic Designator

Definition: The basic definition of the HD is that it identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.). This entity could be a particular health care application such as a registration system that assigns patient identifiers, a governmental entity such as a licensing authority that assigns professional identifiers or drivers' license numbers, or a facility where such identifiers are assigned.

Maximum Length: 1027

The HD is designed to be a more powerful and more general replacement for the application identifier of HL7 versions 2.1 and 2.2. It adds two additional components, the <universal ID> and the <universal ID type> to the former application ID (which is renamed more generically to be the namespace ID).

In the case where an HD identifies an entity that assigns/creates instance identifiers such as a particular patient registration system, it defines an "assigning authority". In the case where an HD identifies a location where instance identifiers are given out (although they may be created by another entity at another location) such as a particular "department of motor vehicles office location," it defines an "assigning facility". These two different uses of the HD appear in many of the extended data types.

The "assigning authority" defined by the HD is similar in its role to the coding system (and version) part of the coded element data types: both identify a set of more discrete instance identifiers. The difference is that the set of HD-defined discrete instances contain identifiers of "real-world" things such as patient or clinical orders, while the coded element-defined set of discrete instances contains concept identifiers (codes).

The HD is designed to be used either as a local identifier (with only the <namespace ID> valued) or a publicly-assigned identifier, a UID (<universal ID> and <universal ID type> both valued). Syntactically, the HD is a group of two identifiers: a local identifier defined by the first component and a universal identifier defined by the second and third components. HDs that have defined third components (defined UID types) must have a second component that is unique within the series of IDs defined by that component.

Note: The HD is used in fields that in earlier versions of HL7 used the IS data type. Thus, a single component HD (only the first component valued) will look like a simple IS data type for older systems expecting a single component in the place of the HD data type.

If the first component for the HD data type is present, the second and third components are optional. If the third component is present, then the second must also be present (although in this case the first is optional). The second and third components must either both be valued (both non-null), or both be not valued (both null).

This means that if all three components of the HD are valued, the entity identified by the first component is the same as the entity identified by components two and three taken together. However, implementers may choose, by site agreement, to specify that if all three components of the HD are valued, the first component defines a member in the set defined by the second and third components.

Examples:

Example 1: ISO examples with only the 2nd and 3rd components valued:

|^1.2.344.24.1.1.3^ISO|

|^1.2.34.4.1.5.1.5.1,1.13143143.131.3131.1^ISO|

The syntax of the second component is defined by the ISO standard for object identifiers, not by HL7 (for which the second component is of the ST data type). Thus the periods (".") and comma (",") in the second component are part of the ISO syntax, but are legal by the definition of the HL7 ST data type.

Example 2: A GUID example

|^14344.14144321.4122344.14434.654^GUID|

Example 3: An internet example

|^falcon.iupui.edu^DNS|

Example 4: a RANDOM UID

|^40C983F09183B0295822009258A3290582^RANDOM|

Local examples:

Example 5: Local use only: a HD that looks like an IS data type

|LAB1|

|RX.PIMS.SystemB.KP.CA.SCA|

Note that the syntax of the first component is not defined by HL7 but by the site according to its own needs: the only requirement is that the first component's structure is allowed by the HL7 string (ST) data type, which is used for values by the IS data type.

Example 6: Local identifier using components 2 and 3 only

|^RX.PIMS.SystemB.CA.SCA^M|

An alternate way to encode the previous example, illustrating the use of the third component value of "M" (see HL7 Table 0301 - Universal ID type below) to identify a locally-defined identifier set. The second component has the same value as the previous example but is now defined to be a member of a set of allowable values defined by a site for the identifier set "M".

Example 7: Local identifier with 2nd and 3rd components populated.

|PathLab^PL.UCF.UC^L|

The 'PathLab' application is identified by the namespace component but it is also identified by the 2nd and 3rd components, (i.e., by the locally-defined UID system "L"). The two identifiers are equivalent.

This is a more complex HD in which the middle component, which is locally defined, is itself structured. As with the ISO example above, the middle component's structure is not defined by HL7 but by the site according to its own needs: the only requirement is that the middle component's structure is allowed by the HL7 string (ST) data type.

Example 8: local identifier and universal ID types:

|LAB1^1.2.3.3.4.6.7^ISO|

A HD with an ISO "object Identifier" as a UID and a locally defined system name. Both the first component and the second and third (taken together) refer to the same entity. This example shows that the local value and the universal ID value may be transmitted with a single HD field.

2.A.33.1 Namespace ID (IS)

User-defined Table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component.

User-defined Table 0300 - Namespace ID

Note: When the HD is used in a given segment (either as a field or as a component of another data type) this table may be re-defined (given a different user-defined table number and name) by the technical committee responsible for that segment.

2.A.33.2 Universal ID (ST)

The HD's second component, <universal ID> (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type). The UID is intended to be unique over time within the UID type. It is rigorously defined. Each UID must belong to one of the specifically enumerated schemes for constructing UIDs (defined by the UID type). The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component). Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).

2.A.33.3 Universal ID Type (ID)

The third component governs the interpretation of the second component of the HD. If the third component is a known UID refer to HL7 Table 0301 - Universal ID type for valid values, then the second component is a universal ID of that type.

HL7 Table 0301 - Universal ID type

Note: X400, X500, and DNS are not technically universally valid for all time. Names can be de-registered from an existing user and registered to a new user.

2.A.34 ICD - insurance certification definition

HL7 Component Table - ICD - Insurance Certification Definition

Definition: This data type specifies whether insurance certification is required for particular patient types, and the time window for obtaining the certification.

Maximum Length: 38

Note: Replaces the CM data type used in section 6.5.8.20 IN3-20, as of v 2.5.

2.A.34.1 Certification Patient Type (IS)

Definition: Specifies the category or type of patient for which this certification is requested. Refer to User-defined Table 0150 - Certification patient type for suggested values.

User-defined Table 0150 - Certification patient type

Definition: Specifies whether or not a certification is required. Refer to HL7 table 0136 - Yes/no indicator for valid values.

2.A.34.3 Date/Time Certification Required (DTM)

Definition: The date/time by which the certification must be obtained.

2.A.35 ID - coded value for HL7 defined tables

HL7 Component Table - ID - Coded Value for HL7 Defined Tables

Note: The Vocabulary TC is the steward of the ID data type.

Maximum Length: Varies - dependent on length of longest code in code set.

The value of such a field follows the formatting rules for an ST field except that it is drawn from a table of legal values. There shall be an HL7 table number associated with ID data types. An example of an ID field is OBR-25-result status. This data type should be used only for HL7 tables (see section 2.5.3.6, "Table"). The reverse is not true, since in some circumstances it is more appropriate to use the CNE or CWE data type for HL7 tables.

2.A.36 IS - coded value for user-defined tables

HL7 Component Table - IS - Coded Value for User-Defined Tables

Note: The Vocabulary TC is the steward of the IS data type.

Maximum Length: 20

The value of such a field follows the formatting rules for a ST field except that it is drawn from a site-defined (or user-defined) table of legal values. There shall be an HL7 table number associated with IS data types. An example of an IS field is the Event reason code defined in Section 3.3.1.4, "Event reason code". This data type should be used only for user-defined tables (see Section 2.5.3.6 - Table). The reverse is not true, since in some circumstances, it is more appropriate to use the CWE data type for user-defined tables.

2.A.37 JCC - job code/class

HL7 Component Table - JCC- Job Code/Class

Maximum Length: 292

Example 1: Codified job (where 1 represents the code for Administrator and F represents full time)

|1^F^Administrator|

Example 2: Uncodified job (where job codes are not codified and PT represents part time)

|^PT^Analyst|.

2.A.37.1 Job Code (IS)

This component contains the person's job code. User-defined Table 0327 - Job code is used as the HL7 identifier for the user-defined table of values for this component.

User-defined Table 0327 - Job code

This component contains the person's employee classification. Refer to User-defined Table 0328 - Employee classification for suggested values.

User-defined Table 0328 - Employee classification

This component contains the text of the job description. This will accommodate systems where job descriptions are not codified.

2.A.38 LA1 - location with address variation 1

HL7 Component Table - LA1 - Location with Address Variation 1

Definition: Specifies a location and its address.

Maximum Length: 790

Note: Replaces the CM data type used in 4.14.1.8 RXO-8 and 4.14.4.8 RXE-8 as of v 2.5. Retained for backward compatibility only as of v 2.5,

2.A.38.1 Point of Care (IS)

Definition: This component specifies the code for the point where patient care is administered. It is conditional on person location type (e.g., nursing unit or department or clinic). After floor, it is the most general patient location designation. Refer to User-defined Table 0302 - Point of care for suggested values.

2.A.38.2 Room (IS)

Definition: This component specifies the code for the patient room. After point of care, it is the most general person location designation. Refer to User-defined Table 0303 - Room for suggested values.

2.A.38.3 Bed (IS)

Definition: This component specifies the code for the patient bed. After room, it is the most general person location designation. Refer to User-defined Table 0304 - Bed for suggested values.

2.A.38.4 Facility (HD)

Definition: This component is subject to site interpretation but generally describes the highest level physical designation of an institution, medical center or enterprise. It is the most general person location designation.

2.A.38.5 Location Status (IS)

Definition: This component specifies the code for the status or availability of the location. For example, it may convey bed status. Refer to User-defined Table 0306 - Location status for suggested values.

2.A.38.6 Patient Location Type (IS)

Definition: Person location type is the categorization of the person's location defined by facility, building, floor, point of care, room or bed. Although not a required field, when used, it may be the only populated field. It usually includes values such as nursing unit, department, clinic, SNF, physician's office. Refer to User-defined Table 0305 - Person location type for suggested values.

2.A.38.7 Building (IS)

Definition: This component specifies the code for the building where the person is located. After facility, it is the most general person location designation. Refer to User-defined Table 0307 - Building for suggested values.

2.A.38.8 Floor (IS)

Definition: This component specifies the code for the floor where the person is located. After building, it is the most general person location designation. Refer to User-defined Table 0308 - Floor for suggested values.

2.A.38.9 Address (AD)

Definition: This component specifies the address of a location.

2.A.39 LA2 - location with address variation 2

HL7 Component Table - LA2 - Location with Address Variation 2

Definition: Specifies a location and its address.

Maximum Length: 790

Note: Replaces the CM data type used in 4.14.5.13 RXD-13, 4.14.6.11 RXG-11 and 4.14.7.11 RXA-11 as of v 2.5. Retained for backward compatibility only as of v 2.5,

2.A.39.1 Point of Care (IS)

Definition: This component specifies the code for the point where patient care is administered. It is conditional on Patient Location Type (e.g., nursing unit or department or clinic). After floor, it is the most general patient location designation. Refer to User-defined Table 0302 - Point of care for suggested values.

2.A.39.2 Room (IS)

Definition: This component specifies the code for the patient room. After point of care, it is the most general person location designation. Refer to User-defined Table 0303 - Room for suggested values.

2.A.39.3 Bed (IS)

Definition: This component specifies the code for the patient's bed. After room, it is the most general person location designation. Refer to User-defined Table 0304 - Bed for suggested values.

2.A.39.4 Facility (HD)

Definition: This component is subject to site interpretation but generally describes the highest level physical designation of an institution, medical center or enterprise. It is the most general person location designation.

2.A.39.5 Location Status (IS)

Definition: This component specifies the code for the status or availability of the location. For example, it may convey bed status. Refer to User-defined Table 0306 - Location status for suggested values.

2.A.39.6 Patient Location Type (IS)

Definition: Patient location type is the categorization of the patient's location defined by facility, building, floor, point of care, room or bed. Although not a required field, when used, it may be the only populated field. It usually includes values such as nursing unit, department, clinic, SNF, physician's office. Refer to User-defined Table 0305 - Person location type for suggested values.

2.A.39.7 Building (IS)

Definition: This component specifies the code for the building where the person is located. After facility, it is the most general person location designation. Refer to User-defined Table 0307 - Building for suggested values.

2.A.39.8 Floor (IS)

Definition: This component specifies the code for the floor where the person is located. After building, it is the most general person location designation. Refer to User-defined Table 0308 - Floor for suggested values.

2.A.39.9 Street Address (ST)

Definition: This component specifies the street or mailing address of a person or institution. When referencing an institution, it is used to specify the institution name. When used in connection with a person, it specifies the first line of the address.

2.A.39.10 Other Designation (ST)

Definition: This component specifies the second line of an address. In general, it qualifies address. Examples: Suite 555 or Fourth Floor. When referencing an institution, this component specifies the street address.

2.A.39.11 City (ST)

Definition: This component specifies the city, or district or place where the person or institution is located depending upon the national convention for formatting addresses for postal usage. City should be represented by the official postal service codes for that state.

2.A.39.12 State or Province (ST)

Definition: This component specifies the state or province where the person or institution is located. State or province should be represented by the official postal service codes for that country.

2.A.39.13 Zip or Postal Code (ST)

Definition: This component specifies the zip or postal code where the person or institution is located. Zip or postal codes should be represented by the official codes for that country. In the US, the zip code takes the form 99999[-9999], while the Canadian postal code takes the form A9A9A9 and the Australian Postcode takes the form 9999.

2.A.39.14 Country (ID)

Definition: This component specifies the country where the person or institution is located. ISO 3166 provides a list of country codes that may be used. HL7 specifies that the 3-character (alphabetic) form of ISO 3166 be used for the country code. Refer to HL7 Table 0399 - Country code in section 2.14.9.17, "MSH-17 Country Code" for valid values.

2.A.39.15 Address Type (ID)

Definition: This component specifies the kind or type of address. Refer to HL7 Table 0190 - Address type for valid values.

2.A.39.16 Other Geographic Designation (ST)

Definition: This component specifies any other geographic designation that may be necessary. It includes county, bioregion, SMSA, etc.

2.A.40 MA - multiplexed array

HL7 Component Table - MA - Multiplexed Array

Definition: This data type is used to represent channel-multiplexed waveform data. Assuming that fields that utilize this data type repeat and that Y represents the specific repetition, the components of the repetition will reflect sample Y from each channel.

Usage Note: The MA data type is preferred when the signal recording device outputs the waveform data by time (all signal amplitudes at time sample 1, followed by all signal amplitudes at time sample 2, followed by all signal amplitudes at time sample 3, etc.). The typical count is 32, 64, or 128 channels. At the time of this writing, the MA data type is the one used by most commercial EEG instruments, while other electrophysiological instruments (such as evoked potential instruments) may use the NA data type. The MA data type is the "natural" one for multi-channel EEG instruments since the signal acquisition process involves digitizing each channel in succession as rapidly as possible, then after a fixed interval (like 0.004 seconds) digitizing all the channels again in succession, and repeating this every 0.004 seconds as long as the recording continues.

Conversion of one format to another is often not possible or desirable in near-real-time applications. For example, a long-term EEG recording may go on for 24, 48, 72, or more hours and implementations cannot wait until the recording is ended to transmit the data because physicians need to review the waveforms as the recording is in progress; this is why it only makes sense to organize the data by the MA data type which sends the data one time sample after the next.

Use Case: Commercial EEG instruments

Maximum Length: 65536

Example 1: 3 channels (identical), 6 time-samples

|0^0^0~1^1^1~2^2^2~3^3^3~4^4^4~5^5^5|

Example 2: 1 channel, 11 time-samples

|0~1~2~3~4~5~6~7~8~9~10|

2.A.41 MO - money

HL7 Component Table - MO - Money

Definition: This data type specifies an amount of money and the denomination in which it is expressed.

Maximum Length: 20

2.A.41.1 Quantity (NM)

The first component is a quantity.

2.A.41.2 Denomination (ID)

The second component is the denomination in which the quantity is expressed. The values for the denomination component are those specified in ISO-4217. If the denomination is not specified, "MSH-17-country code", in section 2.14.9.17, is used to determine the default. Example:

|99.50^USD|

where USD is the ISO 4217 code for the U.S. American dollar.

2.A.42 MOC - money and charge code

HL7 Component Table - MOC - Money and Code

Definition: Transmits monetary information and the associated charge code for services performed.

Maximum Length: 726

Note: Replaces the CM data type used in sections 4.5.3.23 OBR-23 and 7.4.1.23- OBR-23 as of v 2.5.

2.A.42.1 Monetary Amount (MO)

Definition: The amount and denomination of money associated with the charge code.

2.A.42.2 Charge Code (CWE)

Definition: The code identifying the charge to the ordering entity for the services performed.

2.A.43 MOP - money or percentage

HL7 Component Table - MOP - Money or Percentage

Definition: This data type specifies an amount that may be either currency or a percentage. It is a variation on the MO data type that is limited to currency.

Maximum Length: 23

Note: Replaces the CM data type used in section 6.5.8.5 IN3-5, as of v 2.5. This data type is restricted to this field.

Example: USD is the ISO 4217 code for the U.S. American dollar.

|AT^99.50^USD|

2.A.43.1 Money or Percentage Indicator (ID)

Definition: Specifies whether the amount is currency or a percentage.

Refer to HL7 Table 0148 - Money or percentage indicator for valid values.

HL7 Table 0148 - Money or percentage indicator

Definition: Specifies the currency or percentage quantity.

2.A.43.3 Currency Denomination (ID)

Definition: the denomination in which the quantity is expressed where the amount is currency. The values for the denomination component are those specified in ISO-4217. If the denomination is not specified, the context of the message or "MSH-17-country code", in section 2.14.9.17, is used to determine the default.

2.A.44 MSG - message type

HL7 Component Table - MSG - Message Type

Definition: This field contains the message type, trigger event, and the message structure ID for the message.

Maximum Length: 15.

Note: Replaces the CM data type used in 2.16.9.9 MSH-9 as of v 2.5.

2.A.44.1 Message Code (ID)

Definition: Specifies the message type code. Refer to HL7 Table 0076- Message Type in section 2.16.1 for valid values.

This table contains values such as ACK, ADT, ORM, ORU etc.

See section 2.5.1, "Messages" for further discussion.

2.A.44.2 Trigger Event (ID)

Definition: Specifies the trigger event code. Refer to HL7 Table 0003- Event Type in section 2.16.2 for valid values.

This table contains values like A01, O01, R01 etc.

See section 2.3.1 - Trigger Events for further discussion.

2.A.44.3 Message Structure (ID)

Definition: Specifies the abstract message structure code. Refer to HL7 Table 0354 - Message Structure in section 2.17.3 for valid values.

2.A.45 NA - numeric array

HL7 Component Table - NA - Numeric Array

Definition: This data type is used to represent a series (array) of numeric values. A field of this type may contain a one-dimensional array (vector or row) of numbers. Also, by allowing the field to repeat, a two-dimensional array (table) of numbers may be transmitted using this format, with each row of the table represented as one repetition of the field. Arrays that have one or more values not present may be transmitted using this data type. "Not present" values are represented as two adjacent component delimiters. If the absent values occur at the end of a row, the trailing component delimiters may be omitted. If an entire row of a table has no values, no component delimiters are necessary (in this case, there will be two adjacent repetition delimiters).

Maximum Length: 65536

Example 1: vector of 8 numbers

|125^34^-22^-234^569^442^-212^6|

Example 2: 3 x 3 array of numbers

|1.2^-3.5^5.2~2.0^3.1^-6.2~3.5^7.8^-1.3|

Example 3: 5 x 4 array of numbers with the values in positions (1,1), (2,2), (2,3), (3,3), (3,4), (4,1), (4,2), (4,3), and (4,4) not present

|^2^3^4~5^^^8~9^10~~17^18^19^20|

2.A.46 NDL - name with date and location

HL7 Component Table - NDL - Name with Date and Location

Definition: Specifies the name of the person performing a service, when the person performed the service and where the person performed the service. Retained for backward compatibility as of v2.6.

Maximum Length: 831

Note: Replaces the CM data type used in sections 4.5.3.32 and 7.4.1.32-( OBR-32), 4.5.3.33 and 7.4.1.33 - ( OBR-33) 4.5.3.34 and 7.4.1.34 - ( OBR-34) 4.5.3.35 and 7.4.1.35 - ( OBR-35) as of v 2.5.

2.A.46.1 Name (CNN)

Definition: This component specifies the name of the person performing a service.

2.A.46.2 Start date/time (DTM)

Definition: This component specifies the starting date and time for when the person is performing the service.

2.A.46.3 End Date/time (DTM)

Definition: This component specifies the ending date and time for when the person is performing the service.

2.A.46.4 Point of Care (IS)

Definition: This component specifies the code for the point where patient care is administered. It is conditional on NDL.9 - Patient Location Type (e.g., nursing unit or department or clinic). After floor, it is the most general patient location designation. Refer to User-defined Table 0302 - Point of care for suggested values

2.A.46.5 Room (IS)

Definition: Patient room. After point of care, it is the most general location designation. Refer to User-defined Table 0303 - Room for suggested values.

2.A.46.6 Bed (IS)

Definition: This component specifies the code for the patient's bed. After room, it is the most general location designation. Refer to User-defined Table 0304 - Bed for suggested values.

2.A.46.7 Facility (HD)

Definition: This component is subject to site interpretation but generally describes the highest level physical designation of an institution, medical center or enterprise. It is the most general location designation.

2.A.46.8 Location Status (IS)

Definition: This component specifies the code for the status or availability of the location. For example, it may convey bed status. Refer to User-defined Table 0306 - Location status for suggested values.

2.A.46.9 Patient Location Type (IS)

Definition: Location type is the categorization of the location defined by facility, building, floor, point of care, room or bed. Although not a required field, when used, it may be the only populated field. Usually includes values such as nursing unit, department, clinic, SNF, physician's office. Refer to User-defined Table 0305 - Person location type for suggested values.

2.A.46.10 Building (IS)

Definition: This component specifies the code for the building where the person is located. After facility, it is the most general location designation. Refer to User-defined Table 0307 - Building for suggested values.

2.A.46.11 Floor (IS)

Definition: This component specifies the code for the floor where the person is located. After building, it is the most general location designation. Refer to User-defined Table 0308 - Floor for suggested values.

2.A.47 NM - numeric

HL7 Component Table - NM - Numeric

Definition: A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an optional decimal point. In the absence of a sign, the number is assumed to be positive. If there is no decimal point the number is assumed to be an integer.

Maximum Length: 16

Examples:

|999|

|-123.792|

Leading zeros, or trailing zeros after a decimal point, are not significant. For example, the following two values with different representations, "01.20" and "1.2," are identical. Except for the optional leading sign (+ or -) and the optional decimal point (.), no non-numeric ASCII characters are allowed. Thus, the value <12 should be encoded as a structured numeric (SN) (preferred) or as a string (ST) (allowed, but not preferred) data type.

2.A.48 NR - numeric range

HL7 Component Table - NR - Numeric Range

Definition: Specifies the interval between the lowest and the highest values in a series of data. In the case where a numeric range is unbounded on one side, the component of the unbounded side is null. Whether the end points are included in the range is defined in the usage note for the field.

Note: Replaces the CM data type used in sections 8.8.4.6.1- OM2-6.1, 8.8.4.6.3- OM2-6.3and 8.8.4.6.4- OM2-6.4, as of v 2.5.

Maximum Length: 33

2.A.48.1 Low Value (NM)

Definition: The number specifying the lower limit or boundary of the range.

2.A.48.2 High Value (NM)

Definition: The number specifying the high limit or boundary of the range.

2.A.49 OCD - occurrence code and date

HL7 Component Table - OCD - Occurrence Code and Date

Definition: The code and associated date defining a significant event relating to a bill that may affect payer processing.

Maximum Length: 714

Note: Replaces the CM data type used in sections 6.5.10.10 UB1-16 and 6.5.11.7 UB2-7, as of v 2.5.

This data type carries data defined by CMS or other regulatory agencies. It corresponds to UB82 Fields 28-32 and UB92 fields 32a, 32b, 33a, 33b, 34a, 34b, 35a, and 35b. Refer to a UB specification for additional information.

Use Case: A Medicare beneficiary was confined in hospital from January 1, 1992 to January 10, 1992, however, his Medicare Part A benefits were exhausted as of January 8, 1992, and he was not entitled to Part B benefits. Therefore, Form Locator 32 should contain code 23 and the date 010892.

Example:

|23&Benefits Exhausted&NUBC^19920108|

2.A.49.1 Occurrence Code (CNE)

Definition: The NUBC code for the event or occurrence relating to a bill that may affect payer processing.

Refer to HL7-defined Table 0350 - Occurrence code for valid values.

Values for this component need to come from National Uniform Billing Committee (NUBC). No extensions are allowed.

HL7-defined Table 0350 - Occurrence code

Definition: The date the event, relating to a bill that may affect payer processing, occurred.

2.A.50 OSD - order sequence definition

HL7 Component Table - OSD - Order Sequence Definition

Definition: This data type specifies a fully coded version for forming a relationship between an order and one or more other orders. The relationship may be sequential or a cyclical pattern.

Usage of the OSD is restricted to the TQ data type (especially as it is applied to the ORC-7). Retained for backward compatibility only as of v 2.5. The reader is advised to consider the TQ1 and TQ2 segments rather than this data type if sequencing levels or cyclical patterns need to be transmitted.

Maximum Length: 110

Note: Replaces the CM data type used in the TQ data type, component 10, as of v 2.5.

There are many situations, such as the creation of an order for a group of intravenous (IV) solutions, where the sequence of the individual intravenous solutions (each a service in itself) needs to be specified, e.g., hyperalimentation with multi-vitamins in every third bottle.

There are other situations where part of the order's instructions contains a results condition of some type, such as "PRN pain". There is currently a free text "condition" component of ORC-7-quantity/timing that allows any condition to be specified.

The sequencing conditions are based on the completion of a predecessor service.

Usage notes:

Suppose the following:

The predecessor order is defined by the OE1000&OrdEnt as the placer order number, in subcomponents 2 and 3 of component 10 of ORC-7-quantity/timing.

The successor order, this order, has the placer order number OE1001^OrdEnt in the ORC segment.

The following sequence condition values have the following meanings:

Use Case 1: Cyclic placer order groups

For the special case where there is a cycle of orders that must be repeated, the first order to be executed will have a "sequence condition value" whose first character must be an asterisk (*). The last order to be executed may have a "sequence condition value" whose first character must be a pound sign (#).

Example:

Note: This requires that the ordering application be able to specify the placer order number of the last order in the cycle in the first order's quantity/timing specification.

To implement a cyclic group of four IV orders using the parent/child paradigm, the parent specifies a custom group of IVs, and the following occurs:

ORC-7-quantity/timing of the second child order specifies that it follows the first child order.

ORC-7-quantity/timing of the third child order specifies that it follows the second child order.

ORC-7-quantity/timing of the fourth child order specifies that it follows the third order.

To repeat the group of four child orders in a cyclic manner, the following occurs:

ORC-7-quantity/timing of the first child order specifies that it is to be executed once without any dependence on the completion of other orders.

Its second execution follows the completion of the fourth order. See example in Chapter 4 RXO segment examples. This scheme allows the following to be tracked:

The status of the whole group of orders to be reported back at the level of the parent order.

The status for each individual IV order by following the status of the corresponding child order.

Separate Orders example:

The same group of orders can be sent as a group of four orders (without a common parent), linked only by the data in their quantity/timing fields. In this case, there is no convenient HL7 method of transmitting the order status of the group as a whole without transmitting the status of each of the four separate orders.

Use Case 2: Inheritance of order status

Cancellation/discontinuation/hold order control events:

This logic implies the normal execution of the referenced predecessor order. Thus a cancel (or discontinuation or hold) of a predecessor order implies the cancellation (or discontinuation or hold) of all subsequent orders in the chain.

If the referenced order has been canceled (or discontinued or held), the current order inherits that same status.

In the case of hold, the removal of the hold of the predecessor implies a removal of the hold for the given order (which can then be executed according to the specification in the 10th component).

2.A.50.1 Sequence/Results Flag (ID)

Definition: Identifies whether sequence conditions or a repeating cycle of orders is defined. Refer to HL7-defined Table 0524 - Sequence condition for valid values.

HL7 Table 0524 - Sequence condition