 |
Page History
| Scrollbar | ||
|---|---|---|
|
...
| Page info |
|---|
...
|
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
LexEVS CTS2 Concept Domain Authoring API provides capability to author Concept Domain, maintain the binding between Concept Domain and the Value Sets and also the ability to create a Code System that can hold the Concept Domains.
Here are the authoring functions that can be performed on concept domain:
- 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
Interface
org.lexevs.cts2.author.ConceptDomainAuthoringOperation
...
is
...
the
...
main
...
interface
...
for
...
all
...
the
...
authoring
...
operations
...
against
...
Concept
...
Domain.
...
This
...
interface
...
can
...
be
...
accessed
...
using
...
main
...
LexEVSCTS2
...
interface,
...
like:
| Code Block |
|---|
} org.lexevs.cts2.author.ConceptDomainAuthoringOperation cdAuthOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAuthoringOperation().getConceptDomainAuthoringOperation(); {code} h2. Revision Information All the authoring functions described here requires information about the author and revision/version id to be assigned to entities for each of these operations. These is done passing object * |
Revision Information
All the authoring functions described here requires information about the author and revision/version id to be assigned to entities for each of these operations. These is done passing object org.lexevs.cts2.core.update.RevisionInfo
...
.
...
RevisionInfo
...
object
...
has
...
following
...
attributes:
...
- java.lang.String
...
- changeAgent
...
- -
...
- (Optional)
...
- The
...
- source
...
- that
...
- participated
...
- in
...
- this
...
- particular
...
- change.
...
- java.lang.String
...
- changeInstruction
...
- -
...
- (Optional)
...
- A
...
- human
...
- or
...
- machine
...
- readable
...
- set
...
- of
...
- instructions
...
- on
...
- how
...
- to
...
- apply
...
- this
...
- change.
...
- java.lang.String
...
- revisionId
...
- -
...
- (
...
- Mandatory
...
- )
...
- The
...
- unique
...
- identifier
...
- of
...
- this
...
- revision.
...
- java.lang.Long
...
- editOrder
...
- -
...
- (Optional)
...
- The
...
- relative
...
- order
...
- that
...
- this
...
- revision
...
- is
...
- to
...
- be
...
- applied
...
- if
...
- in
...
- a
...
- systemRelease.
...
- java.util.Date
...
- revisionDate
...
- -
...
- (Optional)
...
- The
...
- end
...
- date
...
- for
...
- which
...
- this
...
- version
...
- is
...
- operative
...
- (considered
...
- commited).
...
- java.lang.String
...
- description
...
- -
...
- (Optional)
...
- The
...
- description
...
- of
...
- the
...
- resource/change.
...
- java.lang.String
...
- systemReleaseURI
...
- -
...
- (Optional)
...
- The
...
- official
...
- URI
...
- of
...
- this
...
- release
...
Authoring
...
Functions
...
Following
...
sections
...
contains
...
detailed
...
functions
...
provided
...
by
...
ConceptDomainAuthoringOperation
...
interface.
...
Create
...
Operations
...
Create
...
Operation
...
provides
...
capability
...
to
...
create
...
a
...
Code
...
System
...
to
...
hold
...
Concept
...
Domains,
...
Concept
...
Domain,
...
Property
...
and
...
binding
...
between
...
Concept
...
Domain
...
and
...
Value
...
Sets.
...
For
...
every
...
entry
...
that
...
gets
...
created,
...
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.
...
createConceptDomainCodeSystem
This function provides capability to create a new Code System to contain a set of Concept Domains. The Code System is created by defining the set of meta-data properties that describe it. At this point there is no concept domain added.
createConceptDomainCodeSystem(RevisionInfo revision, String codeSystemName, String codeSystemURI, String formalName, String defaultLanguage, long approxNumConcepts, String representsVersion, List<String> localNameList, List<org.LexGrid.commonTypes.Source>
...
sourceList,
...
Text
...
copyright,
...
Mappings
...
mappings)
...
Description: |
|---|
...
Creates |
...
new |
...
code |
...
system |
...
to |
...
hold |
...
concept |
...
domains. |
...
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: | org.LexGrid.codingSchemes.CodingScheme |
|---|
...
- |
...
Created |
...
Concept |
...
Domain |
...
Code |
...
System | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
createConceptDomain
This function creates a concept domain to be included in a Code System. The new concept domain is defined by the set of meta-data properties that describe it.
createConceptDomain(String conceptDomainId, String conceptDomainName, String namespace, RevisionInfo revisionInfo, String description, String status, boolean isActive, Properties properties, String codeSystemNameOrURI, String codeSystemVersion)
Description: | Creates new concept domain in a code system. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
java.lang.String |
...
- |
...
concept |
...
domain |
...
id |
...
if |
...
created |
...
successfully | |
Exception: | org.LexGrid.LexBIG. |
|---|
...
Exceptions.LBException | |||
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
addConceptDomainProperty
This function provides capability to add a new property to a concept domain.
addConceptDomainProperty(String conceptDomainId, String namespace, Property newProperty, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
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
This function provides capability to create a value set to concept domain binding.
addConceptDomainToValueSetBinding(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion, URI valueSetURI, RevisionInfo revisionInfo)
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.
...
updateConceptDomainProperty
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.
removeConceptDomain
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.
removeConceptDomainProperty(String conceptDomainId, String namespace, Property property, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
Description: | Removes a property of a concept domain. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
remove |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
removeConceptDomainToValueSetBinding
This function provides capability to remove value set to concept domain binding.
removeConceptDomainToValueSetBinding(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion, URI valueSetURI, RevisionInfo revisionInfo)
Description: | Removes value set to concept domain binding. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
binding |
...
remove |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
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.
updateConceptDomainStatus(String conceptDomainId, String namespace, String newStatus, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
Description: | Modifies the status of a concept domain. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
update |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
activateConceptDomain
This function activates concept domain so that it can be accessed in the terminology service.
activateConceptDomain(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
Description: | Activates concept domain. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
activation |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
deactivateConceptDomain
This function deactivates concept domain so that it can no longer be accessed in the terminology service.
deactivateConceptDomain(String conceptDomainId, String namespace, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
Description: | Deactivates concept domain. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
deactivation |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
updateConceptDomainVersionable
This function provides capability to modify concept domain versionable attributes like effective date, expiration date, owner, status etc.
updateConceptDomainVersionable(String conceptDomainId, String namespace, Versionable changedVersionable, String codeSystemNameOrURI, String codeSystemVersion, RevisionInfo revisionInfo)
Description: | Update concept domain versionable attributes like effective date, expiration date, owner, status etc. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
update |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| Scrollbar | ||
|---|---|---|
|
