 |
Page History
| Wiki Markup |
|---|
{scrollbar:icons=false}
h1. { |
| Page info | ||||
|---|---|---|---|---|
|
| Section | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
LexEVS CTS2 Code System Authoring API provides capability to author Code System and its contents.
Here are the authoring functions that can be performed on Associations in a Code System:
Create
This function provides capability to create:
- New Association
- Add Qualifiers to the Association
- Determine Source and Target Code Systems for the Association
- New Coding Scheme consisting of mappings of one system's concepts to another.
- New Mapping for an existing mapping scheme
- New Association for an existing coding scheme.
Status Change
This function provides capability to update Status attributes:
- Association Status
Interface
| Code Block |
|---|
:title} {section} {column:width=75%} {panel:title=Contents of this Page} {toc:minLevel=2} {panel} {column} {column} {align:right}{include:Menu LexEVS 6.0 CTS2 to Include}{align} {column} {section} h2. Introduction LexEVS CTS2 Code System Authoring API provides capability to author Code System and its contents. Here are the authoring functions that can be performed on Associations in a Code System: h3. Create This function provides capability to create: * New Association * Add Qualifiers to the Association * Determine Source and Target Code Systems for the Association * New Coding Scheme consisting of mappings of one system's concepts to another. * New Mapping for an existing mapping scheme * New Association for an existing coding scheme. h3. Status Change This function provides capability to update Status attributes: * Association Status h2. Interface {code}org.lexevs.cts2.LexEvsCTS2 cts2 = org.lexevs.cts2.LexEvsCTS2Impl.defaultInstance(); org.lexevs.cts2.author.AssociationAuthoringOperation associationAuthoring = cts2.getAuthoringOperation().getAssociationAuthoringOperation();{code} h2. Revision Information Authoring requires information helping to determine whether the edited coding scheme element is new or revises an existing association. This requires not only a containing revision, but also a entry state object for each versionable element of the Association being created. A single object of each is passed into the association creating method providing mandatory information about this revision which in most use cases here is a new association. h3. |
Revision Information
Authoring requires information helping to determine whether the edited coding scheme element is new or revises an existing association. This requires not only a containing revision, but also a entry state object for each versionable element of the Association being created. A single object of each is passed into the association creating method providing mandatory information about this revision which in most use cases here is a new association.
org.LexGrid.versions.Revision
...
Revision
...
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
...
org.LexGrid.versions.EntryState
...
- java.lang.String
...
- containingRevision
...
- -
...
- (
...
- Mandatory
...
- )The
...
- revision
...
- that
...
- contains
...
- this
...
- particular
...
- entry
...
- state
...
- change
...
private
...
- java.lang.Long
...
- relativeOrder
...
- -
...
- (Optional)The
...
- relative
...
- order
...
- that
...
- this
...
- state
...
- change
...
- should
...
- be
...
- applied
...
- within
...
- the
...
- context
...
- of
...
- the
...
- containing
...
- revision
...
- private
...
- org.LexGrid.versions.types.ChangeType
...
- changeType
...
- -
...
- (Context
...
- determined.
...
- NEW
...
- for
...
- new
...
- association)The
...
- type
...
- of
...
- change
...
- that
...
- occurred
...
- between
...
- this
...
- state
...
- and
...
- the
...
- previous.
...
- private
...
- java.lang.String
...
- prevRevision
...
- -
...
- (Optional)The
...
- unique
...
- identifier
...
- of
...
- the
...
- state
...
- of
...
- this
...
- entry
...
- was
...
- at
...
- prior
...
- to
...
- this
...
- change.
...
Association
...
Authoring
...
Functions
...
Create
...
Association
...
Operations
...
createAssociation(boolean
...
createMappingScheme,
...
Revision
...
revision,
...
EntryState
...
entryState,
...
AbsoluteCodingSchemeVersionReference
...
mappingScheme,
...
AbsoluteCodingSchemeVersionReference
...
sourceCodeSystemIdentifier,
...
AbsoluteCodingSchemeVersionReference
...
targetCodeSystemIdentifier,
...
String
...
sourceConceptCodeIdentifier,
...
String
...
targetConceptCodeIdentifier,
...
String
...
relationsContainerName,
...
String
...
associationType,
...
AssociationQualification[]
...
associationQualifiers)
...
Description: |
|---|
...
Creates |
...
new |
...
Association | |
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| |
Output: | org.LexGrid.relations.AssociationSource |
|---|
...
- |
...
Created |
...
Association |
...
Structure | |
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
|---|
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Update Association Operations
updateAssociationStatus(Revision
...
revision,
...
EntryState
...
entryState,
...
AbsoluteCodingSchemeVersionReference
...
scheme,
...
String
...
relationsContainer,
...
String
...
associationName,
...
String
...
sourceCode,
...
String
...
sourceNamespace,
...
String
...
targetCode,
...
String
...
targetNamespace,
...
String
...
instanceId,
...
String
...
status,
...
boolean
...
isActive)
...
Description: |
|---|
...
Updates |
...
Association |
...
Status | |
Input: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| |
Output: | boolean - flag for successful update |
|---|---|
Exception: | org.LexGrid.LexBIG.Exceptions.LBException |
...
Sample Call: |
|
|---|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
| Wiki Markup |
|---|
_ |
{scrollbar:icons=false} |
