Address

CaCORE::CaDSR::Address - Perl extension for Address.

ABSTRACT

The CaCORE::CaDSR::Address is a Perl object representation of the CaCORE Address object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of Address

The following are all the attributes of the Address object and their data types:

addressLine1

data type: string

addressLine2

data type: string

city

data type: string

country

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

postalCode

data type: string

rank

data type: int

state

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Address

The following are all the objects that are associated with the Address:

Collection of Organization:

Many to one assoication, use getOrganization to get the associated Organization.

Collection of Person:

Many to one assoication, use getPerson to get the associated Person.


AdministeredComponent

CaCORE::CaDSR::AdministeredComponent - Perl extension for AdministeredComponent.

ABSTRACT

The CaCORE::CaDSR::AdministeredComponent is a Perl object representation of the CaCORE AdministeredComponent object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A component for which attributes (or characteristics) are collected; Data Elements are one type of administered component. Other administered components have relationships to data elements as well as each other.

ATTRIBUTES of AdministeredComponent

The following are all the attributes of the AdministeredComponent object and their data types:

beginDate

data type: dateTime

changeNote

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

deletedIndicator

data type: string

endDate

data type: dateTime

id

data type: string

latestVersionIndicator

data type: string

longName

data type: string

modifiedBy

data type: string

origin

data type: string

preferredDefinition

data type: string

preferredName

data type: string

publicID

data type: long

registrationStatus

data type: string

unresolvedIssue

data type: string

version

data type: float

workflowStatusDescription

data type: string

workflowStatusName

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of AdministeredComponent

The following are all the objects that are associated with the AdministeredComponent:

Instance of AdministeredComponentClassSchemeItem:

One to many assoication, use getAdministeredComponentClassSchemeItemCollection to get a collection of associated AdministeredComponentClassSchemeItem.

Instance of AdministeredComponentContact:

One to many assoication, use getAdministeredComponentContactCollection to get a collection of associated AdministeredComponentContact.

Collection of Context:

Many to one assoication, use getContext to get the associated Context.

Instance of Definition:

One to many assoication, use getDefinitionCollection to get a collection of associated Definition.

Instance of Designation:

One to many assoication, use getDesignationCollection to get a collection of associated Designation.

Instance of ReferenceDocument:

One to many assoication, use getReferenceDocumentCollection to get a collection of associated ReferenceDocument.


AdministeredComponentClassSchemeItem

CaCORE::CaDSR::AdministeredComponentClassSchemeItem - Perl extension for AdministeredComponentClassSchemeItem.

ABSTRACT

The CaCORE::CaDSR::AdministeredComponentClassSchemeItem is a Perl object representation of the CaCORE AdministeredComponentClassSchemeItem object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A class that serves to allow many to many relationships between Administered Component and ClassSchemeClassSchemeItem, providing uniqueness to the CS/CSI pairing to an AC.

ATTRIBUTES of AdministeredComponentClassSchemeItem

The following are all the attributes of the AdministeredComponentClassSchemeItem object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of AdministeredComponentClassSchemeItem

The following are all the objects that are associated with the AdministeredComponentClassSchemeItem:

Collection of ClassSchemeClassSchemeItem:

Many to one assoication, use getClassSchemeClassSchemeItem to get the associated ClassSchemeClassSchemeItem.


AdministeredComponentContact

CaCORE::CaDSR::AdministeredComponentContact - Perl extension for AdministeredComponentContact.

ABSTRACT

The CaCORE::CaDSR::AdministeredComponentContact is a Perl object representation of the CaCORE AdministeredComponentContact object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of AdministeredComponentContact

The following are all the attributes of the AdministeredComponentContact object and their data types:

contactRole

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

rank

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of AdministeredComponentContact

The following are all the objects that are associated with the AdministeredComponentContact:

Collection of ClassSchemeClassSchemeItem:

Many to one assoication, use getClassSchemeClassSchemeItem to get the associated ClassSchemeClassSchemeItem.

Collection of ClassificationSchemeItem:

Many to one assoication, use getClassificationSchemeItem to get the associated ClassificationSchemeItem.

Collection of Organization:

Many to one assoication, use getOrganization to get the associated Organization.

Collection of Person:

Many to one assoication, use getPerson to get the associated Person.


ClassSchemeClassSchemeItem

CaCORE::CaDSR::ClassSchemeClassSchemeItem - Perl extension for ClassSchemeClassSchemeItem.

ABSTRACT

The CaCORE::CaDSR::ClassSchemeClassSchemeItem is a Perl object representation of the CaCORE ClassSchemeClassSchemeItem object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Information pertaining to the association between Classification Schemes and Classification Scheme Items. This information is used to get all Classification Scheme Items that belong to a particular Classification Scheme as well as the information about t

ATTRIBUTES of ClassSchemeClassSchemeItem

The following are all the attributes of the ClassSchemeClassSchemeItem object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

displayOrder

data type: int

id

data type: string

modifiedBy

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ClassSchemeClassSchemeItem

The following are all the objects that are associated with the ClassSchemeClassSchemeItem:

Instance of AdministeredComponentClassSchemeItem:

One to many assoication, use getAdministeredComponentClassSchemeItemCollection to get a collection of associated AdministeredComponentClassSchemeItem.

Instance of AdministeredComponentContact:

One to many assoication, use getAdministeredComponentContactCollection to get a collection of associated AdministeredComponentContact.

Instance of ChildClassSchemeClassSchemeItem:

One to many assoication, use getChildClassSchemeClassSchemeItemCollection to get a collection of associated ChildClassSchemeClassSchemeItem.

Collection of ClassificationScheme:

Many to one assoication, use getClassificationScheme to get the associated ClassificationScheme.

Collection of ClassificationSchemeItem:

Many to one assoication, use getClassificationSchemeItem to get the associated ClassificationSchemeItem.

Instance of DefinitionClassSchemeItem:

One to many assoication, use getDefinitionClassSchemeItemCollection to get a collection of associated DefinitionClassSchemeItem.

Instance of DesignationClassSchemeItem:

One to many assoication, use getDesignationClassSchemeItemCollection to get a collection of associated DesignationClassSchemeItem.

