| Element Name | CodeListItem |
|---|---|
| Parent Element(s) | CodeList |
| Element XPath(s) | /ODM/Study/MetaDataVersion/CodeList/CodeListItem |
| Element Textual Value | None |
| Usage | |
| Attributes | CodedValue, Rank, OrderNumber, CommentOID |
| Child Elements | (Decode, Coding*, Alias*) |
Body:
Attributes:
| CodedValue | text | Value of the codelist item (as it would occur in clinical data). | |
| Rank | float | (optional) | Numeric significance of the CodeListItem relative to others in the CodeList. Rank is optional, but if given for any CodeListItems in a CodeList it must be given for all. |
| OrderNumber | integer | (optional) | Ordering on the Items (within a containing CodeListItem) for use whenever a list of Items is presented to a user. OrderNumber is optional, but if given for any CodeListItems in a CodeList it must be given for all. |
| CommentOID | oidref | (optional) | Reference to a CommentDef. |
Contained in:
Defines an individual member value of a codelist including display format. 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.