 |
Page History
...
- Create - This function provides capability to create:
- New Code System to hold concept domains
- New Concept Domain
- Add new property to Concept Domain
- Concept Domain to Value Set binding
- Edit - This function provides capability to update:
- Property of a Concept Domain
- Remove - This function provides capability to remove:
- Concept Domain
- Property of a Concept Domain
- Concept Domain to Value Set binding
- Versionable Change - This function provides capability to modify versionable attributes of Concept Domain like Status, Effective Date, Expiration Date, isActive and Owner:
- Concept Domain Status
- Activate Concept Domain
- De-Activate Concept Domain
...
Description: | Add new property for a concept domain. | ||||||||
Input: |
| ||||||||
Output: | boolean - True; if addition of new property was success | ||||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||||
Sample Call: |
|
addConceptDomainToValueSetBinding
...
*Description: * | Create a value set to concept domain binding. |
*Input: * |
|
...
*Output: * | boolean - True; if binding was success |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Edit Operations
The edit operation provides the capability to modify properties of a concept domain. 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.
...
This function provides capability to modify existing property of a concept domain.
updateConceptDomainProperty(String conceptDomainId, String namespace, Property changedProperty, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
*Description: * | Modifies existing property of a concept domain. |
*Input: * |
|
...
*Output: * | boolean - True; if update was success |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Remove Operations
Remove operation provides capability to remove concept domain, its property and its binding to value set.
...
This function provides capability to remove a concept domain.
removeConceptDomain(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
*Description: * | Removes a concept domain from code system. |
*Input: * |
|
...
*Output: * | boolean - True; if remove was success |
...
*Exception: * | org.LexGrid.LexBIG.Exceptions.LBException |
...
*Sample Call: * |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
removeConceptDomainProperty
This function provides capability to remove property of a concept domain.
*Description: * | Removes a property of a concept domain. |
*Input: * | |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
removeConceptDomainToValueSetBinding
This function provides capability to remove value set to concept domain binding.
*Description: * | Removes value set to concept domain binding. |
*Input: * | |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Versionable Change Operations
Versionable Change operation provides capability to modify versionable attributes of Concept Domain like Status, Effective Date, Expiration Date, isActive and Owner.
updateConceptDomainStatus
This function modifies the status of a concept domain.
...
*Description: *
...
Modifies the status of a concept domain.
...
*Input: *
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
activateConceptDomain
This function activates concept domain so that it can be accessed in the terminology service.
*Description: * | Activates concept domain. |
*Input: * | |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
deactivateConceptDomain
This function deactivates concept domain so that it can no longer be accessed in the terminology service.
*Description: * | Deactivates concept domain. |
*Input: * | |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
updateConceptDomainVersionable
This function provides capability to modify concept domain versionable attributes like effective date, expiration date, owner, status etc.
...
*Description: *
...
Update concept domain versionable attributes like effective date, expiration date, owner, status etc.
...
*Input: *
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Scrollbar | ||
|---|---|---|
|
