Defines an individual member value of a valid value list.
| Element Name | EnumeratedItem |
|---|---|
| Parent Element(s) | CodeList |
| Element XPath(s) | /ODM/Study/MetaDataVersion/CodeList/EnumeratedItem |
| Element Textual Value | None |
| Usage |
A Codelist may not have both CodeListItem and EnumeratedItem elements. |
| Attributes | CodedValue, Rank, OrderNumber, CommentOID |
| Child Elements | (Description?, Coding*, Alias*) |
| 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. |
| Rank | float | Optional | Numeric significance of the CodeListItem relative to others in the CodeList. | If Rank is provided for any CodeListItem in a CodeList, it must be provided for all. |
| Other | (Yes) | Optional | Signfies that the term represents "other" content. | |
| OrderNumber | integer | Optional | Ordering on the Items (within a containing CodeListItem) for use whenever a list of Items is presented to a user. | If OrderNumber is provided for any CodeListItem, it must be provided for all. |
| 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 valid value list. Only the coded value is given. If print/display-forms are needed, CodeListItem should be used. CodeListItems and EnumeratedItems may not be mixed within a single codelist. The CodedValue must be an acceptable value of the DataType of the containing CodeList.
The EnumeratedItems within a single CodeList element 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 EnumeratedItem defined. Without the applied rank attribute, the normal lexical ordering would be "High", "Low", and "Medium".
The OrderNumbers provide an ordering on the EnumeratedItems (within a containing CodeList) for use whenever a list of Enumerated Items is presented to a user. They do not imply anything about event scheduling, time ordering, or data correctness.
The EnumeratedItems within a single CodeList must not have duplicate Ranks or OrderNumbers.