 |
Page History
| Wiki Markup |
|---|
{scrollbar:icons=false}
h1. { |
| Page info |
|---|
...
|
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
LexEVS CTS2 Value Set Authoring API provides capability to author Value Set Definition, its Properties, Definition Entries (rule set) and its Versionable attributes.
Here are the authoring functions that can be performed on Value Set:
- Create - This function provides capability to create:
- New Value Set
- Add new Definition Entry (Rule Set) to Value Set
- Add new property to Value Set
- Edit - This function provides capability to update:
- Value Set meta-data
- Definition Entry of a Value Set
- Property of a Value Set
- Remove - This function provides capability to remove:
- Value Set
- Definition Entry of a Value Set
- Property of a Value Set
- Versionable Change - This function provides capability to modify versionable attributes of Usage Context like Status, Effective Date, Expiration Date, isActive and Owner:
- Value Set Status
- Value Set Versionable attributes
Interface
org.lexevs.cts2.author.ValueSetAuthoringOperation
...
is
...
the
...
main
...
interface
...
for
...
all
...
the
...
authoring
...
operations
...
against
...
Value
...
Set.
...
This
...
interface
...
can
...
be
...
accessed
...
using
...
main
...
LexEVSCTS2
...
interface,
...
like:
| Code Block |
|---|
} org.lexevs.cts2.author.ValueSetAuthoringOperation vsAuthOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAuthoringOperation().getValueSetAuthoringOperation(); {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 ValueSetAuthoringOperation interface.
Create Operations
Create Operation provides capability to create Value Set, Definition Entry and Properties. 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.
createValueSet
This function creates a new Value Set. The new Value Set is defined by the set of meta-data properties that describe it.
createValueSet(URI valueSetURI, String valueSetName, String defaultCodeSystem, String conceptDomainId, List<org.LexGrid.commonTypes.Source>
...
sourceList,
...
List<String>
...
usageContextList,
...
Properties
...
properties,
...
List<DefinitionEntry>
...
ruleSetList,
...
Versionable
...
versionable,
...
RevisionInfo
...
revision)
...
Description: |
|---|
...
Creates |
...
a |
...
new |
...
value |
...
set |
...
definition |
...
and |
...
loads |
...
into |
...
repository. |
...
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
java.net.URI |
...
- |
...
value |
...
set |
...
definition |
...
URI |
...
if |
...
created |
...
successfully | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
createValueSet using ValueSetDefinition object
This function is similar to above except this allows users to create Value Set by passing well defined value set definition object. The new Value Set is defined by the set of meta-data properties that describe it.
createValueSet(ValueSetDefinition valueSetDefininition, RevisionInfo revision)
Description: | Creates a new value set definition and loads into repository. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
java.net.URI |
...
- |
...
value |
...
set |
...
definition |
...
URI |
...
if |
...
created successfully | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
addDefinitionEntry
This function provides capability to add new Definition Entry (Rule Set) to Value Set Definition.
addDefinitionEntry(URI valueSetURI, DefinitionEntry newDefinitionEntry, RevisionInfo revision)
Description: | Add new definition entry (rule set) to a value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True if update was successful | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
addValueSetProperty
This function provides capability to add a new property to a Value Set.
addValueSetProperty(URI valueSetURI, Property newProperty, RevisionInfo revision)
Description: | Add new Property to existing value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
addition |
...
of |
...
new |
...
property |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Edit Operations
The edit operation provides the capability to modify Value Set meta-data,
...
it's
...
definition
...
entires
...
(rule
...
sets)
...
and
...
its
...
properties.
...
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.
...
updateValueSetMetaData
This function provides capability to modify existing meta-data
...
of
...
a
...
value
...
set
...
definition.
...
updateValueSetMetaData(URI
...
valueSetURI,
...
String
...
valueSetName,
...
String
...
defaultCodeSystem,
...
String
...
conceptDomainId,
...
List<org.LexGrid.commonTypes.Source>
...
sourceList,
...
List<String>
...
usageContext,
...
RevisionInfo
...
revision)
...
Description: |
|---|
...
Updates |
...
value |
...
set |
...
definition |
...
meta |
...
data. |
...
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| |
Output: | boolean - True; if update was success |
|---|---|
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
updateDefinitionEntry
This function provides capability to modify existing Definition Entry of a Value Set Definition.
updateDefinitionEntry(URI valueSetURI, DefinitionEntry changedDefinitionEntry, RevisionInfo revision)
Description: | Update existing definition entry (rule set) of a value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
update |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
updateValueSetProperty
This function provides capability to modify existing property of a Value Set Definition.
updateValueSetProperty(URI valueSetURI, Property changedProperty, RevisionInfo revision)
Description: | Updates existing property of a value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
update |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
Remove Operations
Remove operation provides capability to remove Value Set, its definition entry and its property.
removeValueSet
This function provides capability to remove a Value Set. This operation is permanent removal of value set definition.
removeValueSet(URI valueSetURI, RevisionInfo revision)
Description: | Removes value set definition from the system. This operation is permanent removal of value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
remove |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
removeDefinitionEntry
This function provides capability to remove Definition Entry (rule set) of a Value Set.
removeDefinitionEntry(URI valueSetURI, Long ruleOrder, RevisionInfo revision)
Description: | Removes definition entry (rule set) of a value set definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
remove |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
removeValueSetProperty
This function provides capability to remove property of a Value Set.
removeValueSetProperty(URI valueSetURI, String propertyId, RevisionInfo revision)'
Description: | Removes a property of a Value Set Definition. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
remove |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Versionable Change Operations
Versionable Change operation provides capability to modify versionable attributes of Value Set like Status, Effective Date, Expiration Date, isActive and Owner.
updateValueSetStatus
This function modifies the status of a Value Set.
updateValueSetStatus(URI valueSetURI, String status, RevisionInfo revision)
Description: | Modifies the status of a Value Set. |
|---|---|
Input: |
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Output: |
|---|
...
boolean - True; |
...
if |
...
update |
...
was |
...
success | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
updateValueSetVersionable
This function provides capability to modify Value Set versionable attributes like effective date, expiration date, owner, status etc.
updateValueSetVersionable(URI valueSetURI, Versionable changedVersionable, RevisionInfo revision)
Description: | Update Value Set 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: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Wiki Markup |
|---|
{code} |
\\
{scrollbar:icons=false} |