Collection of ParentClassSchemeClassSchemeItem:

Many to one assoication, use getParentClassSchemeClassSchemeItem to get the associated ParentClassSchemeClassSchemeItem.

Instance of ReferenceDocument:

One to many assoication, use getReferenceDocumentCollection to get a collection of associated ReferenceDocument.


ClassificationScheme

CaCORE::CaDSR::ClassificationScheme - Perl extension for ClassificationScheme.

ABSTRACT

The CaCORE::CaDSR::ClassificationScheme is a Perl object representation of the CaCORE ClassificationScheme object.

ClassificationScheme extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

An arrangement or division of objects into groups based on characteristics that the objects have in common, e.g., origin, composition, structure, application, function, etc. Adds information not easily included in definitions, helps organize the registry and facilitates access to the registry. ISO DEF: the descriptive information for an arrangement or division of objects into groups based on characterisitics, which the objects have in common.

ATTRIBUTES of ClassificationScheme

The following are all the attributes of the ClassificationScheme object and their data types:

labelTypeFlag

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ClassificationScheme

The following are all the objects that are associated with the ClassificationScheme:

Instance of ChildClassificationSchemeRelationship:

One to many assoication, use getChildClassificationSchemeRelationshipCollection to get a collection of associated ChildClassificationSchemeRelationship.

Instance of ClassSchemeClassSchemeItem:

One to many assoication, use getClassSchemeClassSchemeItemCollection to get a collection of associated ClassSchemeClassSchemeItem.

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of ParentClassificationSchemeRelationship:

One to many assoication, use getParentClassificationSchemeRelationshipCollection to get a collection of associated ParentClassificationSchemeRelationship.


ClassificationSchemeItem

CaCORE::CaDSR::ClassificationSchemeItem - Perl extension for ClassificationSchemeItem.

ABSTRACT

The CaCORE::CaDSR::ClassificationSchemeItem is a Perl object representation of the CaCORE ClassificationSchemeItem object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A component of content in a Classification Scheme. This may be a node in a taxonomy or ontology or a term in a thesaurus, etc.

ATTRIBUTES of ClassificationSchemeItem

The following are all the attributes of the ClassificationSchemeItem object and their data types:

comments

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

description

data type: string

id

data type: string

modifiedBy

data type: string

name

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ClassificationSchemeItem

The following are all the objects that are associated with the ClassificationSchemeItem:

Instance of AdministeredComponentContact:

One to many assoication, use getAdministeredComponentContactCollection to get a collection of associated AdministeredComponentContact.

Instance of ChildClassificationSchemeItemRelationship:

One to many assoication, use getChildClassificationSchemeItemRelationshipCollection to get a collection of associated ChildClassificationSchemeItemRelationship.

Instance of ClassSchemeClassSchemeItem:

One to many assoication, use getClassSchemeClassSchemeItemCollection to get a collection of associated ClassSchemeClassSchemeItem.

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of ParentClassificationSchemeItemRelationship:

One to many assoication, use getParentClassificationSchemeItemRelationshipCollection to get a collection of associated ParentClassificationSchemeItemRelationship.

Instance of ReferenceDocument:

One to many assoication, use getReferenceDocumentCollection to get a collection of associated ReferenceDocument.


ClassificationSchemeItemRelationship

CaCORE::CaDSR::ClassificationSchemeItemRelationship - Perl extension for ClassificationSchemeItemRelationship.

ABSTRACT

The CaCORE::CaDSR::ClassificationSchemeItemRelationship is a Perl object representation of the CaCORE ClassificationSchemeItemRelationship object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The affiliation between two occurrences of Classification Scheme Items.

ATTRIBUTES of ClassificationSchemeItemRelationship

The following are all the attributes of the ClassificationSchemeItemRelationship object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ClassificationSchemeItemRelationship

The following are all the objects that are associated with the ClassificationSchemeItemRelationship:

Collection of ChildClassificationSchemeItem:

Many to one assoication, use getChildClassificationSchemeItem to get the associated ChildClassificationSchemeItem.

Collection of ParentClassificationSchemeItem:

Many to one assoication, use getParentClassificationSchemeItem to get the associated ParentClassificationSchemeItem.


ClassificationSchemeRelationship

CaCORE::CaDSR::ClassificationSchemeRelationship - Perl extension for ClassificationSchemeRelationship.

ABSTRACT

The CaCORE::CaDSR::ClassificationSchemeRelationship is a Perl object representation of the CaCORE ClassificationSchemeRelationship object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The affiliation between two occurrences of Classification Schemes.

ATTRIBUTES of ClassificationSchemeRelationship

The following are all the attributes of the ClassificationSchemeRelationship object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

displayOrder

data type: int

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ClassificationSchemeRelationship

The following are all the objects that are associated with the ClassificationSchemeRelationship:

Collection of ChildClassificationScheme:

Many to one assoication, use getChildClassificationScheme to get the associated ChildClassificationScheme.

Collection of ParentClassificationScheme:

Many to one assoication, use getParentClassificationScheme to get the associated ParentClassificationScheme.


ComponentConcept

CaCORE::CaDSR::ComponentConcept - Perl extension for ComponentConcept.

ABSTRACT

The CaCORE::CaDSR::ComponentConcept is a Perl object representation of the CaCORE ComponentConcept object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The concept component(s) used for a concept derivation

ATTRIBUTES of ComponentConcept

The following are all the attributes of the ComponentConcept object and their data types:

displayOrder

data type: int

id

data type: string

primaryFlag

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ComponentConcept

The following are all the objects that are associated with the ComponentConcept:

Collection of Componentlevel:

Many to one assoication, use getComponentlevel to get the associated Componentlevel.

Collection of Concept:

Many to one assoication, use getConcept to get the associated Concept.

Collection of DerivationRule:

Many to one assoication, use getDerivationRule to get the associated DerivationRule.


ComponentLevel

CaCORE::CaDSR::ComponentLevel - Perl extension for ComponentLevel.

ABSTRACT

The CaCORE::CaDSR::ComponentLevel is a Perl object representation of the CaCORE ComponentLevel object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of ComponentLevel

