Defines an individual member value of a codelist including display format.
| Element Name | CodeListItem |
|---|---|
| Parent Elements | CodeList |
| Element XPath(s) | /ODM/Study/MetaDataVersion/CodeList/CodeListItem |
| Element Textual Value | None |
| Attributes | CodedValue, Rank, OrderNumber, CommentOID |
| Child Elements | (Description?, Decode?, Coding*, Alias*) |
| Usage/Business Rules |
|
| Attribute | Schema Datatype or Enumeration | Usage | Definition | Business Rules |
|---|---|---|---|---|
| CodedValue | text | Required | Value of the codelist item (as it would occur in clinical data). | For ItemDef elements that reference a CodeList element containing CodeListItem child elements, ItemData values must match a CodedValue attribute. The CodedValue must be an acceptable value of the DataType of the containing CodeList. The CodeListItems within a single CodeList must not have duplicate CodedValues (as interpreted by the CodeList's DataType). |
| Rank | float | Optional | Numeric significance of the CodeListItem relative to others in the CodeList. The Rank attribute may be used where the relative value corresponding to an enumeration cannot or should not be determined by its lexical order. For example, if you have a list of enumerated text values including "Low", "Medium", and "High" and wish to assign these relative numeric values 1, 2, and 3 respectively, you should include a Rank attribute for each CodeListItem defined. Without the applied rank attribute, the normal lexical ordering would be "High", "Low", and "Medium". | If Rank is provided for any CodeListItem in a CodeList, it must be provided for all and values must be unique. |
| Other | (Yes) | Optional | Flag to indicate that the term represents "other" content. | |
| OrderNumber | integer | Optional | Ordering on the CodeListItems (within a containing CodeListItem) for use whenever a list of Items is presented to a user. The ordering does not imply anything about event scheduling, time ordering, or data correctness. | OrderNumber must be a positive integer. |
| CommentOID | oidref | Optional | Reference to a CommentDef. | Must match the OID for a CommentDef within the Study/MetaDataVersion. |
Defines an individual member value of a codelist including a display value in the child Decode element. The actual value is given, along with a set of print/display-forms. The CodedValue must be an acceptable value of the DataType of the containing CodeList.
The CodeListItems within a single CodeList must not have duplicate CodedValues (as interpreted by the CodeList's DataType).
The Rank attribute may be used where the relative value corresponding to an enumeration cannot or should not be determined by its lexical order. For example, if you have a list of enumerated text values including "Low", "Medium", and "High" and wish to assign these relative numeric values 1, 2, and 3 respectively, you should include a Rank attribute for each CodeListItem defined. Without the applied rank attribute, the normal lexical ordering would be "High", "Low", and "Medium".
The OrderNumbers provide an ordering on the CodeListItems (within a containing CodeList) for use whenever a list of CodeList Items is presented to a user. They do not imply anything about event scheduling, time ordering, or data correctness.
The CodeListItems within a single CodeList must not have duplicate Ranks or OrderNumbers.