NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Scrollbar
iconsfalse

Page info
title
title

Panel
titleContents of this Page
Table of Contents
minLevel2

Introduction

This document is a section of the Design and Architecture Guide.

Information Models Overview

The information below is provided for introductory purposes. A full description of all available model components is also available in the javadoc distributed with the LexEVS installation package (see file breakdown in the Installation Guide). Since the javadoc is automatically generated and synchronized during the build process, it is recommended as the primary reference for use by LexEVS developers.

LexGrid Model

The LexGrid model is mastered in XML schema. The LexBIG project currently builds on the 2009 version of the LexGrid schema. A formal representation, showing portions of this structure that are of primary interest to the LexEVS project, is presented below. A complete version of the model is available at http://informatics.mayo.edu?page=lgmImage Removed .

CodingSchemes

The CodingSchemes branch of the model defines high level containers for concepts and relations. Each CodingScheme represents a unique code system or version in the LexBIG service. Components of interest include:

...

properties
A collection of properties.

class diagram of codingSchemes

Concepts

Each concept represents a unique entity within the code system, which can be further described by properties and related to other concepts through relations.

conceptsAndInstances

codingScheme
A resource that makes assertions about a collection of terminological entities.

...

association
A binary relation from a set of entities to a set of entities and/or data. The entityType for the class concept must be "association".

class diagram of conceptsAndInstances

entities

codingScheme
A resource that makes assertions about a collection of terminological entities.

...

association
A binary relation from a set of entities to a set of entities and/or data. The entityType for the class concept must be "association".

class diagram of entities

entity

entity
A set of lexical assertions about the intended meaning of a particular entity code.

...

propertyLink
A link between two properties for an entity.. Examples include acronymFor, abbreviationOf, spellingVariantOf, etc. Must be in supportedPropertyLink.

class diagram of entity

Relations

Relations are used to define and qualify associations between concepts.

association

codingScheme
A resource that makes assertions about a collection of terminological entities.

...

associationSource
An entity that occurs in one or more instances of a relation on the "from" (or left hand) side of a particular relation.

class diagram of association

associationInstance

association
A binary relation from a set of entities to a set of entities and/or data. The entityType for the class concept must be "association".

...

associationQualification
A modifier that further qualifies the particular association instance.

class diagram of associationInstance

Naming

These elements are primarily used to define metadata for a coding scheme, mapping locally used names to global references.

...

supportedSourceRole
A source role and athe URI of the defining resource

naming class diagram

Value Domain Definition

The Value Domain Definition branch of the LexGrid model defines the contents of a value domain.

...

The following diagram is a UML representation of Value Domain Definition in LexGrid 200901 model:

UML representation of Value Domain Definition

Model Components

valueDomains
A collection of value domain definitions.

...

  • OR: Add the set of entityCodes described by the currentEntity to the value domain; logical OR.
  • SUBTRACT: Subtract (remove) the set of entityCodes described by the currentEntity to the value domain; logical NAND.
  • AND: Only include the entity codes that are both in the value domain and the definition entry; logical AND.

Value Domain Services

This feature is new in LexEVS 5.1. For details on using value domain services, see the Programmer's Guide, Value Domain Services section.

Pick List Definition

Pick List Definition branch of LexGrid model definies the contents of a pick list.

...

The following diagram is a UML representation of Pick List in LexGrid 200901 model:

a UML representation of Pick List

Model Components

pickLists
A collection of pick list definitions.

...

  • entityCode: Entity code associated with this entry.
  • entityCodeNamespace: Local identifier of the namespace of the entity code if different than the pickListDefinition defaultEntityCodeNamespace. entityCodeNamespace must match a local ID of a supportedNamespace in the mappings section.

Pick List Services

This feature is new in LexEVS 5.1. For details on using pick list services, see the Programmer's Guide, Pick List Services section.

LexBIG Model

The following extensions to the LexGrid model were introduced in support of caBIG requirements. As with the LexGrid model, this document provides a summary of the most significant elements for consideration by LexBIG programmers. The complete and current version of the model is available online at http://informatics.mayo.edu?page=lexexImage Removed .

Core

LexBIG core elements provide enhanced referencing and controlled resolution of LexGrid model objects.

...

ServiceURL
References a service in the Globus environment, this will be a global service handle (GSH).

InterfaceElements

Defines metadata related to model objects required by the runtime.

...

SystemReleaseDetail
The combination of a system release and all of the entityVersions
that accompanied that release.

NCIHistory

Maintains a record of modifications made to a code system.

...

NCIChangeEvent
A change event as documented in:

Code Block
Link provided for historical purposes ftp://ftp1.nci.nih.gov/pub/cacore/EVS/ReadMe_history.txt

Image Removed. Note that date and time of the change event is recorded in the containing version. All change events for the same/date and time a recorded in the same version.

...