Record Definitions

A dynamic record definition is very much like a table definition; what are the column names? how many columns? what goes into a column? \Each record field usage represents a column in the record. The content of the field can either be bound by a specific code set (e.g. a procedure code) or can be free (e.g. a date or a remark field).

A dynamic record definition defines what records belonging to that definition should look like; in order to extend an entity with dynamic records a dynamic record usage must be configured. The configuration of dynamic record usages is described in Extending Tables; this chapter focuses on the record definition.

Dynamic records come in two flavours; dynamic records used to extend the claims transactions and external claims data and dynamic records used to extend claims, configuration and reference data. The difference is that the first never validates column values against a domain or regular expression; the second does. Dynamic records on claim transactions and external claims data are meant to store a true copy of whatever information is provided and column value validation obstructs that goal.

On the other hand, dynamic records on claims and reference data (such as members and providers) do need to be validated. This chapter describes the definition of validated dynamic records. A validated dynamic record definition has the following attributes:

Field	Description
Code	The unique identifier of the dynamic record definition
Description	The description visible in e.g. pull down menus
Reference Sheet?	Is the dynamic record definition to be used by a reference sheet?

Record Field Usages define the columns in a dynamic record. A record field usage has the following attributes:

Field	Description
Name	The unique column name (within the record) in the object model
Field	Specifies the date type, length, decimals and other applicable validations
Code Definition	Specifies the domain of allowable values
Display Name	The column header for the field when the record is displayed in a table view
Sequence	The default column position when the record displayed in table view
Key?	The key field of this record. A key field must have a unique value for all records. For time valid records, the key field must have a unique value at any point in time
Mandatory?	The column must have a value
PII?	The field contains Personal Identifiable Information (PII)
Table	Specifies the table that can be used as a pick list when inserting values through the UI.

A record field usage specifies either a field or a code definition. The code definition is either a single flex code definition or a flex code set. Only one of the record field usages under a record definition can represent the key value. If the usage represents the key value, it must specify a free field (and not a code definition).