NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 11

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

Saved on

compared with

New Version 12

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

Saved on

Key

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

...

createCodeSystem(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:

Creates new coding 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) Code System Name.
  • java.lang.String codingSchemeURI - (Mandatory) Code System URI.
  • java.lang.String formalName - (Optional) Formal name of a Code System.
  • java.lang.String defaultLanguage - (Optional) Default language of Code System.
  • long approxNumConcepts - (Optional) Approximate number of concepts this Code System may contain.
  • java.lang.String representsVersion - (Mandatory) Initial version of the Code System.
  • java.util.List<java.lang.String> localNameList - (Optional) Any local name(s)/reference(s) for this Code System used within the Code System.
  • java.util.List<org.LexGrid.commonTypes.Source> sourceList - (Optional) Source(s) of this Code System.
  • org.LexGrid.commonTypes.Text copyright - (Optional) 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 - (Mandatory) A list of all of the local identifiers and defining URI's that are used in the Code System.

Output:

org.LexGrid.codingSchemes.CodingScheme - Created 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 new code system meta data:
    Code Block
    String codingSchemeURI = "urn:oid:11.11.0.99";
String representsVersion = "1.0";

String codingSchemeName = "New Coding Scheme";
String formalName = "CTS 2 API Created Code System";
String defaultLanguage = "en";
Long approxNumConcepts = new Long(1);
List<String> localNameList = Arrays.asList();

org.LexGrid.commonTypes.Source source = new org.LexGrid.commonTypes.Source();
source.setContent("source");
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("en");
supportedLang.setUri("URI_for_lang_en");

mappings.addSupportedLanguage(supportedLang);
  • Step 4: call create method to create the code system:
    Code Block
    CodingScheme codeScheme = csAuthOp.createCodeSystem(revInfo, codingSchemeName, codingSchemeURI, formalName, defaultLanguage, approxNumConcepts, representsVersion, localNameList, sourceList, copyright, mappings);

...

addCodeSystemProperties(RevisionInfo revision, String codingSchemeName, String codingSchemeURI, String representsVersion, Properties properties)

Description:

Adds new properties to 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) Code System Name.
  • java.lang.String codingSchemeURI - (Mandatory) Code System URI.
  • java.lang.String representsVersion - (Mandatory) Initial version of the Code System.
  • org.LexGrid.commonTypes.Properties properties - (Mandatory) List of one or more 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 add:
    Code Block
     Properties properties = new Properties();

Presentation prop = new Presentation();
prop.setPropertyId("propertyId1");
prop.setPropertyName("propertyName");
prop.setIsActive(false);
prop.setLanguage("en");
prop.setOwner("owner");
prop.setPropertyType(PropertyTypes.PROPERTY.name());
Text text = new Text();
text.setContent("content");
text.setDataType("Text datatype");
prop.setValue(text);
prop.setDegreeOfFidelity("degreeOfFidelity");
prop.setMatchIfNoContext(true);
prop.setRepresentationalForm("representationalForm");=

properties.addProperty(prop);

Presentation prop2 = new Presentation();
prop2.setPropertyId("propertyId2");
prop2.setPropertyName("propertyName-2");
prop2.setIsActive(false);
prop2.setLanguage("english-2");
prop2.setOwner("owner-2");
prop2.setPropertyType(PropertyTypes.PROPERTY.name());
Text text2 = new Text();
text2.setContent("content-2");
text2.setDataType("Text datatype-2");
prop2.setValue(text2);
prop2.setDegreeOfFidelity("degreeOfFidelity-2");
prop2.setMatchIfNoContext(true);
prop2.setRepresentationalForm("representationalForm-2");

 properties.addProperty(prop2);
  • Step 4: call add properties method by passing the code system information and new set of properties:
    Code Block
    CodingScheme codeScheme = csAuthOp.addCodeSystemProperties (revInfo, "New Coding Scheme", "urn:oid:11.11.0.99", "1.0", properties);

...

createCodeSystemSuppliment(AbsoluteCodingSchemeVersionReference parent, AbsoluteCodingSchemeVersionReference supplement)

Description:

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.

Input:

  • org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference parent - (Mandatory) Target Code System Version.
  • org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference supplement - (Mandatory) Supplement Code System Version.

Output:

None

Exception:

org.lexevs.cts2.exception.author.InvalidCodeSystemSupplementException

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 target code system version reference:
    Code Block
    org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference parent = new org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference()
parent.setCodingSchemeURN("parentCodeSystemURN");
parent.setCodingSchemeVersion("1.0");
  • Step 3: Populate new suppliment code system version reference:
    Code Block
    org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference suppliment = new org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference()
suppliment.setCodingSchemeURN("supplimentCodeSystemURN");
suppliment.setCodingSchemeVersion("1.0");
  • Step 4: Call create suppliment method by passing the parent and suppliment code system version:
    Code Block
    csAuthOp.createCodeSystemSuppliment(parent, suppliment);

...

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

Description:

Creates new concept in a code system.

Input:

  • java.lang.String codingSchemeURI - (Mandatory) URI of Code System that will contain this new concept.
  • java.lang.String codeSystemVersion - (Mandatory) Version of Code System that will contain this new concept.
  • java.lang.String conceptCode - (Mandatory) Code or identifier of the concept.
  • java.lang.String namespace - (Mandatory) namespace of the concept.
  • 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: call create concept method by passing code system version and concept information:
    Code Block
    csAuthOp.createConcept("NCIT", "10.0", "C12345", "NCIT", revInfo);

...

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

Description:

Adds a new property to 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 to which a new property will be added.
  • java.lang.String namespace - (Mandatory) Namespace of a concept to which a new property will be added.
  • org.LexGrid.commonTypes.Property property - (Mandatory) New property that will be added to the concept.
  • 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 property to be added:
    Code Block
    Property prop = new Property();
prop.setPropertyId("propertyId1");
prop.setPropertyName("propertyName");
prop.setIsActive(false);
prop.setLanguage("en");
prop.setOwner("owner");
prop.setPropertyType(PropertyTypes.PROPERTY.name());
Text text = new Text();
text.setContent("content");
text.setDataType("Text datatype");
prop.setValue(text);
  • Step 4: call add property method by passing the code system information, concept information and a new property:
    Code Block
    csAuthOp.addNewConceptProperty("urn:oid:11.11.0.99", "1.0", "C12345", "NCIT", prop, revInfo);

...

createAssociationType(String codingSchemeUri, String codeSystemVersion, String relationsContainerName, String associationName, String forwardName, String reverseName, Boolean isNavigable, Boolean isTransitive, RevisionInfo revision)

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:
    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 Block
    csAuthOp.createAssociationType("urn:oid:11.11.0.99", "1.0", "SCT-ICD9Mapping", "SameAs", "SameAs", "SameAs", true, true, revInfo);

...

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:

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 modified code system meta data:
    Code Block
    String codingSchemeURI = "urn:oid:11.11.0.99";
String representsVersion = "1.0";

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);

...

updateCodeSystemProperties(RevisionInfo revision, String codingSchemeName, String codingSchemeURI, String representsVersion, Properties properties)'

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(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(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();
  • 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(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);

...

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(RevisionInfo revision, String codingSchemeURI, String representsVersion, String propertyId)

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:
    Code Block
    CodingScheme codeScheme = csAuthOp.removeCodeSystemProperty(revInfo, "urn:oid:11.11.0.99", "1.0", "propertId1");

...

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:

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 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);

...

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

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 4: 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);

...

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 3: 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(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 3: 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);

...