A CodedValue is used in every case where data can be structured. They are either a catalog reference or part of an enumeration.
Description
Catalog references enable the structured analysis and comparison of different entries. Anyway it is possible to use the CodedValue to reference to a special catalog entry or to deposit only a free text description in case of no available catalog.
Use
A CodedValue is used in every case where structured data are possible.
– Available catalog – CGM LIFE catalog – External catalog – Completed list of entries / EnumerationsNot use
– For not completed lists – For freetextData Model
Name | Type | M | Description | Example |
catalogName | String | 2 | The official name of the catalog. | “communicationtype_EMAIL_1“ |
catalogVersion | String | The used version of catalog. | “1” | |
catalogOid | String | The Oid of catalog if a CGM LIFE catalog is used. | “communicationtype_EMAIL_1“ | |
code | String | 2 | The code provided by referenced catalog. | “EMAIL” |
codeText | String | 2 | The text dedicated to the catalog code. | “Mail” |
description | String | 1 | A list entry or the code and codeText from the catalog. | “Mail” |
Rules
- As a basic principle every CodedValue needs to have a description.
- In case of an available catalog, the catalogName, the code and the codeText needs to be recorded.