The following are all the attributes of the ComponentLevel object and their data types:

concatenationString

data type: string

id

data type: string

level

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ComponentLevel

The following are all the objects that are associated with the ComponentLevel:


Concept

CaCORE::CaDSR::Concept - Perl extension for Concept.

ABSTRACT

The CaCORE::CaDSR::Concept is a Perl object representation of the CaCORE Concept object.

Concept extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The concept for an administered component

ATTRIBUTES of Concept

The following are all the attributes of the Concept object and their data types:

definitionSource

data type: string

evsSource

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Concept

The following are all the objects that are associated with the Concept:

Instance of ComponentConcept:

One to many assoication, use getComponentConceptCollection to get a collection of associated ComponentConcept.

Instance of ValueDomainPermissibleValue:

One to many assoication, use getValueDomainPermissibleValueCollection to get a collection of associated ValueDomainPermissibleValue.


ConceptDerivationRule

CaCORE::CaDSR::ConceptDerivationRule - Perl extension for ConceptDerivationRule.

ABSTRACT

The CaCORE::CaDSR::ConceptDerivationRule is a Perl object representation of the CaCORE ConceptDerivationRule object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The derivation rule between one or more concepts.

ATTRIBUTES of ConceptDerivationRule

The following are all the attributes of the ConceptDerivationRule object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ConceptDerivationRule

The following are all the objects that are associated with the ConceptDerivationRule:

Instance of ClassificationScheme:

One to many assoication, use getClassificationSchemeCollection to get a collection of associated ClassificationScheme.

Instance of ClassificationSchemeItem:

One to many assoication, use getClassificationSchemeItemCollection to get a collection of associated ClassificationSchemeItem.

Instance of ComponentConcept:

One to many assoication, use getComponentConceptCollection to get a collection of associated ComponentConcept.

Instance of ConceptualDomain:

One to many assoication, use getConceptualDomainCollection to get a collection of associated ConceptualDomain.

Collection of DerivationType:

Many to one assoication, use getDerivationType to get the associated DerivationType.

Instance of ObjectClass:

One to many assoication, use getObjectClassCollection to get a collection of associated ObjectClass.

Instance of Property:

One to many assoication, use getPropertyCollection to get a collection of associated Property.

Instance of Representation:

One to many assoication, use getRepresentationCollection to get a collection of associated Representation.

Instance of ValueDomain:

One to many assoication, use getValueDomainCollection to get a collection of associated ValueDomain.

Instance of ValueMeaning:

One to many assoication, use getValueMeaningCollection to get a collection of associated ValueMeaning.


ConceptualDomain

CaCORE::CaDSR::ConceptualDomain - Perl extension for ConceptualDomain.

ABSTRACT

The CaCORE::CaDSR::ConceptualDomain is a Perl object representation of the CaCORE ConceptualDomain object.

ConceptualDomain extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The set of all possible Valid Value meanings of a Data Element Concept expressed without representation.

ATTRIBUTES of ConceptualDomain

The following are all the attributes of the ConceptualDomain object and their data types:

dimensionality

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ConceptualDomain

The following are all the objects that are associated with the ConceptualDomain:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of DataElementConcept:

One to many assoication, use getDataElementConceptCollection to get a collection of associated DataElementConcept.

Instance of ValueDomain:

One to many assoication, use getValueDomainCollection to get a collection of associated ValueDomain.

Instance of ValueMeaning:

One to many assoication, use getValueMeaningCollection to get a collection of associated ValueMeaning.


Context

CaCORE::CaDSR::Context - Perl extension for Context.

ABSTRACT

The CaCORE::CaDSR::Context is a Perl object representation of the CaCORE Context object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A designation or description of the application environment or discipline in which a name is applied or from which it originates.

ATTRIBUTES of Context

The following are all the attributes of the Context object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

description

data type: string

id

data type: string

languageName

data type: string

modifiedBy

data type: string

name

data type: string

version

data type: float

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Context

The following are all the objects that are associated with the Context:

Instance of AdministeredComponent:

One to many assoication, use getAdministeredComponentCollection to get a collection of associated AdministeredComponent.

Instance of Definition:

One to many assoication, use getDefinitionCollection to get a collection of associated Definition.

Instance of Designation:

One to many assoication, use getDesignationCollection to get a collection of associated Designation.

Instance of ReferenceDocument:

One to many assoication, use getReferenceDocumentCollection to get a collection of associated ReferenceDocument.


DataElement

CaCORE::CaDSR::DataElement - Perl extension for DataElement.

ABSTRACT

The CaCORE::CaDSR::DataElement is a Perl object representation of the CaCORE DataElement object.

DataElement extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A unit of data for which the definition, identification, representation and permissible values are specified by means of a set of attributes.

ATTRIBUTES of DataElement

The following are all the attributes of the DataElement object and their data types:

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DataElement

The following are all the objects that are associated with the DataElement:

Instance of ChildDataElementRelationships:

One to many assoication, use getChildDataElementRelationshipsCollection to get a collection of associated ChildDataElementRelationships.

Collection of DataElementConcept:

Many to one assoication, use getDataElementConcept to get the associated DataElementConcept.

Instance of DataElementDerivation:

One to many assoication, use getDataElementDerivationCollection to get a collection of associated DataElementDerivation.

Collection of DerivedDataElement:

Many to one assoication, use getDerivedDataElement to get the associated DerivedDataElement.

Instance of ParentDataElementRelationships:

One to many assoication, use getParentDataElementRelationshipsCollection to get a collection of associated ParentDataElementRelationships.

Instance of Question:

One to many assoication, use getQuestionCollection to get a collection of associated Question.

Collection of ValueDomain:

Many to one assoication, use getValueDomain to get the associated ValueDomain.


DataElementConcept

CaCORE::CaDSR::DataElementConcept - Perl extension for DataElementConcept.

ABSTRACT

The CaCORE::CaDSR::DataElementConcept is a Perl object representation of the CaCORE DataElementConcept object.

DataElementConcept extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A concept that can be represented in the form of a data element, described independently of any particular representation.

ATTRIBUTES of DataElementConcept

The following are all the attributes of the DataElementConcept object and their data types:

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DataElementConcept

