18.3.78 CF - coded element with formatted values (2A.3.7)

As of v2.7 a third tuple, formerly known as triplet, has been added to the CF data type. Additionally, 3 new components were added to each tuple such that each tuple now has a total of 7 components. The Original Text component applies to the CF as a whole.

HL7 Component Table - CF - Coded Element with Formatted Values

Core Framework									Base Standard Profile
Seq#	Description	Interpretation	Flags	Cardinality	Length	C.LEN	Vocabulary	Data Type	Implement	Cardinality	Vocabulary
CF
1	Identifier			[0..1]				ST
2	Formatted Text			[0..1]				FT
3	Name of Coding System			C Condition defined for this element [1..1] [0..0]			codingSystem (CD VS)	ID	MAY		(CS)
4	Alternate Identifier			[0..1]				ST
5	Alternate Formatted Text			[0..1]				FT
6	Name of Alternate Coding System			C Condition defined for this element [1..1] [0..0]			codingSystem (CD VS)	ID	MAY		(CS)
7	Coding System Version ID			C Condition defined for this element [1..1] [0..0]				ST	MAY
8	Alternate Coding System Version ID			[0..1]				ST
9	Original Text			[0..1]				ST
10	Second Alternate Identifier			[0..1]				ST
11	Second Alternate Formatted Text			[0..1]				FT
12	Name of Second Alternate Coding System			[0..1]			codingSystem (CD VS)	ID			(CS)
13	Second Alternate Coding System Version ID			C Condition defined for this element [1..1] [0..0]				ST	MAY
14	Coding System OID			C Condition defined for this element [1..1] [0..0]				ST	MAY
15	Value Set OID			[0..1]				ST
16	Value Set Version ID			C Condition defined for this element [1..1] [0..0]				DTM	MAY
17	Alternate Coding System OID			C Condition defined for this element [1..1] [0..0]				ST	MAY
18	Alternate Value Set OID			[0..1]				ST
19	Alternate Value Set Version ID			C Condition defined for this element [1..1] [0..0]				DTM	MAY
20	Second Alternate Coding System OID			C Condition defined for this element [1..1] [0..0]				ST	MAY
21	Second Alternate Value Set OID			[0..1]				ST
22	Second Alternate Value Set Version ID			C Condition defined for this element [1..1] [0..0]				DTM	MAY

Conditions/Invariants

The root for the expression is on the segment.

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:

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

18.3.78.1 Identifier (ST) (2A.3.7.0)

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

18.3.78.2 Formatted Text (FT) (2A.3.7.1)

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

18.3.78.3 Name of Coding System (ID) (2A.3.7.2)

Definition: Contains the name of the coding system employed.

Refer to HL7 Table 0396 - Coding System in Chapter 2C, Code Tables, for valid values.

As of v2.7 this component is required when CF.1 is populated and CF.14 is not populated. Both CF.3 and CF.14 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding system as specified in CF.3 and/or CF.14, the Coding System component or the Coding System OID, for the tuple.

18.3.78.4 Alternate Identifier (ST) (2A.3.7.3)

Definition: A sequence of characters that uniquely identifies an alternate code. Analogous to CF-1 Identifier.

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.

18.3.78.5 Alternate Formatted Text (FT) (2A.3.7.4)

Definition: Name or description of the alternate identifier in question with the addition of embedded formatting instructions. Analogous to CF.2 Formatted Text.

18.3.78.6 Name of Alternate Coding System (ID) (2A.3.7.5)

Definition: Contains the name of the coding system employed for the alternate identifier. Analogous to CF.3 Name of Coding System.

Refer to HL7 Table 0396 - Coding System in Chapter 2C, Code Tables, for valid values.

As of v2.7 this component is required when CF.4 is populated and CF.17 is not populated. Both CF.6 and CF.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding ystem as specified in CF.6 and/or CF.17, the Coding System component or the Coding System OID, for the tuple.

18.3.78.7 Coding System Version ID (ST) (2A.3.7.6)

Definition: This component carries the version for the coding system identified by components 1-3. If CF.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 CF.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.

18.3.78.8 Alternate Coding System Version ID (ST) (2A.3.7.7)

Definition: This component carries the version for the coding system identified by components 4-6. Analogous To CF.7 Coding System Version ID.

18.3.78.9 Original Text (ST) (2A.3.7.8)

Definition: The text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.

18.3.78.10 Second Alternate Identifier (ST) (2A.3.7.9)

Definition: A sequence of characters that uniquely identifies an alternate code. Analogous to CF.1 Identifier.