NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be undergoing maintenance Monday, July 22nd between 1700 ET and 1800 ET and will be unavailable during this period.
Please ensure all work is saved before said time.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

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

...

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

...

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

...

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

...