The following are all the objects that are associated with the DataElementConcept:

Instance of ChildDataElementConceptRelationship:

One to many assoication, use getChildDataElementConceptRelationshipCollection to get a collection of associated ChildDataElementConceptRelationship.

Collection of ConceptualDomain:

Many to one assoication, use getConceptualDomain to get the associated ConceptualDomain.

Instance of DataElement:

One to many assoication, use getDataElementCollection to get a collection of associated DataElement.

Collection of ObjectClass:

Many to one assoication, use getObjectClass to get the associated ObjectClass.

Instance of ParentDataElementConceptRelationship:

One to many assoication, use getParentDataElementConceptRelationshipCollection to get a collection of associated ParentDataElementConceptRelationship.

Collection of Property:

Many to one assoication, use getProperty to get the associated Property.


DataElementConceptRelationship

CaCORE::CaDSR::DataElementConceptRelationship - Perl extension for DataElementConceptRelationship.

ABSTRACT

The CaCORE::CaDSR::DataElementConceptRelationship is a Perl object representation of the CaCORE DataElementConceptRelationship object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A description of the affiliation between two occurrences of Data Element Concepts.

ATTRIBUTES of DataElementConceptRelationship

The following are all the attributes of the DataElementConceptRelationship object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

description

data type: string

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DataElementConceptRelationship

The following are all the objects that are associated with the DataElementConceptRelationship:

Collection of ChildDataElementConcept:

Many to one assoication, use getChildDataElementConcept to get the associated ChildDataElementConcept.

Collection of ParentDataElementConcept:

Many to one assoication, use getParentDataElementConcept to get the associated ParentDataElementConcept.


DataElementDerivation

CaCORE::CaDSR::DataElementDerivation - Perl extension for DataElementDerivation.

ABSTRACT

The CaCORE::CaDSR::DataElementDerivation is a Perl object representation of the CaCORE DataElementDerivation object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The data element component(s) used for a derived data element.

ATTRIBUTES of DataElementDerivation

The following are all the attributes of the DataElementDerivation object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

displayOrder

data type: int

id

data type: string

leadingCharacters

data type: string

modifiedBy

data type: string

trailingCharacters

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DataElementDerivation

The following are all the objects that are associated with the DataElementDerivation:

Collection of DataElement:

Many to one assoication, use getDataElement to get the associated DataElement.

Collection of DerivedDataElement:

Many to one assoication, use getDerivedDataElement to get the associated DerivedDataElement.

Collection of LeftOperand:

Many to one assoication, use getLeftOperand to get the associated LeftOperand.


DataElementRelationship

CaCORE::CaDSR::DataElementRelationship - Perl extension for DataElementRelationship.

ABSTRACT

The CaCORE::CaDSR::DataElementRelationship is a Perl object representation of the CaCORE DataElementRelationship object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The affiliation between two occurrences of Data Elements.

ATTRIBUTES of DataElementRelationship

The following are all the attributes of the DataElementRelationship object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DataElementRelationship

The following are all the objects that are associated with the DataElementRelationship:

Collection of ChildDataElement:

Many to one assoication, use getChildDataElement to get the associated ChildDataElement.

Collection of ParentDataElement:

Many to one assoication, use getParentDataElement to get the associated ParentDataElement.


Definition

CaCORE::CaDSR::Definition - Perl extension for Definition.

ABSTRACT

The CaCORE::CaDSR::Definition is a Perl object representation of the CaCORE Definition object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Textual definition from an identified source

ATTRIBUTES of Definition

The following are all the attributes of the Definition object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

languageName

data type: string

modifiedBy

data type: string

text

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Definition

The following are all the objects that are associated with the Definition:

Collection of Context:

Many to one assoication, use getContext to get the associated Context.

Instance of DefinitionClassSchemeItem:

One to many assoication, use getDefinitionClassSchemeItemCollection to get a collection of associated DefinitionClassSchemeItem.


DefinitionClassSchemeItem

CaCORE::CaDSR::DefinitionClassSchemeItem - Perl extension for DefinitionClassSchemeItem.

ABSTRACT

The CaCORE::CaDSR::DefinitionClassSchemeItem is a Perl object representation of the CaCORE DefinitionClassSchemeItem object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of DefinitionClassSchemeItem

The following are all the attributes of the DefinitionClassSchemeItem object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DefinitionClassSchemeItem

The following are all the objects that are associated with the DefinitionClassSchemeItem:

Collection of ClassSchemeClassSchemeItem:

Many to one assoication, use getClassSchemeClassSchemeItem to get the associated ClassSchemeClassSchemeItem.

Collection of Definition:

Many to one assoication, use getDefinition to get the associated Definition.


DerivationType

CaCORE::CaDSR::DerivationType - Perl extension for DerivationType.

ABSTRACT

The CaCORE::CaDSR::DerivationType is a Perl object representation of the CaCORE DerivationType object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The type of Derived Data Element that is being created. For example a Data Element that is derived/created by subtracting two dates represented by other data elements would be a Calculated Representation Type. Types include: Calculated, Complex Recode, Compound, Concatenation, Object Class, and Simple Recode.

ATTRIBUTES of DerivationType

The following are all the attributes of the DerivationType object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

description

data type: string

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DerivationType

The following are all the objects that are associated with the DerivationType:

Instance of ConceptDerivationRule:

One to many assoication, use getConceptDerivationRuleCollection to get a collection of associated ConceptDerivationRule.

Instance of DerivedDataElement:

One to many assoication, use getDerivedDataElementCollection to get a collection of associated DerivedDataElement.


DerivedDataElement

CaCORE::CaDSR::DerivedDataElement - Perl extension for DerivedDataElement.

ABSTRACT

The CaCORE::CaDSR::DerivedDataElement is a Perl object representation of the CaCORE DerivedDataElement object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The Data Element that is derived from one or more data elements. ISO DEF: the relationship among a Data Element which is derived, the rule controlling its derivation, and the Data Element(s) from which it is derived.

ATTRIBUTES of DerivedDataElement

The following are all the attributes of the DerivedDataElement object and their data types:

concatenationCharacter

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

methods

data type: string

