CDD
Purpose
Specifies the target of one mapped control in a CDD.
Syntax
<CDD
REFNAME="name"
[DESIGNNOTE="text"]
[ACTIVE="true|false"]
TARGETTABLE="name"
TARGETCOLUMN="name"
TARGETCOLUMNTYPE="NUMERIC|FLOAT|DATE|SPLITDATE|STRING|TEXT"
[TARGETCOLUMNMAXLENGTH="length"]
[TARGETKEYTYPE="PATIENT|PATIENTVISIT|PATIENTTOFORM|PATIENTTOSECTION|
PATIENTTOITEMSET|PATIENTTOITEM|PATIENTTOCONTROL|
PIVOTPATIENT|PIVOTVISIT|PIVOTFORM|PIVOTSECTION"
[PIVOTCOLUMN="true|false"]
[LABEL="string"]/>
Attributes
REFNAME="name"
RefName of the CDD. Required.
DESIGNNOTE="text"
Free-form text, with a maximum of 255 characters, containing any information you want to capture about the design of the component. This information is for documentation only and is not displayed. Optional.
ACTIVE="true|false"
Indicates whether the component is active. The options are true or false. True is the default. Optional.
TARGETTABLE="name"
Name of the target customer data table in which the mapped form item will be updated. The name must be 30 characters or fewer. Required.
TARGETCOLUMN="name"
Name of the column in the target customer data table in which the mapped form item will be added or updated. The name must be 25 characters or fewer. Required.
TARGETCOLUMNTYPE="NUMERIC|FLOAT|DATE|SPLITDATE|STRING|TEXT"
Type of data contained in the target column. Required.
The options are:
- NUMERIC
- FLOAT
- DATE— Data for a complete date and time field. Note that when you map a date and time field, the InForm software creates four columns:
- DATE—For a complete date and time.
- _DT suffix—For a date and time field with only date components.
- _TM suffix—For a date and time field with only time components.
- _STR suffix—For an incomplete date and time field.
- SPLITDATE—Data from a DateTime control, mapped to six columns, each containing one of the date or time components of the control. Each column has the generated or specified column name and the appropriate one of the following suffixes: _Day, _Mon, _Year, _Hour, _Min, or _Sec.
- STRING—Fewer than 255 characters.
- TEXT—Long varchar data.
Note: The TARGETCOLUMNTYPE attribute of a column that receives data from a multiple-selection control such as a checkbox control, must be set to STRING.
TARGETCOLUMNMAXLENGTH="length"
Maximum length of a target column with a TARGETCOLUMNTYPE=STRING. The column must be fewer than 255 characters. Optional.
TARGETKEYTYPE="PATIENT|PATIENTVISIT|PATIENTTOFORM|PATIENTTOSECTION|
PATIENTTOITEMSET|PATIENTTOITEM|PATIENTTOCONTROL|
PIVOTPATIENT|PIVOTVISIT|PIVOTFORM|PIVOTSECTION">
For the following key types, this specifies the composition of the primary key columns of the target table. Each time a component of the primary key changes from the previous submitted primary key, the InForm software inserts a new row in the target table. Primary keys consist of the following DBUIDs and indexes:
- PATIENT—PatientID, ItemsetIndex.
- PATIENTVISIT (default)—PatientID, VisitID, ItemsetIndex, and VisitIndex.
- PATIENTTOFORM—PatientID, VisitID, ItemsetIndex, VisitIndex, and FormID.
- PATIENTTOSECTION—PatientID, VisitID, ItemsetIndex, VisitIndex, FormID, and SectionID.
- PATIENTTOITEMSET—PatientID, VisitID, ItemsetIndex, VisitIndex, FormID, SectionID, and ItemsetID.
- PATIENTTOITEM—PatientID, VisitID, ItemsetIndex, VisitIndex, FormID, SectionID, ItemsetID, and ItemID.
- PATIENTTOCONTROL—PatientID, VisitID, ItemsetIndex, VisitIndex, FormID, SectionID, ItemsetID, ItemID and five ControlIDs. A target table with this key type also contains a data label that can be used for data selection.
For the following key types, the primary key columns are PatientID, VisitID, ItemsetIndex, VisitIndex, FormID, SectionID, ItemsetID, ItemID and five ControlIDs. The key type selection determines the composition of a pivot set (a group of columns in which one column is defined as the pivot column); within a pivot set, data elements mapped to non-pivot columns are repeated in each row. Target tables with these key types also contain a data label, specified as the value of the LABEL attribute, which can be used for data selection. Pivot set keys consist of the following DBUIDs and indexes:
- PIVOTPATIENT—PatientID and VisitIndex
- PIVOTVISIT—PatientID, VisitID, and VisitIndex
- PIVOTFORM—PatientID, VisitID, FormID, and VisitIndex
- PIVOTSECTION—PatientID, VisitID, FormID, SectionID, and VisitIndex
Note: A table that has mappings for controls within an itemset cannot have any of the pivot key types.
PIVOTCOLUMN="true|false"
Indicates whether the column specified in the TARGETCOLUMN attribute is a pivot column. The options are true or false. When the TARGETKEYTYPE is PIVOTPATIENT, PIVOTVISIT, PIVOTFORM, or PIVOTSECTION, data elements mapped to non-pivot columns are repeated in each row within a pivot set.
Note: The pivot column must be the first column in the table.
LABEL="string"
Text label for the data item, allowing access to an item in a target table with the PATIENTTOCONTROL or any of the PIVOT key types. The label must be 255 characters or fewer. Optional.
Example
The following example illustrates the use of the CDD element to map the DESCRIBETEXT control to a column in the CDD1 CDD.
<EXTERNALMAP>
<PATH>
<CHAPTERREF REFNAME="PF_ALL_VISITS"/>
<PAGEREF REFNAME="ECG"/>
<SECTIONREF REFNAME="CHESTXRAY"/>
<ITEMSETREF REFNAME="1"/>
<ITEMREF REFNAME="INTERPRET2"/>
<CONTROLREF REFNAME="INTERPRETRADIO2"/>
<CONTROLREF REFNAME="DESCRIBETEXT"/>
</PATH>
<CDD REFNAME="CDD1" KEYTYPE="PATIENT" TARGETTABLE="t_ECG"
TARGETKEYTYPE="PATIENTVISIT" TARGETCOLUMN="COMMONDAT1"
TARGETCOLUMNTYPE="TEXT"/>
</EXTERNALMAP>