Page History
...
Description: | Creates new association type. | ||||||
Input: |
| ||||||
Output: | None | ||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||
*Sample Call: * |
|
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: |
| ||||||||||||||||||||
Output: | * | *_ org.LexGrid.codingSchemes.CodingScheme _*- Modified Code System | ||||||||||||||||||||
Exception: | System |
| *Exception:* | *_ org.LexGrid.LexBIG.Exceptions.LBException | ||||||||||||||||||||
Sample Call: |
|
...
Description: | Updates properties of a code system. | |||||||
Input: |
| |||||||
Output: | org.LexGrid.codingSchemes.CodingScheme - Updated Code System | |||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||||
Sample Call: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
...
None | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
...
None | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
Code Block |
---|
* _Step 2:_ Populate RevisionInfo object:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
...
None | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
...
boolean - True means deletion was success, otherwise false. | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
removeCodeSystemProperty
This function provides capability to remove property of a Code System.
...
Description: | Removes a property of a Code System | |||||||
Input: |
| |||||||
Output: | org.LexGrid.codingSchemes.CodingScheme - Updated Code System | |||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||||
Sample Call: |
|
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: |
| ||||||||||||||
Output: | None | ||||||||||||||
Exception: | * | None |
| *Exception:* | *_ org.LexGrid.LexBIG.Exceptions.LBException | ||||||||||||||
Sample Call: |
|
...
Description: | Removes a property of a concept. |
Input: |
|
*Output: * | None |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: * |
|
...
*Output: * | None |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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: * |
|
...
*Output: * | None |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Scrollbar | ||
---|---|---|
|