modifiedBy

data type: string

rule

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DerivedDataElement

The following are all the objects that are associated with the DerivedDataElement:

Collection of DataElement:

Many to one assoication, use getDataElement to get the associated DataElement.

Instance of DataElementDerivation:

One to many assoication, use getDataElementDerivationCollection to get a collection of associated DataElementDerivation.

Collection of DerivationType:

Many to one assoication, use getDerivationType to get the associated DerivationType.


Designation

CaCORE::CaDSR::Designation - Perl extension for Designation.

ABSTRACT

The CaCORE::CaDSR::Designation is a Perl object representation of the CaCORE Designation object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A name by which an Administered Component is known in a specific Context. Also a placeholder to track the usage of Administered Components by different Contexts.

ATTRIBUTES of Designation

The following are all the attributes of the Designation object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

languageName

data type: string

modifiedBy

data type: string

name

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Designation

The following are all the objects that are associated with the Designation:

Collection of Context:

Many to one assoication, use getContext to get the associated Context.

Instance of DesignationClassSchemeItem:

One to many assoication, use getDesignationClassSchemeItemCollection to get a collection of associated DesignationClassSchemeItem.


DesignationClassSchemeItem

CaCORE::CaDSR::DesignationClassSchemeItem - Perl extension for DesignationClassSchemeItem.

ABSTRACT

The CaCORE::CaDSR::DesignationClassSchemeItem is a Perl object representation of the CaCORE DesignationClassSchemeItem object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A class that serves to allow many to many relationships between Designation and ClassSchemeClassSchemeItem, providing uniqueness to the CS/CSI pairing to an Designation.

ATTRIBUTES of DesignationClassSchemeItem

The following are all the attributes of the DesignationClassSchemeItem object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of DesignationClassSchemeItem

The following are all the objects that are associated with the DesignationClassSchemeItem:

Collection of ClassSchemeClassSchemeItem:

Many to one assoication, use getClassSchemeClassSchemeItem to get the associated ClassSchemeClassSchemeItem.

Collection of Designation:

Many to one assoication, use getDesignation to get the associated Designation.


EnumeratedValueDomain

CaCORE::CaDSR::EnumeratedValueDomain - Perl extension for EnumeratedValueDomain.

ABSTRACT

The CaCORE::CaDSR::EnumeratedValueDomain is a Perl object representation of the CaCORE EnumeratedValueDomain object.

EnumeratedValueDomain extends from domain object ValueDomain.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of EnumeratedValueDomain

The following are all the attributes of the EnumeratedValueDomain object and their data types:

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of EnumeratedValueDomain

The following are all the objects that are associated with the EnumeratedValueDomain:

Instance of ValueDomainPermissibleValue:

One to many assoication, use getValueDomainPermissibleValueCollection to get a collection of associated ValueDomainPermissibleValue.


Form

CaCORE::CaDSR::Form - Perl extension for Form.

ABSTRACT

The CaCORE::CaDSR::Form is a Perl object representation of the CaCORE Form object.

Form extends from domain object FormElement.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A questionnaire that documents all the patient data stipulated in the protocol and used by clinicians to record information about patient's visits while on the clinical trial.

ATTRIBUTES of Form

The following are all the attributes of the Form object and their data types:

displayName

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Form

The following are all the objects that are associated with the Form:

Instance of Module:

One to many assoication, use getModuleCollection to get a collection of associated Module.

Instance of Protocol:

One to many assoication, use getProtocolCollection to get a collection of associated Protocol.


FormElement

CaCORE::CaDSR::FormElement - Perl extension for FormElement.

ABSTRACT

The CaCORE::CaDSR::FormElement is a Perl object representation of the CaCORE FormElement object.

FormElement extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The element of a Form

ATTRIBUTES of FormElement

The following are all the attributes of the FormElement object and their data types:

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of FormElement

The following are all the objects that are associated with the FormElement:

Instance of Instruction:

One to many assoication, use getInstructionCollection to get a collection of associated Instruction.


Function

CaCORE::CaDSR::Function - Perl extension for Function.

ABSTRACT

The CaCORE::CaDSR::Function is a Perl object representation of the CaCORE Function object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of Function

The following are all the attributes of the Function object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

symbol

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Function

The following are all the objects that are associated with the Function:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.


Instruction

CaCORE::CaDSR::Instruction - Perl extension for Instruction.

ABSTRACT

The CaCORE::CaDSR::Instruction is a Perl object representation of the CaCORE Instruction object.

Instruction extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Instruction for a Form, Module, Question or Valid Value on a Form

ATTRIBUTES of Instruction

The following are all the attributes of the Instruction object and their data types:

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Instruction

The following are all the objects that are associated with the Instruction:

Collection of FormElement:

Many to one assoication, use getFormElement to get the associated FormElement.


Module

CaCORE::CaDSR::Module - Perl extension for Module.

ABSTRACT

The CaCORE::CaDSR::Module is a Perl object representation of the CaCORE Module object.

Module extends from domain object FormElement.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A collection of data elements, or Common Data Elements, logically grouped on a case report form.

ATTRIBUTES of Module

The following are all the attributes of the Module object and their data types:

displayOrder

data type: int

maximumQuestionRepeat

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Module

The following are all the objects that are associated with the Module:

Collection of Form:

Many to one assoication, use getForm to get the associated Form.

Instance of Question:

One to many assoication, use getQuestionCollection to get a collection of associated Question.


NonenumeratedValueDomain

CaCORE::CaDSR::NonenumeratedValueDomain - Perl extension for NonenumeratedValueDomain.

ABSTRACT

The CaCORE::CaDSR::NonenumeratedValueDomain is a Perl object representation of the CaCORE NonenumeratedValueDomain object.

NonenumeratedValueDomain extends from domain object ValueDomain.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A value domain not expressed as a list of all permissible values.

ATTRIBUTES of NonenumeratedValueDomain

The following are all the attributes of the NonenumeratedValueDomain object and their data types:

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of NonenumeratedValueDomain

The following are all the objects that are associated with the NonenumeratedValueDomain:


ObjectClass

CaCORE::CaDSR::ObjectClass - Perl extension for ObjectClass.

