Skip Headers
Oracle® Clinical Interfacing from Oracle Clinical
Release 4.6

Part Number A83793-06
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Feedback page
Contact Us

Go to previous page
Go to next page
View PDF


This manual describes the tables, modules, and procedures included in the Data Capture API that administrators and developers use to interfacing external applications to the Oracle Clinical System.

Intended Audience

To interface with Oracle Clinical you need to be able to carry out the tasks listed below. If you lack the necessary skills, one alternative is to engage Oracle Consulting.

Oracle Database Administration

To install Oracle Clinical, you need a level of knowledge equivalent to what is taught in Oracle's DBA Architecture and Administration course. You must be able to read and edit SQL*Plus scripts. You will also be running SQL scripts and reviewing logs. For ongoing administration, additional DBA training is essential.

System Administration

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

To reach AT&T Customer Assistants, dial 711 or 1.800.855.2880. An AT&T Customer Assistant will relay information between the customer and Oracle Support Services at 1.800.223.1711. Complete instructions for using the AT&T relay services are available at After the AT&T Customer Assistant contacts Oracle Support Services, an Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process.

Related Documents

This section lists the manuals in the Oracle Clinical documentation set. You can order printed manuals from the Oracle iStore. From the iStore, search for the part number in parentheses. You can download PDF copies of the manuals from MetaLink using their MetaLink numbers. See "Checking My Oracle Support (MetaLink)" for details.

Oracle Clinical Documentation

The Oracle Clinical documentation set includes:

Oracle Clinical Remote Data Capture (RDC) Documentation

The Oracle RDC documentation includes:

In addition, Oracle Health Sciences (OHS) publishes PDF-format Technical Reference Manuals (TRMs) containing proprietary information on internal tables and APIs. If you are a licensed customer, contact Oracle Support to obtain a free electronic copy of the Oracle Clinical Stable Interface TRM (Part A83796).

About This Book

This manual contains six chapters and an appendix:

Chapter 1, "Customer-Defined Identifier Handling"

This chapter describes the OCL_CLIENT_PACK database package, which contains procedures that enable you to define your own object-naming validation for your Oracle Clinical installation.

Chapter 2, "Interface Configuration"

This chapter provides information about the areas in which Oracle Clinical interfaces with your company's applications. It also describes the Oracle Clinical tables and modules that support basic requirements in these areas.

Chapter 3, "Integration with External Systems"

This chapter describes how to integrate the Oracle Clinical data entry process with external workflow and imaging systems.

Chapter 4, "Data Capture API Overview"

This chapter shows how to use the Data Capture API (DCAPI), a set of functions that enable you to update data in Oracle Clinical.

Chapter 5, "DCAPI Structure Type Definitions"

This chapter shows each structure defined for DCAPI functions.

Chapter 6, "Data Capture API Functions"

This chapter describes each DCAPI function completely. For each function, the chapter includes a brief description, the function's syntax, parameters, return values, possible error messages, and any other relevant comments.

Chapter A, "Error Messages"

This appendix describes each error that can result from DCAPI functions, the cause of each error, and the action you should take.

Changes to the DCAPI for This Release

Since Oracle Clinical 4.5, DCAPI functions have changed to accommodate the following enhancements.

SetMiscDiscrepancy Function

This function sets the resolution text for an existing discrepancy with a current status.


The following text conventions are used in this document:

Convention Meaning
boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.