CDA API Guide

Automatic Install

Our collection of CDA modules provides a wide variety of functions and lookup tables that you can use to build and customize your CDA document. We’ve also included extensive auto-completion support to help you develop your code correctly.

The following table is a quick snap-shot of the modules and functions that you can use in your CDA scripts. For more information about a module, simply click its name in the first column:

CDA Module Function Definition
cda cda.new Create an empty CDA document
cda.code cda.code.add
Identify a specific concept by its associated code and code system
cda.code.set Update an existing code element
cda.code.originalText.add Add a text element to an existing code element
cda.codeset cda.codeset.xxx Look up a code based on its corresponding description
cda.codeset.xxx.reverse Look up a description based on its corresponding code
cda.code.simple cda.code.simple.add Add a code that implies its own code system
cda.code.simple.set Update an exisiting simple code element
cda.demographic.name cda.demographic.name.add Add a full name to your document (first, last, prefix, etc.)
cda.demographic.name.simple.add Add a name consisting of a simple string
cda.demographic.address cda.demographic.address.add Add an address to your document
cda.demographic.phone cda.demographic.phone.add Add a phone number to your document
cda.dose cda.dose.add Add medical dosage information to your document
cda.help cda.help.set Set the help for a module function
cda.help.check Check the help parameters for a module function
cda.id
cda.id.add
Identify a RIM class
cda.id.template.add
Identify a CDA template
cda.null cda.null.set Provide a specific reason for the absence of required data
cda.time cda.time.add Add a time value to your document
cda.time.set Update a time value in your document
cda.timerange.add

Add a time range to your document

cda.timeperiod.add Add a time period to your document
cda.value cda.value.add Add a measured value to your document
cda.valuerange.add Add a range value to your document
cda.valuestring.add Add a string value to your document
cda.xml node.setText Set an XML TEXT element
node.setAttr Set an XML attribute
node.addElement Append an empty XML element
xml.findElement Find an XML element

As you can see in the table above, several functions come in two flavours: “add” and “set”. The difference is fairly straightforward:

  • .add functions create a new XML element under the root element identified by the function’s ‘target’ argument
  • .set functions simply update an existing element that you’ve identified with the function’s ‘target’ argument

Leave A Comment?