ABSTRACT

The CaCORE::CaDSR::ObjectClass is a Perl object representation of the CaCORE ObjectClass object.

ObjectClass extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A set of ideas, abstractions, or things in the real world that can be identified with explicit boundaries and meaning and whose properties and behavior follow the same rules.

ATTRIBUTES of ObjectClass

The following are all the attributes of the ObjectClass object and their data types:

definitionSource

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ObjectClass

The following are all the objects that are associated with the ObjectClass:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of DataElementConcept:

One to many assoication, use getDataElementConceptCollection to get a collection of associated DataElementConcept.

Instance of SourcObjectClassRelationship:

One to many assoication, use getSourcObjectClassRelationshipCollection to get a collection of associated SourcObjectClassRelationship.

Instance of TargetObjectClassRelationship:

One to many assoication, use getTargetObjectClassRelationshipCollection to get a collection of associated TargetObjectClassRelationship.


ObjectClassRelationship

CaCORE::CaDSR::ObjectClassRelationship - Perl extension for ObjectClassRelationship.

ABSTRACT

The CaCORE::CaDSR::ObjectClassRelationship is a Perl object representation of the CaCORE ObjectClassRelationship object.

ObjectClassRelationship extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A description of the affiliation between two occurrences of Object Classes

ATTRIBUTES of ObjectClassRelationship

The following are all the attributes of the ObjectClassRelationship object and their data types:

direction

data type: string

name

data type: string

sourceHighMultiplicity

data type: int

sourceLowMultiplicity

data type: int

sourceRole

data type: string

targetHighMultiplicity

data type: int

targetLowMultiplicity

data type: int

targetRole

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ObjectClassRelationship

The following are all the objects that are associated with the ObjectClassRelationship:

Collection of SourceObjectClass:

Many to one assoication, use getSourceObjectClass to get the associated SourceObjectClass.

Collection of TargetObjectClass:

Many to one assoication, use getTargetObjectClass to get the associated TargetObjectClass.


Organization

CaCORE::CaDSR::Organization - Perl extension for Organization.

ABSTRACT

The CaCORE::CaDSR::Organization is a Perl object representation of the CaCORE Organization object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Organizational unit like a laboratory, institute or consortium.

ATTRIBUTES of Organization

The following are all the attributes of the Organization object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Organization

The following are all the objects that are associated with the Organization:

Instance of Address:

One to many assoication, use getAddressCollection to get a collection of associated Address.

Instance of AdministeredComponentContact:

One to many assoication, use getAdministeredComponentContactCollection to get a collection of associated AdministeredComponentContact.

Instance of Person:

One to many assoication, use getPersonCollection to get a collection of associated Person.


PermissibleValue

CaCORE::CaDSR::PermissibleValue - Perl extension for PermissibleValue.

ABSTRACT

The CaCORE::CaDSR::PermissibleValue is a Perl object representation of the CaCORE PermissibleValue object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The exact names, codes and text that can be stored in a data field in an information management system. ISO DEF: An expression of a value meaning in a specific value domain.

ATTRIBUTES of PermissibleValue

The following are all the attributes of the PermissibleValue object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

highValueNumber

data type: long

id

data type: string

lowValueNumber

data type: long

modifiedBy

data type: string

value

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of PermissibleValue

The following are all the objects that are associated with the PermissibleValue:

Instance of ValueDomainPermissibleValue:

One to many assoication, use getValueDomainPermissibleValueCollection to get a collection of associated ValueDomainPermissibleValue.

Collection of ValueMeaning:

Many to one assoication, use getValueMeaning to get the associated ValueMeaning.


Person

CaCORE::CaDSR::Person - Perl extension for Person.

ABSTRACT

The CaCORE::CaDSR::Person is a Perl object representation of the CaCORE Person object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Person's first and last name and the connection to the party.

ATTRIBUTES of Person

The following are all the attributes of the Person object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

firstName

data type: string

id

data type: string

lastName

data type: string

middleInitial

data type: string

modifiedBy

data type: string

position

data type: string

rank

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Person

The following are all the objects that are associated with the Person:

Instance of Address:

One to many assoication, use getAddressCollection to get a collection of associated Address.

Instance of AdministeredComponentContact:

One to many assoication, use getAdministeredComponentContactCollection to get a collection of associated AdministeredComponentContact.

Collection of Organization:

Many to one assoication, use getOrganization to get the associated Organization.


Property

CaCORE::CaDSR::Property - Perl extension for Property.

ABSTRACT

The CaCORE::CaDSR::Property is a Perl object representation of the CaCORE Property object.

Property extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Property is an attribute of a concept. Examples of properties are ``Synonym'', ``Preferred_Name'', ``Semantic_Type'' etc.

ATTRIBUTES of Property

The following are all the attributes of the Property object and their data types:

definitionSource

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Property

The following are all the objects that are associated with the Property:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of DataElementConcept:

One to many assoication, use getDataElementConceptCollection to get a collection of associated DataElementConcept.


Protocol

CaCORE::CaDSR::Protocol - Perl extension for Protocol.

ABSTRACT

The CaCORE::CaDSR::Protocol is a Perl object representation of the CaCORE Protocol object.

Protocol extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

An object representation of the protocol used in assembling a clone library.

ATTRIBUTES of Protocol

The following are all the attributes of the Protocol object and their data types:

approvedBy

data type: string

approvedDate

data type: dateTime

changeNumber

data type: string

changeType

data type: string

leadOrganizationName

data type: string

phase

data type: string

protocolID

data type: string

reviewedBy

data type: string

reviewedDate

data type: dateTime

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Protocol

The following are all the objects that are associated with the Protocol:

Instance of Form:

One to many assoication, use getFormCollection to get a collection of associated Form.


Question

CaCORE::CaDSR::Question - Perl extension for Question.

ABSTRACT

The CaCORE::CaDSR::Question is a Perl object representation of the CaCORE Question object.

Question extends from domain object FormElement.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The actual text of the data element as specified on a Case Report Form of a Protocol.

ATTRIBUTES of Question

The following are all the attributes of the Question object and their data types:

defaultValidValueId

data type: string

defaultValue

