30 Codelists

This is a public interface for all operations related to codelists, including creation, deletion, modification, and checking in and out of these objects.

30.1 Create and Modify Codelists

This section contains the following public APIs in package DME_PUB_CODE_LISTS:

Section 29.1.1, "Create a Study Clinical Data Model"
Section 29.1.3, "Modify a Model's Name and Description"
Section 30.1.3, "Remove a Codelist"
Section 30.1.4, "Check In a Codelist"
Section 30.1.5, "Check Out a Codelist"
Section 30.1.6, "Add Values to a Codelist"
Section 30.1.7, "Remove Values from a Codelist"
Section 30.1.8, "Get Codelist Details for a Given Column"

30.1.1 Create a Codelist

Use this API to create a codelist under a library domain. Codelists created with this API can be verified through public view 'DME_PUB_CODELIST_V'. For values refer 'DME_PUB_CODELIST_VALUES_V'.

Name DME_PUB_CODE_LISTS.CreateCodeList

Signature

PROCEDURE CREATECODELIST
(P_API_VERSION      IN NUMBER,   
P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,
P_CODELISTCOLL     IN CDR_CODE_LIST_COLL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY     NUMBER,
X_MSG_DATA OUT NOCOPY      VARCHAR2,
  );

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. For OBJECT_TYPE_RC enter '$OBJTYPES$CODELIST'.
P_CODELISTCOLL (Optional). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:
```
CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');
```

30.1.2 Modify a Codelist

Use this API to modify the naming attributes of a codelist. Codelists modified with this API can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.ModifyCodeList

Signature

PROCEDURE MODIFYCODELIST
(P_API_VERSION      IN NUMBER,
P_INIT_MSG_LIST     IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_COMMIT            IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,
P_VALIDATION_LEVEL  IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,
P_NAMING            IN OUT NOCOPY CDR_NAMING_VERSION_OBJ_TYPE,
X_RETURN_STATUS     OUT NOCOPY VARCHAR2,
X_MSG_COUNT         OUT NOCOPY NUMBER,
X_MSG_DATA          OUT NOCOPY VARCHAR2,
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameter:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the codelist whose code-value pairs you are modifying and the new attribute values, such as Name and Description. To get naming version attribute values see "Get a Naming Version Object".

30.1.3 Remove a Codelist

Use this API to remove a codelist. After this API is executed, public view 'DME_PUB_CODELIST_V' will not display the codelist.

Name DME_PUB_CODE_LISTS.RemoveCodeList

Signature

PROCEDURE REMOVECODELIST
  (P_API_VERSION      IN NUMBER ,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the codelist from which the code-value pairs have to be removed.

30.1.4 Check In a Codelist

Use this API to check in a codelist. Changed status can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.CheckinCodeList

Signature

PROCEDURE CHECKINCODELIST
  (P_API_VERSION      IN NUMBER,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    p_commit           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    p_validation_level IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    p_naming           IN OUT NOCOPY cdr_naming_version_obj_type,    x_return_status OUT NOCOPY VARCHAR2,    x_msg_count OUT NOCOPY     NUMBER,    x_msg_data OUT NOCOPY      VARCHAR2
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameter:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the codelist you are checking in.

30.1.5 Check Out a Codelist

Use this API to check out a codelist. Changed status can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.CheckoutCodeList

Signature

PROCEDURE CHECKOUTCODELIST
  ( P_API_VERSION      IN NUMBER ,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2)
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameter:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the codelist you are checking out.

30.1.6 Add Values to a Codelist

Use this API to add code value pairs to a codelist. Codelist values created with this API can be verified through public view 'DME_PUB_CODELIST_VALUES_V'.

Name DME_PUB_CODE_LISTS.AddCodeListValues

Signature

PROCEDURE ADDCODELISTVALUES
  (P_API_VERSION      IN NUMBER ,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type ,    P_CODELISTCOLL     IN CDR_CODE_LIST_COLL ,    X_RETURN_STATUS OUT NOCOPY VARCHAR2 ,    X_MSG_COUNT OUT NOCOPY     NUMBER ,    X_MSG_DATA OUT NOCOPY      VARCHAR2)
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the codelist to which you are added code-value pairs.
P_CODELISTCOLL (Mandatory). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:

CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');

30.1.7 Remove Values from a Codelist

Use this API to remove code value pairs to a codelist. After this API is executed, public view 'DME_PUB_CODELIST_V' will not display the codelist values.

Name DME_PUB_CODE_LISTS.AddCodeListValues

Signature

PROCEDURE REMOVECODELISTVALUES
  (P_API_VERSION      IN NUMBER,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    P_CODELISTCOLL     IN CDR_CODE_LIST_COLL,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE. Whole naming object needs to be populated for the object which needs code values to be added to it. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object.
P_CODELISTCOLL (Mandatory). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:
```
CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');
```

30.1.8 Get Codelist Details for a Given Column

Use this API to get the codelist details for a given column.

Name DME_PUB_CODE_LISTS. getCodeListDetail

Signature

PROCEDURE GETCODELISTDETAIL
  (P_API_VERSION      IN NUMBER ,    P_INIT_MSG_LIST    IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_COMMIT           IN VARCHAR2 DEFAULT CDR_PUB_DEF_CONSTANTS.G_FALSE,    P_VALIDATION_LEVEL IN NUMBER DEFAULT CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL,    X_RETURN_STATUS OUT NOCOPY VARCHAR2 ,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2,    PI_COLCOMPANYID    IN cdr_naming_versions.company_id%type,    PI_COLOBJID        IN cdr_naming_versions.obj_id%type,    PI_COLOBJVER       IN cdr_naming_versions.obj_ver%type,    PO_CODELISTID      OUT NOCOPY cdr_naming_versions.obj_id%type,    PO_CODELISTVER     OUT NOCOPY cdr_naming_versions.obj_Ver%type
);

Parameters This API has standard parameters (see "Standard Parameters") as well as the following parameters:

PI_COLCOMPANYID (Mandatory). COMPANY_ID of a Column.
PI_COLOBJID (Mandatory). Object Identifier of a Column
PI_COLOBJVER (Mandatory). Object Version of a Column
PO_CODELISTID This is out parameter. It returns the Object Id of associated codelist.
PO_CODELISTVER This is out parameter. It returns the Object Version of associated codelist.