NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

Description:

Creates new association type.

Input:

  • java.lang.String codingSchemeURI - (Mandatory) URI of a Code System that contains the new association type.
  • java.lang.String codeSystemVersion - (Mandatory) Version of a Code System that contains the new association type.
  • java.lang.String relationsContainerName - (Mandatory) Relation container name that contains the new association type.
  • java.lang.String associationName - (Mandatory) Name or identifier of a new association type.
  • java.lang.String forwardName - (Optional) The name or role that the "from" entity plays with respect to the "to" entry. Should be phrased in terms of the default language of the association and imply direction.
  • java.lang.String reverseName - (Optional) The name or role that the "to" entity plays with respect to the "from" entry. Should be phrased in terms of the default language of the association and imply direction.
  • java.lang.Boolean isNavigable - (Optional) True means that the reverse direction of the associaton is "navigable", meaning that it makes sense to represent the target to source side of the association.
  • java.lang.Boolean isTransitive - (Optional) True means that association is transitive ( r(a,b), r(b,c) -> r(a,c)). False means not transitive. If absent, transitivity is unknown or not applicable.
  • org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.

Output:

None

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

*Sample Call: *

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object: | h3. 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. h4. 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. {{updateCodeSystem(RevisionInfo revision, String codingSchemeName, String codingSchemeURI, String formalName, String defaultLanguage, long approxNumConcepts, String representsVersion, List<String> localNameList,
    Code Block
    RevisionInfo revInfo = new RevisionInfo();
    revInfo.setChangeAgent("change Agent Name");
    revInfo.setChangeInstruction("here goes the change Instructions");
    revInfo.setDescription("description of the resource");
    revInfo.setEditOrder(1L);
    revInfo.setRevisionDate(new Date());
    revInfo.setRevisionId(UUID.randomUUID().toString());
    * _Step 3:_ call create association type method by passing the code system, concept and new association type information:
    {code
    csAuthOp.createAssociationType("urn:oid:11.11.0.99", "1.0", "SCT-ICD9Mapping", "SameAs", "SameAs", "SameAs", true, true, revInfo);
    Code Block
    
    

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.

updateCodeSystem(RevisionInfo revision, String codingSchemeName, String codingSchemeURI, String formalName, String defaultLanguage, long approxNumConcepts, String representsVersion, List<String> localNameList, List<org.LexGrid.commonTypes.Source>

...

sourceList,

...

Text

...

copyright,

...

Mappings

...

mappings)

}} | *

Description:

* |

Modify

the

meta-data

that

describes

the

Code

System.

| | *

Input:

  • * | * *_org.lexevs.cts2.core.update.RevisionInfo revision_* - (*Mandatory*) Contains revision information like unique RevisionId, change description, author information etc. *
  • *_java.lang.String codingSchemeName_* - (*Mandatory*) Name of the Code System that is getting modified. *
  • *_java.lang.String codingSchemeURI_* - (*Mandatory*) URI of a Code System that is getting modified.
  • * *_java.lang.String formalName_* - (Optional) Modified formal name of a Code System.
  • * *_java.lang.String defaultLanguage_* - (Optional) Modified default language of Code System.
  • * *_long approxNumConcepts_* - - (Optional) Modified approximate number of concepts this Code System may contain. *
  • *_java.lang.String representsVersion_* - (*Mandatory*) Version of the Code System that is getting modified. * *_
  • java.util.List<java.lang.String> localNameList_* - (Optional) Modified local name(s)/reference(s) for this Code System used within the Code System. * *_
  • java.util.List<org.LexGrid.commonTypes.Source> sourceList_* - (Optional) Modified source(s) of this Code System. * *_
  • org.LexGrid.commonTypes.Text copyright_* - (Optional) Modified information about rights held in and over the Code System. Typically, copyright information includes a statement about various property rights associated with the Code System, including intellectual property rights. * *_
  • org.LexGrid.naming.Mappings mappings_* - (Optional) Modified list of all of the local identifiers and defining URI's that are used in the Code System. | | *

Output:

* | *_

org.LexGrid.codingSchemes.CodingScheme

_*

-

Modified

Code

System

Exception:

System | | *Exception:* | *_

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet : * _
    Code Block
    
    _* |
    | *Sample Call:* | * _Step 1:_ Instantiate CodeSystemAuthoringOperation if it is not done yet :
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
    Code Block
  • Step 2:_ Populate RevisionInfo object:
    Code Block
    RevisionInfo revInfo = new RevisionInfo();

    
    revInfo.setChangeAgent("change Agent Name");

    
    revInfo.setChangeInstruction("here goes the change Instructions");

    
    revInfo.setDescription("description of the resource");

    
    revInfo.setEditOrder(1L);

    
    revInfo.setRevisionDate(new Date());

    * _Step
    
    revInfo.setRevisionId(UUID.randomUUID().toString());
    Code Block
    
    
  • Step 3:_ Populate modified code system meta data:
    Code Block
    String codingSchemeURI = "urn:oid:11.11.0.99";

    
    String representsVersion = "1.0";
    Code Block
    
    
    String codingSchemeName = "New Coding Scheme";
    String formalName = "CTS 2 API Modified Code System";
    String defaultLanguage = "eng";
    Long approxNumConcepts = new Long(1);
    List<String> localNameList = Arrays.asList();
    
    org.LexGrid.commonTypes.Source source = new org.LexGrid.commonTypes.Source();
    source.setContent("source 2");
    List<org.LexGrid.commonTypes.Source> sourceList = Arrays.asList(source);
    
    Text copyright = new Text();
    org.LexGrid.naming.Mappings mappings = new org.LexGrid.naming.Mappings();
    
    org.LexGrid.naming.SupportedLanguage supportedLang = new org.LexGrid.naming.SupportedLanguage();
    
    supportedLang.setLocalId("eng");
    supportedLang.setUri("URI_for_lang_eng");
    
    mappings.addSupportedLanguage(supportedLang);
    
  • Step 4: call update method to modify the code system:
    Code Block
    CodingScheme codeScheme = csAuthOp.updateCodeSystem(revInfo, codingSchemeName, codingSchemeURI, formalName, defaultLanguage, approxNumConcepts, representsVersion, localNameList, sourceList, copyright, mappings);
    

...

Description:

Updates properties of a code system.

Input:

  • org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.
  • java.lang.String codingSchemeName - (Mandatory) Name of the Code System.
  • java.lang.String codingSchemeURI - (Mandatory) Code System URI.
  • java.lang.String representsVersion - (Mandatory) Version of the Code System.
  • org.LexGrid.commonTypes.Properties properties - (Mandatory) List of one or more modified properties.

Output:

org.LexGrid.codingSchemes.CodingScheme - Updated Code System

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    RevisionInfo revInfo = new RevisionInfo();
    revInfo.setChangeAgent("change Agent Name");
    revInfo.setChangeInstruction("here goes the change Instructions");
    revInfo.setDescription("description of the resource");
    revInfo.setEditOrder(1L);
    revInfo.setRevisionDate(new Date());
    revInfo.setRevisionId(UUID.randomUUID().toString());
    * _
  • Step 3:_ Populate properties to modify. Just modifying langauge and setting isActive to true for property 'propertyId1':
    Code Block
    Properties properties = new Properties();
    
    
    Presentation prop = new Presentation();

...

  • 
    prop.setPropertyId("propertyId1");

...

  • 
    prop.setPropertyName("propertyName");

...

  • 
    prop.setIsActive(true);

...

  • 
    prop.setLanguage("eng");

...

  • 	
    
    properties.addProperty(prop);
    

...

  • Step

...

  • 4:

...

  • call

...

  • modify

...

  • properties

...

  • method

...

  • by

...

  • passing

...

  • the

...

  • code

...

  • system

...

  • information

...

  • and

...

  • modified

...

  • set

...

  • of

...

  • properties:
    Code Block
    
    

...

  • 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.

updateConcept(String codingSchemeUri, String codeSystemVersion, Entity entity, RevisionInfo revisionInfo)

...

Description:

Modified an existing concept in a code system.

Input:

  • java.lang.String

...

  • codingSchemeURI

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • URI

...

  • of

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • concept.

...

  • java.lang.String

...

  • codeSystemVersion

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Version

...

  • of

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • concept.

...

  • org.LexGrid.concepts.Entity

...

  • entity

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Modified

...

  • concept(Entity

...

  • object).

...

  • org.lexevs.cts2.core.update.RevisionInfo

...

  • revision

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Contains

...

  • revision

...

  • information

...

  • like

...

  • unique

...

  • RevisionId,

...

  • change

...

  • description,

...

  • author

...

  • information

...

  • etc.

...

Output:

...

None

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

...

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();

...

  • 
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();
    revInfo.setChangeAgent("change Agent Name");
    revInfo.setChangeInstruction("here goes the change Instructions");
    revInfo.setDescription("description of the resource");
    revInfo.setEditOrder(1L);
    revInfo.setRevisionDate(new Date());
    revInfo.setRevisionId(UUID.randomUUID().toString());
    

...

  • Step

...

  • 3:

...

  • Populate

...

  • Entity

...

  • with

...

  • modified

...

  • concept:

...

  • Code Block
    
    Entity entityToUpdate = new Entity();

...

  • 
    entityToUpdate.setEntityCode("C12345");

...

  • 
    entityToUpdate.setEntityCodeNamespace("NCIT");

...

  • 
    entityToUpdate.setEntityDescription(Constructors.createEntityDescription("Modified ED"));

...

  • 
    
  • Step

...

  • 4:

...

  • call

...

  • modify

...

  • concept

...

  • method

...

  • by

...

  • passing

...

  • code

...

  • system

...

  • version

...

  • and

...

  • concept

...

  • information:
    Code Block
    
    

...

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

...

updateConceptProperty

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

updateConceptProperty(String codingSchemeUri, String codeSystemVersion, String conceptCode, String namespace, Property property, RevisionInfo revision)

...

Description:

Modifies existing property of a concept.

Input:

  • java.lang.String

...

  • codingSchemeURI

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • URI

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • concept.

...

  • java.lang.String

...

  • codeSystemVersion

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Version

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • concept.

...

  • java.lang.String

...

  • conceptCode

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Concept

...

  • code

...

  • that

...

  • contains

...

  • the

...

  • property.

...

  • java.lang.String

...

  • namespace

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Namespace

...

  • of

...

  • a

...

  • concept

...

  • that

...

  • contains

...

  • the

...

  • property.

...

  • org.LexGrid.commonTypes.Property

...

  • property

...

  • - (

...

  • Mandatory

...

  • )

...

  • Modified

...

  • property.

...

  • org.lexevs.cts2.core.update.RevisionInfo

...

  • revision

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Contains

...

  • revision

...

  • information

...

  • like

...

  • unique

...

  • RevisionId,

...

  • change

...

  • description,

...

  • author

...

  • information

...

  • etc.

...

Output:

...

None

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

...

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
Code Block

* _Step 2:_ Populate RevisionInfo object:

...

  • 
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();

...

  • 
    revInfo.setChangeAgent("change Agent Name");

...

  • 
    revInfo.setChangeInstruction("here goes the change Instructions");

...

  • 
    revInfo.setDescription("description of the resource");

...

  • 
    revInfo.setEditOrder(1L);

...

  • 
    revInfo.setRevisionDate(new Date());

...

  • 
    revInfo.setRevisionId(UUID.randomUUID().toString());

...

  • 
    
  • Step 3:

...

  • Populate

...

  • a

...

  • modified

...

  • property.

...

  • Just

...

  • modified

...

  • isActive

...

  • to

...

  • 'true'

...

  • and

...

  • language

...

  • to

...

  • 'eng'

...

  • in

...

  • property

...

  • 'propertyId1':
    Code Block
    
    

...

  • Property prop = new Property();

...

  • 
    prop.setPropertyId("propertyId1");

...

  • 
    prop.setPropertyName("propertyName");

...

  • 
    prop.setIsActive(true);

...

  • 
    prop.setLanguage("eng");
    

...

  • Step

...

  • 4:

...

  • call

...

  • update

...

  • property

...

  • method

...

  • by

...

  • passing

...

  • the

...

  • code

...

  • system

...

  • information,

...

  • concept

...

  • information

...

  • and

...

  • the

...

  • modified

...

  • property:
    Code Block
    
    

...

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

...

updateAssociationType

This function provides capability to modify existing association type.

updateAssociationType(String codingSchemeUri, String codeSystemVersion, AssociationEntity associationEntity, RevisionInfo revision)

Description:

Modifies existing association type.

Input:

  • java.lang.String

...

  • codingSchemeURI

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • URI

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • association

...

  • type.

...

  • java.lang.String

...

  • codeSystemVersion

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Version

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • contains

...

  • the

...

  • association

...

  • type.

...

  • org.LexGrid.relations.AssociationEntity

...

  • associationEntity

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Modified

...

  • association

...

  • type.

...

  • org.lexevs.cts2.core.update.RevisionInfo

...

  • revision

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Contains

...

  • revision

...

  • information

...

  • like

...

  • unique

...

  • RevisionId,

...

  • change

...

  • description,

...

  • author

...

  • information

...

  • etc.

...

Output:

...

None

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

...

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();
    revInfo.setChangeAgent("change Agent Name");
    revInfo.setChangeInstruction("here goes the change Instructions");
    revInfo.setDescription("description of the resource");
    revInfo.setEditOrder(1L);
    revInfo.setRevisionDate(new Date());
    revInfo.setRevisionId(UUID.randomUUID().toString());
    

...

  • Step

...

  • 3:

...

  • Populate

...

  • a

...

  • modified

...

  • association

...

  • type.

...

  • Just

...

  • modified

...

  • isActive

...

  • to

...

  • 'true'

...

  • and

...

  • forwardName

...

  • to

...

  • 'newForwardName'

...

  • for

...

  • associationType

...

  • 'SameAS':
    Code Block
    
    

...

  • AssociationEntity associationEntity = new AssociationEntity();

...

  • 
    associationEntity.setEntityCode("SameAs");

...

  • 
    associationEntity.setIsActive(true);

...

  • 
    associationEntity.setForwardName("NewForwardName");
    

...

  • Step

...

  • 4:

...

  • call

...

  • update

...

  • association

...

  • type

...

  • method

...

  • by

...

  • passing

...

  • the

...

  • code

...

  • system

...

  • information

...

  • and

...

  • the

...

  • modified

...

  • association

...

  • type:
    Code Block
    
    

...

  • 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.

removeCodeSystem(RevisionInfo revision, String codingSchemeURI, String representsVersion)

Description:

Remove entire code system from terminology service.

Input:

  • org.lexevs.cts2.core.update.RevisionInfo

...

  • revision

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Contains

...

  • revision

...

  • information

...

  • like

...

  • unique

...

  • RevisionId,

...

  • change

...

  • description,

...

  • author

...

  • information

...

  • etc.

...

  • java.lang.String

...

  • codingSchemeURI

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • URI

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • needs

...

  • to

...

  • be

...

  • removed.

...

  • java.lang.String

...

  • codeSystemVersion

...

  • -

...

  • (

...

  • Mandatory

...

  • )

...

  • Version

...

  • of

...

  • a

...

  • Code

...

  • System

...

  • that

...

  • needs

...

  • to

...

  • be

...

  • removed.

...

Output:

...

boolean - True means deletion was success, otherwise false.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

...

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    

...

  • Step

...

  • 2:

...

  • Populate

...

  • RevisionInfo

...

  • object:
    Code Block
    
    

...

  • RevisionInfo revInfo = new RevisionInfo();

...

  • 
    revInfo.setChangeAgent("change Agent Name");

...

  • 
    revInfo.setChangeInstruction("here goes the change Instructions");

...

  • 
    revInfo.setDescription("description of the resource");

...

  • 
    revInfo.setEditOrder(1L);

...

  • 
    revInfo.setRevisionDate(new Date());

...

  • 
    revInfo.setRevisionId(UUID.randomUUID().toString());
    
  • Step 3: call remove code system method by passing the code system information:
    Code Block
    
    csAuthOp.removeCodeSystem(revInfo, "urn:oid:11.11.0.99", "1.0");
    

...

removeCodeSystemProperty

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

...

Description:

Removes a property of a Code System

Input:

  • org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.
  • java.lang.String codingSchemeURI - (Mandatory) Code System URI that contains the property.
  • java.lang.String representsVersion - (Mandatory) Version of the Code System that contains the property.
  • java.lang.String propertyId - (Mandatory) Identifier of a property that needs to be removed.

Output:

org.LexGrid.codingSchemes.CodingScheme - Updated Code System

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    RevisionInfo revInfo = new RevisionInfo();_
    revInfo.setChangeAgent("change Agent Name");_
    revInfo.setChangeInstruction("here goes the change Instructions");_
    revInfo.setDescription("description of the resource");_
    revInfo.setEditOrder(1L);_
    revInfo.setRevisionDate(new Date());_
    revInfo.setRevisionId(UUID.randomUUID().toString());_
    * _
  • Step 3:_ Call remove property method by passing the code system information and the property identifier: | h4. deleteConcept This function provides capability to remove a concept from code system. {{deleteConcept(String codingSchemeUri, String codeSystemVersion, String conceptCode, String namespace, RevisionInfo revision)}} | *Description:* | Removes a concept from code system. | | *Input:* | * *_
    Code Block
    CodingScheme codeScheme = csAuthOp.removeCodeSystemProperty(revInfo, "urn:oid:11.11.0.99", "1.0", "propertId1");
    
    Code Block

deleteConcept

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

deleteConcept(String codingSchemeUri, String codeSystemVersion, String conceptCode, String namespace, RevisionInfo revision)

Description:

Removes a concept from code system.

Input:

  • java.lang.String codingSchemeURI_* - (*Mandatory*) URI of a Code System that contains the concept to be removed. * *_
  • java.lang.String codeSystemVersion_* - (*Mandatory*) Version of a Code System that contains the concept to be removed. * *_
  • java.lang.String conceptCode_* - (*Mandatory*) Identifier/Code of a Concept to be removed. * *_
  • java.lang.String namespace_* - (*Mandatory*) Namespace of a Concept to be removed. * *_
  • org.lexevs.cts2.core.update.RevisionInfo revision_* - (*Mandatory*) Contains revision information like unique RevisionId, change description, author information etc. | | *

Output:

None

Exception:

* | None | | *Exception:* | *_

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet : * _Step
    Code Block
    
    .LBException_* |
    | *Sample Call:* | * _Step 1:_ Instantiate CodeSystemAuthoringOperation if it is not done yet :
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    Code Block
    
    
  • Step 2:_ Populate RevisionInfo object:
    Code Block
    RevisionInfo revInfo = new RevisionInfo();

    
    revInfo.setChangeAgent("change Agent Name");

    
    revInfo.setChangeInstruction("here goes the change Instructions");

    
    revInfo.setDescription("description of the resource");

    
    revInfo.setEditOrder(1L);

    
    revInfo.setRevisionDate(new Date());

    
    revInfo.setRevisionId(UUID.randomUUID().toString());
    
  • Step 3: call remove concept method by passing the code system and concept information:
    Code Block
    csAuthOp.deleteConcept("urn:oid:11.11.0.99", "1.0, "C1234", 'NCIT", revInfo);
    

...

Description:

Removes a property of a concept.

Input:

  • java.lang.String codingSchemeURI - (Mandatory) Code System URI that contains the concept.
    java.lang.String representsVersion - (Mandatory) Version of the Code System that contains the concept.
    java.lang.String conceptCode - (Mandatory) Concept code that contains the property.
    java.lang.String namespace - (Mandatory) Namespace of a concept that contains the property.
    org.LexGrid.commonType.Property property - (Mandatory) Property that needs to be removed.
    org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.

*Output: *

None

...

*Exception: *

org.LexGrid.LexBIG.Exceptions.LBException

...

*Sample Call: *

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();

...

  • 
    revInfo.setChangeAgent("change Agent Name");

...

  • 
    revInfo.setChangeInstruction("here goes the change Instructions");

...

  • 
    revInfo.setDescription("description of the resource");

...

  • 
    revInfo.setEditOrder(1L);

...

  • 
    revInfo.setRevisionDate(new Date());

...

  • 
    revInfo.setRevisionId(UUID.randomUUID().toString());
    
  • Step 3: Populate property that needs to be removed:
    Code Block
    
    Property propertyToRemove = new Property();

...

  • 
    propertyToRemove.setPropertyId("p1");
    
  • Step 2: Call remove property method by passing the code system, concept and property information:
    Code Block
    
    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.

...

This function modifies the status of a code system.

updateCodeSystemVersionStatus(String codingSchemeURI, String codeSystemVersion, String status, Boolean isActive, RevisionInfo revision)

*Description: *

Modifies the status of a code system.

*Input: *

  • java.lang.String codingSchemeURI - (Mandatory) Code System URI.
  • java.lang.String representsVersion - (Mandatory) Version of the Code System.
  • java.lang.String status - (Mandatory) Modified status value.
  • java.lang.Boolean isActive - (Optional) Set to true or false. Null for no change.
  • org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.

...

*Output: *

None

...

*Exception: *

org.LexGrid.LexBIG.Exceptions.LBException

...

*Sample Call: *

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();

...

  • 
    revInfo.setChangeAgent("change Agent Name");

...

  • 
    revInfo.setChangeInstruction("here goes the change Instructions");

...

  • 
    revInfo.setDescription("description of the resource");

...

  • 
    revInfo.setEditOrder(1L);

...

  • 
    revInfo.setRevisionDate(new Date());

...

  • 
    revInfo.setRevisionId(UUID.randomUUID().toString());
    
  • Step 2: Call status change method by passing the code system and status information:
    Code Block
    
    csAuthOp.updateCodeSystemVersionStatus("urn:oid:11.11.0.99", "1.0", "Active", true, revInfo);

...

  • 
    

updateConceptStatus

This function modifies the status of a concept.

updateConceptStatus(String codingSchemeUri, String codeSystemVersion, String conceptCode, String namespace,String status,Boolean isActive, RevisionInfo revisionInfo)

*Description: *

Modifies the status of a concept.

*Input: *

  • java.lang.String codingSchemeURI - (Mandatory) Code System URI that contains the concept.
  • java.lang.String representsVersion - (Mandatory) Version of the Code System that contains the concept.
  • java.lang.String conceptCode - (Mandatory) Code/identifier of a concept.
  • java.lang.String namespace - (Mandatory) Mamespace of a concept.
  • java.lang.String status - (Mandatory) Modified status value.
  • java.lang.Boolean isActive - (Optional) Set to true or false. Null for no change.
  • org.lexevs.cts2.core.update.RevisionInfo revision - (Mandatory) Contains revision information like unique RevisionId, change description, author information etc.

...

*Output: *

None

...

*Exception: *

org.LexGrid.LexBIG.Exceptions.LBException

...

*Sample Call: *

  • Step 1: Instantiate CodeSystemAuthoringOperation if it is not done yet :
    Code Block
    
    org.lexevs.cts2.author.CodeSystemAuthoringOperation csAuthorOp = LexEvsCTS2Impl.defaultInstance().getAuthoringOperation().getCodeSystemAuthoringOperation();
    
  • Step 2: Populate RevisionInfo object:
    Code Block
    
    RevisionInfo revInfo = new RevisionInfo();

...

  • 
    revInfo.setChangeAgent("change Agent Name");

...

  • 
    revInfo.setChangeInstruction("here goes the change Instructions");

...

  • 
    revInfo.setDescription("description of the resource");

...

  • 
    revInfo.setEditOrder(1L);

...

  • 
    revInfo.setRevisionDate(new Date());

...

  • 
    revInfo.setRevisionId(UUID.randomUUID().toString());
    
  • Step 2: Call status change method by passing the code system, concept and status information:
    Code Block
    
    csAuthOp.updateCodeSystemVersionStatus("urn:oid:11.11.0.99", "1.0", "C1234", "NCIT", "Active", true, revInfo);

...

  • 
    
Scrollbar
iconsfalse