data type: string

displayOrder

data type: int

isEditable

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Question

The following are all the objects that are associated with the Question:

Collection of DataElement:

Many to one assoication, use getDataElement to get the associated DataElement.

Collection of Module:

Many to one assoication, use getModule to get the associated Module.

Instance of QuestionRepetition:

One to many assoication, use getQuestionRepetitionCollection to get a collection of associated QuestionRepetition.

Instance of ValidValue:

One to many assoication, use getValidValueCollection to get a collection of associated ValidValue.

Collection of ValueDomain:

Many to one assoication, use getValueDomain to get the associated ValueDomain.


QuestionRepetition

CaCORE::CaDSR::QuestionRepetition - Perl extension for QuestionRepetition.

ABSTRACT

The CaCORE::CaDSR::QuestionRepetition is a Perl object representation of the CaCORE QuestionRepetition object.

QuestionRepetition extends from domain object FormElement.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

ATTRIBUTES of QuestionRepetition

The following are all the attributes of the QuestionRepetition object and their data types:

defaultValue

data type: string

isEditable

data type: string

repeatSequenceNumber

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of QuestionRepetition

The following are all the objects that are associated with the QuestionRepetition:

Collection of DefaultValidValue:

Many to one assoication, use getDefaultValidValue to get the associated DefaultValidValue.


ReferenceDocument

CaCORE::CaDSR::ReferenceDocument - Perl extension for ReferenceDocument.

ABSTRACT

The CaCORE::CaDSR::ReferenceDocument is a Perl object representation of the CaCORE ReferenceDocument object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A place to document additional information about Administered Components that is not readily stored elsewhere.

ATTRIBUTES of ReferenceDocument

The following are all the attributes of the ReferenceDocument object and their data types:

URL

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

displayOrder

data type: long

doctext

data type: string

id

data type: string

languageName

data type: string

modifiedBy

data type: string

name

data type: string

organizationId

data type: string

rdtlName

data type: string

type

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ReferenceDocument

The following are all the objects that are associated with the ReferenceDocument:

Collection of ClassSchemeClassSchemeItem:

Many to one assoication, use getClassSchemeClassSchemeItem to get the associated ClassSchemeClassSchemeItem.

Collection of ClassificationSchemeItem:

Many to one assoication, use getClassificationSchemeItem to get the associated ClassificationSchemeItem.

Collection of Context:

Many to one assoication, use getContext to get the associated Context.


Representation

CaCORE::CaDSR::Representation - Perl extension for Representation.

ABSTRACT

The CaCORE::CaDSR::Representation is a Perl object representation of the CaCORE Representation object.

Representation extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

Mechanism by which the functional and/or presentational category of an item maybe conveyed to a user. Component of a Data Element Name that describes how data are represented (i.e. the combination of a Value Domain, data type, and if necessary a unit of measure or a character set.) The Representation occupies the last position in the Data Element name (i.e. rightmost). Examples: Code - A system of valid symbols that substitute for specified values e.g. alpha, numeric, symbols and/or combinations. Count ? Non-monetary numeric value arrived at by counting. Currency ? Monetary representation. Date ? Calendar representation e.g. YYYY-MM-DD Graphic ? Diagrams, graphs, mathematical curves, or the like ? usually a vector image. Icon ? A sign or representation that stands for its object by virtue of a resemblance or analogy to it. Picture ? A visual representation of a person, object, or scene ? usually a raster image. Quantity ? A continuous number such as the linear dimensions, capacity/amount (non-monetary) of an object. Text ? A text field that is usually unformatted. Time ? Time of day or duration e.g. HH:MM:SS.SSSS.

ATTRIBUTES of Representation

The following are all the attributes of the Representation object and their data types:

definitionSource

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of Representation

The following are all the objects that are associated with the Representation:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of ValueDomain:

One to many assoication, use getValueDomainCollection to get a collection of associated ValueDomain.


TriggerAction

CaCORE::CaDSR::TriggerAction - Perl extension for TriggerAction.

ABSTRACT

The CaCORE::CaDSR::TriggerAction is a Perl object representation of the CaCORE TriggerAction object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

a

ATTRIBUTES of TriggerAction

The following are all the attributes of the TriggerAction object and their data types:

action

data type: string

createdBy

data type: string

criterionValue

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

forcedValue

data type: string

id

data type: string

instruction

data type: string

modifiedBy

data type: string

triggerRelationship

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of TriggerAction

The following are all the objects that are associated with the TriggerAction:

Instance of AdministeredComponentClassSchemeItem:

One to many assoication, use getAdministeredComponentClassSchemeItemCollection to get a collection of associated AdministeredComponentClassSchemeItem.

Instance of Protocol:

One to many assoication, use getProtocolCollection to get a collection of associated Protocol.

Collection of SourceFormElement:

Many to one assoication, use getSourceFormElement to get the associated SourceFormElement.

Collection of TargetFormElement:

Many to one assoication, use getTargetFormElement to get the associated TargetFormElement.


ValidValue

CaCORE::CaDSR::ValidValue - Perl extension for ValidValue.

ABSTRACT

The CaCORE::CaDSR::ValidValue is a Perl object representation of the CaCORE ValidValue object.

ValidValue extends from domain object FormElement.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The allowable values for a given data element (question) on a Case Report Form.

ATTRIBUTES of ValidValue

The following are all the attributes of the ValidValue object and their data types:

displayOrder

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ValidValue

The following are all the objects that are associated with the ValidValue:

Collection of Question:

Many to one assoication, use getQuestion to get the associated Question.

Collection of ValueDomainPermissibleValue:

Many to one assoication, use getValueDomainPermissibleValue to get the associated ValueDomainPermissibleValue.


ValueDomain

CaCORE::CaDSR::ValueDomain - Perl extension for ValueDomain.

ABSTRACT

The CaCORE::CaDSR::ValueDomain is a Perl object representation of the CaCORE ValueDomain object.

ValueDomain extends from domain object AdministeredComponent.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

A set of permissible values for a data element.

ATTRIBUTES of ValueDomain

The following are all the attributes of the ValueDomain object and their data types:

UOMName

data type: string

characterSetName

