Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleModel Documentation

Class: ExtensibleTerminologyTerm

The abstract ExtensibleTerminologyTerm class acts as a template that defines 2 attributes, either (but not both) of which may be used to indicate the value assigned to an attribute associated with an extensible enumeration. The controlledTerm attribute is used to specify 1 of the permissible values from the enumeration or the sponsorTermId attribute is used to indicate which sponsor term is used in the terminology extension for the enumeration. 

Section
Column

Excerpt Include
ARSP:Class Diagram: ExtensibleTerminologyTerm
ARSP:Class Diagram: ExtensibleTerminologyTerm

There are 8 specializations of the ExtensibleTerminologyTerm class: There is a pair of specializations for each of the 4 extensible enumerations, with 1 of the pair specifying use of only the controlledTerm attribute and the other specifying use of only the sponsorTermId attribute.

SpecializationAttributeUsed To Specify:

OperationRole

controlledTermA permissible value from the OperationRoleEnum enumeration.

SponsorOperationRole

sponsorTermIdThe identifier of a sponsor term in the terminology extension for the OperationRoleEnum enumeration.

AnalysisReason

controlledTermA permissible value from the AnalysisReasonEnum enumeration.

SponsorAnalysisReason

sponsorTermIdThe identifier of a sponsor term in the terminology extension for the AnalysisReasonEnum enumeration.

AnalysisPurpose

controlledTermA permissible value from the AnalysisPurposeEnum enumeration.

SponsorAnalysisPurpose

sponsorTermIdThe identifier of a sponsor term in the terminology extension for the AnalysisPurposeEnum enumeration.

OutputFileType

controlledTermA permissible value from the OutputFileTypeEnum enumeration.

SponsorOutputFileType

sponsorTermIdThe identifier of a sponsor term in the terminology extension for the OutputFileTypeEnum enumeration.

These specializations are designed to constrain the use of attributes and enumerations for attributes associated with extensible enumerations. In practice, sponsors simply populate any attribute associated with an extensible enumeration with either:

  • A controlledTerm attribute containing one of the permissible values from the associated enumeration, or
  • sponsorTermId attribute containing the identifier of a sponsor term defined in the terminology extension for the associated enumeration. 
Example
Include Page
controlledTerm or sponsorTermId
controlledTerm or sponsorTermId

true
Pagenav
nopanel