Deriving Company-Specific Document Numbers
The following table describes the purpose, parameters, return value, and default logic for the DeriveDocumentNumber function:
- Function Name: DeriveDocumentNumber
- Purpose: Derives an identification number
from the key fields of the document. Modify the
code according to your business rules. For
example, you may want to make the site number part
of the document number.
The DeriveDocumentNumber function serves the same purpose as the DeriveDocumentNumber function in the Oracle Clinical package. If you customized code for the Oracle Clinical package, you can copy and paste that code into the RDC Client package.
- Parameters:
study
(in varchar2) — Denotes the name of the study.clinical_study_id
(in number) — Denotes the ID number of the study.patient
(in varchar2) — Denotes the code name (external identifier) of the patient.patient_position_id
(in number) — Denotes the position number of the patient.investigator
(in varchar2) — Denotes the code name of the investigator.investigator_id
(in number) — Denotes the ID number of the investigator.site
(in varchar2) — Denotes the code name of the site.site_id
(in number) — Denotes the ID number of the site.DCI
(in varchar2) — Denotes the name of the data collection instrument (DCI).dci_id
(in number) — Denotes the ID number of the DCI.event
(in varchar2) — Denotes the name of the clinical planned event.clin_plan_eve_id
(in number) — Denotes the ID number of the clinical planned event.subevent
(in number) — Denotes the ID number of a subtype of the planned event.rxc_env_type
(in varchar2) — Denotes the environment type, where T indicates Test mode and P indicates Production mode.
- Return Value: Returns the ID number as a varchar2. The default is a system-generated sequence number.
- Default Logic: Returns R concatenated to the next value from sequence Received_dci_seq2.
Parent topic: Working with the RDC Client Package