data type: string

datatypeName

data type: string

decimalPlace

data type: int

formatName

data type: string

highValueNumber

data type: string

lowValueNumber

data type: string

maximumLengthNumber

data type: int

minimumLengthNumber

data type: int

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ValueDomain

The following are all the objects that are associated with the ValueDomain:

Instance of ChildValueDomainRelationship:

One to many assoication, use getChildValueDomainRelationshipCollection to get a collection of associated ChildValueDomainRelationship.

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Collection of ConceptualDomain:

Many to one assoication, use getConceptualDomain to get the associated ConceptualDomain.

Instance of DataElement:

One to many assoication, use getDataElementCollection to get a collection of associated DataElement.

Instance of ParentValueDomainRelationship:

One to many assoication, use getParentValueDomainRelationshipCollection to get a collection of associated ParentValueDomainRelationship.

Instance of Question:

One to many assoication, use getQuestionCollection to get a collection of associated Question.

Collection of Represention:

Many to one assoication, use getRepresention to get the associated Represention.


ValueDomainPermissibleValue

CaCORE::CaDSR::ValueDomainPermissibleValue - Perl extension for ValueDomainPermissibleValue.

ABSTRACT

The CaCORE::CaDSR::ValueDomainPermissibleValue is a Perl object representation of the CaCORE ValueDomainPermissibleValue object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

This captures the many-to-many relationship between value domain and permissible values and allows to associate a value domain to a permissible value.

ATTRIBUTES of ValueDomainPermissibleValue

The following are all the attributes of the ValueDomainPermissibleValue object and their data types:

beginDate

data type: dateTime

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

endDate

data type: dateTime

id

data type: string

modifiedBy

data type: string

origin

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ValueDomainPermissibleValue

The following are all the objects that are associated with the ValueDomainPermissibleValue:

Collection of Concept:

Many to one assoication, use getConcept to get the associated Concept.

Collection of EnumeratedValueDomain:

Many to one assoication, use getEnumeratedValueDomain to get the associated EnumeratedValueDomain.

Collection of PermissibleValue:

Many to one assoication, use getPermissibleValue to get the associated PermissibleValue.

Instance of ValidValue:

One to many assoication, use getValidValueCollection to get a collection of associated ValidValue.


ValueDomainRelationship

CaCORE::CaDSR::ValueDomainRelationship - Perl extension for ValueDomainRelationship.

ABSTRACT

The CaCORE::CaDSR::ValueDomainRelationship is a Perl object representation of the CaCORE ValueDomainRelationship object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The affiliation between two occurrences of Value Domains.

ATTRIBUTES of ValueDomainRelationship

The following are all the attributes of the ValueDomainRelationship object and their data types:

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

id

data type: string

modifiedBy

data type: string

name

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ValueDomainRelationship

The following are all the objects that are associated with the ValueDomainRelationship:

Collection of ChildValueDomain:

Many to one assoication, use getChildValueDomain to get the associated ChildValueDomain.

Collection of ParentValueDomain:

Many to one assoication, use getParentValueDomain to get the associated ParentValueDomain.


ValueMeaning

CaCORE::CaDSR::ValueMeaning - Perl extension for ValueMeaning.

ABSTRACT

The CaCORE::CaDSR::ValueMeaning is a Perl object representation of the CaCORE ValueMeaning object.

SYNOPSIS

See the CaCORE::ApplicationService manpage.

DESCRIPTION

The significance associated with an allowable/permissible value.

ATTRIBUTES of ValueMeaning

The following are all the attributes of the ValueMeaning object and their data types:

beginDate

data type: dateTime

comments

data type: string

createdBy

data type: string

dateCreated

data type: dateTime

dateModified

data type: dateTime

description

data type: string

endDate

data type: dateTime

id

data type: string

modifiedBy

data type: string

shortMeaning

data type: string

  Note: Although you can also use the corresponding setter methods to set the
  attribute values, it is not recommended to do so unless you absolutely have
  to change the object's attributes.

ASSOCIATIONS of ValueMeaning

The following are all the objects that are associated with the ValueMeaning:

Collection of ConceptDerivationRule:

Many to one assoication, use getConceptDerivationRule to get the associated ConceptDerivationRule.

Instance of ConceptualDomain:

One to many assoication, use getConceptualDomainCollection to get a collection of associated ConceptualDomain.

Instance of PermissibleValue:

One to many assoication, use getPermissibleValueCollection to get a collection of associated PermissibleValue.


SUPPORT

Please do not contact author directly. Send email to ncicb@pop.nci.nih.gov to request support or report a bug.


AUTHOR

Shan Jiang <jiangs@mail.nih.gov>


COPYRIGHT AND LICENSE

The CaCORE Software License, Version 1.0

  Copyright 2001-2005 SAIC. This software was developed in conjunction with the
  National Cancer Institute, and so to the extent government employees are co-authors,
  any rights in such works shall be subject to Title 17 of the United States Code,
  section 105. Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list
     of conditions and the disclaimer of Article 5, below. Redistributions in binary 
     form must reproduce the above copyright notice, this list of conditions and the
     disclaimer of Article 5 in the documentation and/or other materials provided with
     the distribution.
   
  2. The end-user documentation included with the redistribution, if any, must include
     the following acknowledgment: "This product includes software developed by SAIC and
     the National Cancer Institute." If no such end-user documentation is to be included,
     this acknowledgment shall appear in the software itself, wherever such third-party
     acknowledgments normally appear.
   
  3. The names "The National Cancer Institute", "NCI" and "SAIC" must not be used to
     endorse or promote products derived from this software. This license does not
     authorize the licensee to use any trademarks owned by either NCI or SAIC.
   
  4. This license does not authorize or prohibit the incorporation of this software into
     any third party proprietary programs. Licensee is expressly made responsible for
     obtaining any permission required to incorporate this software into third party
     proprietary programs and for informing licensee's end-users of their obligation
     to secure any required permissions before incorporating this software into third
     party proprietary software programs.
   
  5. THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, (INCLUDING,
     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND
     FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO EVENT SHALL THE NATIONAL
     CANCER INSTITUTE, SAIC, OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT,
     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.