NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 1

changes.mady.by.user Unknown User (reillysm)

Saved on

compared with

New Version 2

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

<?xml version="1.0" encoding="utf-8"?>
<html>

Template:Menu LexEVS 6.0 CTS2

Scrollbar
iconsfalse

Page info
title
title

Panel
titleContents of this Page
Table of Contents
minLevel2

Introduction

LexEVS CTS2 Code System Authoring API provides capability to author Code System and its contents.

...

    • New Code System
    • Add new property to Code System
    • New Concept
    • Add new property to Concept
    • New AssociationType
    • New Code System Suppliment
      Panel

      *Edit - This function provides capability to update:

    • Code System metadata
    • Property of a Code System
    • Concept metadata
    • Property of a Concept
    • AssociationType
      Panel

      *Remove - This function provides capability to remove:

    • Entire Code System
    • Property of a Code System
    • Concept
    • Property of a Concept
      Panel

      *Status Change - This function provides capability to update Status attributes:

    • Code System Status
    • Concept Status

Interface

org.lexevs.cts2.author.CodeSystemAuthoringOperation is the main interface for all the authoring operations against Code System. This interface can be accessed using main LexEVSCTS2 interface, like:

<source>
org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAuthoringOperation().getCodeSystemAuthoringOperation();
</source>

Revision Information

All the authoring functions described here requires information about the author and revision/version id to be assigned to entities for each of these operations. These is done passing object

...

Panel

java.lang.String changeAgent - (Optional) The source that participated in this particular change.
java.lang.String changeInstruction - (Optional) A human or machine readable set of instructions on how to apply this change.
java.lang.String revisionId - (Mandatory) The unique identifier of this revision.
java.lang.Long editOrder - (Optional) The relative order that this revision is to be applied if in a systemRelease.
java.util.Date revisionDate - (Optional) The end date for which this version is operative (considered commited).
java.lang.String description - (Optional) The description of the resource/change.
java.lang.String systemReleaseURI - (Optional) The official URI of this release

Authoring Functions

Following sections contains detailed functions provided by CodeSystemAuthoringOperation interface.

Create Operations

Create Operation provides capability to create Code System, Concept, AssociationType, Property and Code System Suppliment. For every entry that gets created, a unique revision(version) identifier will be assigned to that entry. This helps in retrieving snapshots of an entry based on its revision(version) identifier. This unique id can be passed in using the RevisionInfo object described above.

createCodeSystem

This function provides capability to create a new Code System to contain a set of new coded concepts. The Code System is created by defining the set of meta-data properties that describe it. At this point there no concepts are added.

...

Panel

CodingScheme codeScheme = csAuthOp.createCodeSystem(revInfo, codingSchemeName, codingSchemeURI, formalName, defaultLanguage, approxNumConcepts, representsVersion, localNameList, sourceList, copyright, mappings); |

addCodeSystemProperties

This function provides capability to add new properties to Code System.

...

Panel

CodingScheme codeScheme = csAuthOp.addCodeSystemProperties (revInfo, "New Coding Scheme", "urn:oid:11.11.0.99", "1.0", properties); |

createCodeSystemSuppliment

This function creates a new Code System Supplement as a container of a set of concepts and concept properties to be appended to a target code system. This function does not add the concepts and properties.

...

Panel

csAuthOp.createCodeSystemSuppliment(parent, suppliment); |

createConcept

This function creates a concept to be included in a Code System. The new concept is defined by the set of meta-data properties that describe it.

...

Panel

csAuthOp.createConcept("NCIT", "10.0", "C12345", "NCIT", revInfo); |

addNewConceptProperty

This function provides capability to add a new property to a concept.

...

Panel

csAuthOp.addNewConceptProperty("urn:oid:11.11.0.99", "1.0", "C12345", "NCIT", prop, revInfo); |

createAssociationType

This function provides capability to create a new association type, an instance of which may be used to link two concepts.

...

Panel

csAuthOp.createAssociationType("urn:oid:11.11.0.99", "1.0", "SCT-ICD9Mapping", "SameAs", "SameAs", "SameAs", true, true, revInfo); |

Edit Operations

The edit operation provides the capability to modify existing code system resources like code system metadata, property, concept, association type etc. For every entry that gets modified, a unique revision(version) identifier will be assigned to that entry. This helps in retrieving snapshots of an entry based on its revision(version) identifier. This unique id can be passed in using the RevisionInfo object described above.

updateCodeSystem

This function provides capability to modify the meta-data that describes the Code System. This method takes in any changes to the meta-data as a form of input parameters. If 'null' no changes will be performed on that particular attribute.

...

Panel

CodingScheme codeScheme = csAuthOp.updateCodeSystem(revInfo, codingSchemeName, codingSchemeURI, formalName, defaultLanguage, approxNumConcepts, representsVersion, localNameList, sourceList, copyright, mappings); |

updateCodeSystemProperties

This function provides capability to update properties of a Code System.

...

Panel

CodingScheme codeScheme = csAuthOp.updateCodeSystemProperties(revInfo, "New Coding Scheme", "urn:oid:11.11.0.99", "1.0", properties); |

updateConcept

This function provides capability to modify existing concept in a Code System.

...

Panel

csAuthOp.updateConcept("NCIT", "10.0", entityToUpdate, revInfo); |

updateConceptProperty

This function provides capability to modify existing property of a concept.

...

Panel

csAuthOp.updateConceptProperty("urn:oid:11.11.0.99", "1.0", "C12345", "NCIT", prop, revInfo); |

updateAssociationType

This function provides capability to modify existing association type.

...

Panel

csAuthOp.updateAssociationType("urn:oid:11.11.0.99", "1.0", associationEntity, revInfo); |

Remove Operations

Remove operation provides capability to remove code system and its contents.

removeCodeSystem

This function provides capability to remove entire code system from terminology service.

...

Panel

csAuthOp.removeCodeSystem(revInfo, "urn:oid:11.11.0.99", "1.0"); |

removeCodeSystemProperty

This function provides capability to remove property of a Code System.

...

Panel

CodingScheme codeScheme = csAuthOp.removeCodeSystemProperty(revInfo, "urn:oid:11.11.0.99", "1.0", "propertId1"); |

deleteConcept

This function provides capability to remove a concept from code system.

...

Panel

csAuthOp.deleteConcept("urn:oid:11.11.0.99", "1.0, "C1234", 'NCIT", revInfo); |

deleteConceptProperty

This function provides capability to remove property of a concept.

...

Panel

csAuthOp.deleteConceptProperty("urn:oid:11.11.0.99", "1.0", "C1234", "NCIT", propertyToRemove, revInfo); |

Status Change Operations

Status Change operations provides the capability to change the status a code system or a concept. Status could anything like : isActive, retired, published, pending etc. There is also a flag called 'isActive' that is associated with both code system and concept meta-data that can be changed using this function as well.

'isActive' flag : True means that this resource is searchable and browsable if the temporal context of the operation falls between effectiveDate and expirationDate. False means that this resource is only accessible if requested by id or by a search that specifies that inactive retrievals are allowed. Default: True

updateCodeSystemVersionStatus

This function modifies the status of a code system.

...

Panel

csAuthOp.updateCodeSystemVersionStatus("urn:oid:11.11.0.99", "1.0", "Active", true, revInfo); |

updateConceptStatus

This function modifies the status of a concept.

...

Panel

csAuthOp.updateCodeSystemVersionStatus("urn:oid:11.11.0.99", "1.0", "C1234", "NCIT", "Active", true, revInfo); |

...

Scrollbar
iconsfalse