dt_Coded : public abstract class
| Created: |
09/18/06 19:15:09 |
| Modified: |
10/09/06 14:15:14 |
|
Project: |
|
| Author: |
John Arnett |
| Version: |
1.0 |
| Phase: |
1.0 |
| Status: |
Proposed |
| Complexity: |
Easy |
Advanced: |
|
| UUID: |
{BBB57AA0-2618-4551-8C3A-229393A93B11} |
| Appears In: |
Business Analysis Datatypes, Technical |
A concept represented by a code from a set of permissible values defined in a code system. As well as identifying code system and version, Coded contains optional attributes that support translation and qualification of the code value.
Note: within this model, each code system's set of permissible code values (and their display names) is held by a corresponding concrete subclass (see Codesets package).
HL7v3 equivalent: Coded is perhaps most usefully mapped to the various "flavors" used by C+M to constrain HL7 v3 coded datatypes. These include:
Coded with Code System (typically CV) contains code and codeSystem.
Coded Plain (typically CV) contains code, codeSystem and displayName.
Coded with Original Text (typically CV or CD) contains code, codeSystem, displayName and originalText.
Coded Qualified (CD) contains code, codeSystem, displayName, originalText and qualifier.
Coded Translated (CE or CD) contains code, codeSystem, displayName, originalText and translation.
Coded Qualified and Translated (CD) contains code, codeSystem, displayName, originalText qualifier and translation.
| Attribute |
Details |
private Identifier codeSystemId |
|
Notes:
|
The defining code system.
|
Constraints: Timestamp precis YYYY
|
private dt_Coded translation |
Range:0 to *
|
Notes:
|
Additional codes that translate the primary code into other code systems.
|
|
private dt_Coded qualifier |
Range:0 to *
|
Notes:
|
Additional codes used to refine the meaning of the primary code.
|
|
private String codeSystemVersion |
Range:0 to 1
|
Notes:
|
The version of the code system.
|
|
private String codeSystemName |
Range:0 to 1
|
Notes:
|
The common name of the code system, e.g. SNOMED-CT
|
|