Definition
A "Code. Type" is a character string of letters, numbers, special characters (except escape sequences), and symbols. It represents a definitive value, a method, or a property description in an abbreviated or language-independent form that is part of a finite list of allowed values.
Remarks
"Code. Type" should be used in case of a finite list of allowed values and the "Identifier. Type" should be used in case of a infinite set of objects.
Use
The "Code. Type" is used for all elements that are used in the communication between partners or systems to enable a common coded value representation. Typical example of code types are: Country_ Code. Type and Language_ Code. Type.
Structure
| Dictionary Entry Name | Data Type Term | Property Term | Representation Term | Primitive Type | Cardinality | Allowed Facets | Definition | Usage Rules | Comment |
|---|---|---|---|---|---|---|---|---|---|
| Code. Type |
Code |
Type |
|||||||
| Code. Content |
Code |
Content |
Token |
1..1 |
Expression Length Min. Length Max. Length Enumeration |
A character string (letters, figures or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an attribute. |
|||
| Code. List. Identifier |
Code |
List |
Identifier |
Token |
0..1 |
Expression Length Min. Length Max. Length Enumeration |
The identification of a list of codes |
||
| Code. List Agency. Identifier |
Code |
List Agency |
Identifier |
Token |
0..1 |
Expression Length Min. Length Max. Length Enumeration |
The Identification of the agency that maintains one or more lists of codes. |
Defaults to the UN/EDIFACT data element 3055 code list. |
|
| Code. List Version. Identifier |
Code |
List Version |
Identifier |
Token |
0..1 |
Expression Length Min. Length Max. Length Enumeration |
The Version of the list of codes. |
Identifies the Version of the UN/EDIFACT data element 3055 code list. |
The Code. Name. Text needs to be present in order to define a code list to communicate the value of a given code value. For example in define a list of currency codes the content USD would have the name value of "US Dollars".
Also there are implementations that would like to use this name to communicate the meaning of a code within a transaction that would make use of this. CDT should discuss this use case further.
The two supplementary components "Code. List Agency Scheme. Identifer" and "Code. List Agency Schem Agency. Identifier" are not required any more.