CreateRdci

Creates a new Received DCI for a patient.

Syntax

short int CreateRdci(RdciKeysRecord *rdci_keys_rec,
     int rdcirdcm_mode,
     RdciRecord *rdci_rec );

Parameters

rdci_keys_rec (in) A structure of type RdciKeysRecord containing the key values of the API RDCI record to be created.

rdcirdcm_mode (in) The mode to be used for executing this function. It also stays in effect as the RDCIRDCM mode up to the next call of either CreateRdci or FetchRdci. Values are INITIAL_LOGIN or KEY_CHANGES.

rdci_rec (out) A structure of type RdciRecord that the function fills in with the content of the created API RDCI record.

Return Value

SUCCESS or FAILURE or WARNING.

Comments

The function creates an RDCI record in the API RDCI buffer using the keys passed in, and returns the contents of the API RDCI record created. The component items of an API RDCI record that are not component items of rdci_keys_rec, such as all the numeric ID items, are implicitly assigned by this function. You use this function to:

1. Flush the RDCIRDCM buffer.
2. Validate each individual non-null item passed in rdci_keys_rec.

   All of these items must pass validation in order for the creation to take place; otherwise no creation takes place and the function returns FAILURE. The RDCI-RDCM buffer will still be empty as a result of the flush.

You use SetRdci to:

• assign values to the items of API RDCI record that are not assigned by CreateRdci.
• change the values of the items assigned by CreateRdci.

Error Messages

Table 7-3 Error Messages for CreateRdci

Number	Severity	Message
284900	ERR	User does not have the privilege to call function in the current mode.
285000	ERR	Function called out of sequence.
285900	ERR	No current OCL database connection open. Use ConnectOCL to connect to OCL database.
286600	ERR	Audit reason required and not provided.
289800	ERR	This document already exists in the database.
290500	ERR	This site/investigator pair is invalid for study.
290600	ERR	Invalid investigator.
290700	ERR	Invalid site.
290800	ERR	Patient position is frozen.
290900	WRN	Patient not enrolled for this study.
291000	ERR	Patient position is invalid.
291200	ERR	DCI is inactive or invalid.
291300	ERR	[error message returned by OCL_CLIENT_PACK. Validate document]
291400	ERR	Clinical planned event is invalid for the current study.
294600	ERR	Document found in different study. Change study to access.
294900	WRN	Site is currently inactive.
295000	WRN	Investigator is currently inactive.
296600	ERR	Cannot preserve a lock when performing a rollback.
297000	ERR	Null or invalid input pointers provided.
297100	ERR	Changes pending.
299000	ERR	Only browse mode can be performed on a frozen study.
299700	WRN	The data entered for this received DCI will be deleted.
299800	ERR	Date cannot exceed today's date.
304600	ERR	Function does not exist.
304700	ERR	Privilege does not exist.
305600	ERR	Invalid DCI date.
305700	ERR	Invalid DCI time.
308700	ERR	Cannot set RDCI time until RDCI short name is set.
308800	ERR	DCI short name is not applicable.
309100	ERR	Document number is not applicable.
309200	ERR	Patient is not applicable.
309400	ERR	Date is not applicable.
309600	ERR	Time is not applicable.
309800	ERR	Visit name is not applicable.
310000	ERR	Subevent number is not applicable.
310200	ERR	Site is not applicable.
310400	ERR	Investigator is not applicable.
310600	ERR	Blank flag is not applicable.
310800	ERR	Comment is not applicable.
311600	ERR	DCI document number can not be updated to null.
311700	ERR	Document number must not have any lower case.

Related Functions

SetRdci, GetRdci, ProcessRdci, FetchRdci, WriteRdciRdcm